-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add populate and assemble operation docs
- Loading branch information
Showing
3 changed files
with
96 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# $assemble | ||
|
||
## Useful links | ||
|
||
**Deployed service: https://smartforms.csiro.au/api/fhir/Questionnaire/$assemble** | ||
|
||
FHIR Operation definition: http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-assemble | ||
|
||
Github: https://github.com/aehrc/smart-forms/tree/main/services/assemble-express | ||
|
||
Dockerhub: https://hub.docker.com/r/aehrc/smart-forms-assemble | ||
|
||
## Usage | ||
|
||
A Questionnaire resource can be assembled using a **POST** request to a URL such as: | ||
|
||
```http request | ||
https://smartforms.csiro.au/api/fhir/Questionnaire/$assemble (type-level) | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Name | Cardinality | Type | Documentation | | ||
| ------------- | ----------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | ||
| questionnaire | 1..1 | Questionnaire | The [Modular Questionnaire](https://hl7.org/fhir/uv/sdc/StructureDefinition-sdc-questionnaire-modular.html) to assemble the content of. | | ||
|
||
#### Try it out | ||
|
||
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman"/>](https://elements.getpostman.com/redirect?entityId=22885901-2af2cfbb-3a0a-49c6-8404-105ef0751415&entityType=collection) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# $populate | ||
|
||
## Useful links | ||
|
||
**Deployed service: https://smartforms.csiro.au/api/fhir/Questionnaire/$populate** | ||
|
||
FHIR Operation definition: http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate | ||
|
||
Github: https://github.com/aehrc/smart-forms/tree/main/services/populate-express | ||
|
||
Dockerhub: https://hub.docker.com/r/aehrc/smart-forms-populate | ||
|
||
## Usage | ||
|
||
A Questionnaire resource can be populated using a **POST** request to a URL such as: | ||
|
||
```http request | ||
https://smartforms.csiro.au/api/fhir/Questionnaire/$populate (type-level) | ||
``` | ||
|
||
#### Parameters | ||
|
||
| Name | Cardinality | Type | Documentation | | ||
| --------------- | ----------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| questionnaire | 1..1 | Questionnaire | The Questionnaire is provided directly as part of the request. | | ||
| subject | 1..1 | Reference | The resource that is to be the QuestionnaireResponse.subject. The QuestionnaireResponse instance will reference the provided subject. | | ||
| context | 0..\* | | Resources containing information to be used to help populate the QuestionnaireResponse. These will typically be FHIR resources. | | ||
| context.name | 0..\* | string | The name of the launchContext or root Questionnaire variable the passed content should be used as for population purposes. The name SHALL correspond to a launchContext or variable declared at the root of the Questionnaire. | | ||
| context.content | 0..\* | Resource | The actual resource (or resources) to use as the value of the launchContext or variable. | | ||
|
||
https://smartforms.csiro.au/api/fhir only stores Questionnaire definitions and does not contain any clinical data. Therefore when using this sample implementation, contextual information for pre-population should be provided as actual FHIR resources, not references. | ||
|
||
#### Debugging | ||
|
||
You can add the `debug=true` query parameter to return an additional `contextResult-custom` output parameter in the response. | ||
|
||
```http request | ||
https://smartforms.csiro.au/api/fhir/Questionnaire/$populate?debug=true | ||
``` | ||
|
||
#### Try it out | ||
|
||
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman"/>](https://elements.getpostman.com/redirect?entityId=22885901-2af2cfbb-3a0a-49c6-8404-105ef0751415&entityType=collection) |