FHIR SDC API
This article outlines operations from the FHIR SDC Implementation Guide.
Implementation corresponds to SDC FHIR IG - 3.0.version 0
FHIR SDC API
Aidbox Forms module supports FHIR SDC operations:
$populatelink - filling out a form with existing data, and return signed link to it (FHIR)
We have created an Aidbox notebook demonstrating different population and extraction methods:
Populate Questionnaire - $populate
The populate operation generates a QuestionnaireResponse based on a specific Questionnaire, filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire.
This implementation supports the Observation based and Expression based population methods.
URLs
POST [base]/fhir/Questionnaire/$populate
POST [base]/fhir/Questionnaire/[id]/$populate
Parameters
Parameters are specified via FHIR Parameters type.
Example
resourceType: Parameters
parameter:
- name: subject
valueReference:
reference: Patient/pt-1
identifier
A logical questionnaire identifier (i.e. Questionnaire.identifier). The server must know the questionnaire or be able to retrieve it from other known repositories.
name: identifier
valueIdentifier:
system: 'forms.aidbox'
value: 'vitals'
canonical
The canonical identifier for the questionnaire (optionally version-specific).
name: canonical
valueCanonical: http://forms.aidbox.io/Questionnaire/vitals
questionnaire
The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion
name: questionnaire
resource:
resourceType: Questionnaire
id: new-form
title: "Vitals"
...
questionnaireRef
The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire.
name: questionnaireRef
valueReference:
resourceType: Questionnaire
id: new-form
subject
The resource that is to be the QuestionnaireResponse.subject. The QuestionnaireResponse instance will reference the provided subject. In addition, if the local parameter is set to true, server information about the specified subject will be used to populate the instance.
name: subject
valueReference:
reference: Patient/pt-1
local
If specified and set to true (and the server is capable), the server should use what resources and other knowledge it has about the referenced subject when pre-populating answers to questions.
name: local
valueBoolean: true
context
Resources containing information to be used to help populate the QuestionnaireResponse. These will typically be FHIR resources.
Context paramertes are presented as pairs of name
and content
parameters that are placed under the part
key.
They should correspond launchContext parameter definitions.
name: context
part:
- name: name
valueString: encounter
- name: content
valueReference:
reference: Encounter/enc1
FHIR SDC launchContext extension enumerates possible context variables, they are:
user
User in context at launch time
Additionnaly Aidbox expands this list with parameters that mirrors QuestionnaireResponse root properties.
WARN: This is non FHIR SDC compliant behavior!
Paramerters passed directly to QuestionnaireResponse root properties and should not be used in populate expressions.
identifier
encounter
Example:
name: name
valueReference:
reference: ServiceRequest/sr1
context.name
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 delared at the root of the Questionnaire.
name: name
valueString: encounter
context.content
The actual resource (or resources) to use as the value of the launchContext or variable.
name: content
valueReference:
reference: Encounter/enc1
Or
name: content
resource:
...
resourceType: Encounter
id: enc1
subject:
reference: Patient/pt-1
...
launchContext
Resources that provide context for form processing logic (pre-population) when creating/displaying/editing a QuestionnaireResponse.
Response
in failure case - response is specified as OperationOutcome object.
in success case - response is specified as Parameters object.
Success response shape
response
1..1
The partially (or fully)-populated set of answers for the specified Questionnaire
issues
0..1
A list of hints and warnings about problems encountered while populating the questionnaire.
Usage Example
POST [base]/fhir/Questionnaire/vitals/$populate
content-type: text/yaml
resourceType: Parameters
parameter:
- name: subject
valueReference:
reference: Patient/pt-1
- name: context
part:
- name: name
valueString: encounter
- name: content
valueReference:
reference: Encounter/enc1
Populate Questionnaire and generate a link - $populatelink
The populatelink operation generates a link to a web page to be used to answer a specified Questionnaire. The form at the specified location will be pre-filled with answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire.
URLs
POST [base]/fhir/Questionnaire/$populatelink
POST [base]/fhir/Questionnaire/[id]/$populatelink
Parameters
The base set of parameters is the same as for $populate. On top of that, a few extra parameters are supported by Aidbox Forms.
WARN: The following parameters are not FHIR SDC compliant. This is an extension of the specification.
NOTE: Don't forget to wrap parameters in Parameters object
resourceType: Parameters
parameter:
- name: [var-name]
valueX: [varType: var-value]
allow-amend
Whether the generated link will allow amending and re-submitting the form.
name: allow-amend
valueBoolean: true
allow-repopulate
Whether the generated link will allow re-populating the form.
NOTE: Repopulate will be working only with forms that contain populate behavior
name: allow-repopulate
valueBoolean: true
redirect-on-submit
A URL where the user will be redirected to after successfully submitting the form.
name: redirect-on-submit
valueString: https://example.com/submit-hook?questionnaire=123
redirect-on-save
A URL where the user will be redirected to after hitting Save button.
By default
Save button is not visible
- form autosaved after every keystroke. But sometimes it's usefull to close form in a partially-filled state
name: redirect-on-save
valueString: https://example.com/submit-hook?questionnaire=123
link expiration time
Link expiration period (days)
name: expiration
valueInteger: 30
By default thir parameter = 7 days
theme
Form theme. QuestionnaireTheme resource id.
name: theme
valueString: hs-theme
config
Form config. SDCConfig resource id.
name: theme
valueString: default-config
read-only
Open form in read-only mode.
name: read-only
valueBoolean: true
app-name
Application name that will be used in Audit logging when returned link was used.
Audit logging should be enabled.
name: app-name
valueString: my-app
Response
in failure case - response is specified as OperationOutcome object containing a link.
in success case - response is specified as Parameters object containing a list of issues.
link
1..1
The URL for the web form that supports capturing the information defined by questionnaire
issues
0..1
A list of hints and warnings about problems encountered while populating the questionnaire
Usage Example
POST [base]/fhir/Questionnaire/vitals/$populatelink
content-type: text/yaml
resourceType: Parameters
parameter:
- name: subject
valueReference:
reference: Patient/pt-1
- name: context
part:
- name: name
valueString: encounter
- name: content
resource:
resourceType: Encounter
id: enc-1
subject:
reference: Patient/pt-1
Questionnaire response extract to resources - $extract
The extract operation takes a completed QuestionnaireResponse
and extracts it's data to Bundle
of resources by using metadata embedded in the Questionnaire
the QuestionnaireResponse
is based on. The extracted resources might include Observations
, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.
Aidbox supports only the Observation based and Definition based extraction methods.
URLs
URL: [base]/fhir/QuestionnaireResponse/$extract
URL: [base]/fhir/QuestionnaireResponse/[id]/$extract
Parameters
Parameters are specified via FHIR Parameters type.
Example
resourceType: Parameters
parameter:
- name: questionnaire-response
resource:
id: qr-1
resourceType: QuestionnaireResponse
...
Response
in failure case - response is specified as OperationOutcome object.
in success case - response is specified as Parameters object.
issues
0..1
A list of hints and warnings about problems encountered while extracting the data
Usage Example
POST [base]/fhir/QuestionnaireResponse/$extract
content-type: text/yaml
resourceType: Parameters
parameter:
- name: questionnaire-response
resource:
id: pt-1
resourceType: QuestionnaireResponse
questionnaire: https://forms.aidbox.io/vitals
item:
- linkId: temperature
valueDecimal: 36.6
...
ValueSet Expansion - $expand
Value Sets are used to define possible coded answer choices in a questionnaire.
The use of standardized codes is useful when data needs to be populated into the questionnaire or extracted from the questionnaire for other uses.
The expand
operation expand given ValueSet in to set of concepts.
This operation is described in detail here.
Last updated
Was this helpful?