FHIR SDC API

FHIR SDC API

Aidbox Forms module supports FHIR SDC operations:

• $populatefilling out a form with existing data (FHIR)
• $populatelinkfilling out a form with existing data, and return signed link to it (FHIR)
• $extractextract data from QuestionnaireResponse to other FHIR resources (FHIR)
• $expandcreate a simple collection of codes suitable for use for data entry or validation. (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.

URLs

POST [base]/Questionnaire/$populate

POST [base]/Questionnaire/[id]/$populate

Parameters

Example

resourceType: Parameters
parameter:
- name: subject
  value:
    Reference:
      id: pt-1
      resourceType: Patient

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
value:
  Identifier:
    system: 'forms.aidbox'
    value: 'vitals'

canonical

The canonical identifier for the questionnaire (optionally version-specific).

name: canonical
value:
  Canonical: 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
value:
  Reference:
    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
value:
  Reference:
    id: pt-1
    resourceType: Patient

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
value:
  Boolean: 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
  value:
    String: encounter
- name: content
  value:
    Reference:
      resourceType: Encounter
      id: enc1

FHIR SDC launchContext extension enumerates possible context variables, they are:

Additionnaly Aidbox expands this list with parameters that mirrors QuestionnaireResponse root properties.

Example:

name: name
value:
  Reference:
    id: sr1
    resourceType: ServiceRequest

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
value:
  String: encounter

context.content

The actual resource (or resources) to use as the value of the launchContext or variable.

name: content
value:
  Reference:
    resourceType: Encounter
    id: enc1

Or

name: content
resource:
  ...
  resourceType: Encounter
  id: enc1
  subject:
    id: pt-1
    resourceType: Patient
  ...

launchContext

Resources that provide context for form processing logic (pre-population) when creating/displaying/editing a QuestionnaireResponse.

Response

• in failure caseresponse is specified as OperationOutcome object.
• in success caseresponse is specified as Parameters object.

Success response shape

Usage Example

POST [base]/Questionnaire/vitals/$populate
content-type: text/yaml

resourceType: Parameters
parameter:
- name: subject
  value:
    Reference:
      id: pt-1
      resourceType: Patient
- name: context
  part:
  - name: name
    value:
      String: encounter
  - name: content
    value:
      Reference:
        resourceType: Encounter
        id: enc1

resourceType: Parameters
parameter:
- name: response
  resource:
    resourceType: QuestionnaireResponse
    questionnaire: http://aidbox.app/forms/new-form
    status: in-progress
    basedOn:
    - id: sr1
      resourceType: ServiceRequest
    encounter:
      id: enc1
      resourceType: Encounter
    item:
    - linkId: name
      text: Name
    - linkId: weight

resourceType: OperationOutcome
text:
  status: generated
  div: Parameters are invalid
issue:
- severity: error
  code: invalid
  expression:
  - parameter.0.resource
  diagnostics: unknown key :resource

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]/Questionnaire/$populatelink

POST [base]/Questionnaire/[id]/$populatelink

Parameters

The base set of parameters is the same as for FHIR SDC API. On top of that, a few extra parameters are supported by Aidbox Forms.

resourceType: Parameters
parameter:
- name:  [var-name]
  value: [varType: var-value]

allow-amend

Whether the generated link will allow amending and re-submitting the form.

name: allow-amend
value:
  Boolean: 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
value:
  Boolean: true

redirect-on-submit

A URL where the user will be redirected to after successfully submitting the form.

name: redirect-on-submit
value:
  String: https://example.com/submit-hook?questionnaire=123

redirect-on-save

A URL where the user will be redirected to after hitting Save button.

name: redirect-on-save
value:
  String: https://example.com/submit-hook?questionnaire=123

link expiration time

Link expiration period (days)

name: expiration
value:
  Integer: 30

theme

Form theme. QuestionnaireTheme resource id.

name: theme
value:
  String: hs-theme

config

Form config. SDCConfig resource id.

name: theme
value:
  String: default-config

read-only

Open form in read-only mode.

name: read-only
value:
  Boolean: true

app-name

Application name that will be used in Audit logging when returned link was used.

- name: app-name
  value
    String: my-app

Response

• in failure caseresponse is specified as OperationOutcome object containing a link.
• in success caseresponse is specified as Parameters object containing a list of issues.

Usage Example

POST [base]/Questionnaire/vitals/$populatelink
content-type: text/yaml

resourceType: Parameters
parameter:
- name: subject
  value:
    Reference:
      id: pt-1
      resourceType: Patient
- name: context
  part:
  - name: name
    value:
      String: encounter
  - name: content
    resource:
      resourceType: Encounter
      id: enc-1
      subject:
        id: pt-1
        resourceType: Patient

resourceType: Parameters
parameter:
- name: link
  value:
    Uri: http://forms.aidbox.io/ui/sdc#/questionnaire-response/12c1178c-70a9-4e02-a53d-65b13373926e?token=eyJhbGciOiJIUzI

resourceType: OperationOutcome
text:
  status: generated
  div: Parameters are invalid
issue:
- severity: error
  code: invalid
  expression:
  - parameter.0.resource
  diagnostics: unknown key :resource

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]/QuestionnaireResponse/$extract

URL: [base]/QuestionnaireResponse/[id]/$extract

Parameters

Example

resourceType: Parameters
parameter:
- name: questionnaire-response
  resource:
    id: qr-1
    resourceType: QuestionnaireResponse
    ...

Response

• in failure caseresponse is specified as OperationOutcome object.
• in success caseresponse is specified as Parameters object.

Usage Example

POST [base]/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
        value:
          Decimal: 36.6
    ...

return:
  resourceType: Bundle
  type: transaction
  entry:
  - resource:
      resourceType: Observation
      status: final
      code:
        coding:
        - code: body-temperature
          system: loinc
      subject:
        id: pt-1
        resourceType: Patient
      value:
        Quantity:
          unit: [c]
          value: 36.6
    request: {method: POST,  url: /Observation}

resourceType: OperationOutcome
text:
  status: generated
  div: Parameters are invalid
issue:
- severity: error
  code: invalid
  expression:
  - parameter.0.resource.given
  diagnostics: unknown key :given

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 ValueSet Expansion.