Structured Data Capture
3.0.0 - STU 3 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Example Parameters: Example $assemble operation response

Parameters

return

Questionnaire/null

Generated Narrative: Questionnaire

Assembled From Questionnaire: Example sub-module Questionnaire for contact

Assembled From Questionnaire: Example sub-module Questionnaire for name

Launch Contexts

url

name

value: Patient (Details: http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext code patient = 'Patient', stated as 'null')

url

type

value: Patient

Variable: %patient(person)

url: http://hl7.org/fhir/uv/sdc/Questionnaire/sdc-modular-root

name: QuestionnaireSDCModularRoot

title: Example modular Questionnaire

status: draft

experimental: true

item

Variable: 'patientname.'(linkIdPrefix)

constraint

url

key

value: qcontact-1

url

severity

value: error

url

human

value: Must have either first or last name

url

expression

value: item.where(linkId=%linkIdPrefix+'1').exists() or item.where(linkId=%linkIdPrefix+'2').exists()

Variable: iif(%person.name.where(use='official').exists(),%person.name.where(use='official')[0],%person.name[0])(name)

linkId: 1

definition: SDC Question Library

text: What is the person's official name?

type: group

item

Initial Expression: %name.prefix.where($this in ('Mr.'|'Miss'|'Mrs'|'Ms.'))[0]

linkId: patientname.1

text: Title

type: string

required: true

answerOption

answerOption

answerOption

answerOption

item

Initial Expression: %name.given[0]

linkId: patientname.2

definition: SDC Question Library

text: First

type: string

required: true

maxLength: 100

item

Initial Expression: %name.last

linkId: patientname.3

definition: SDC Question Library

text: Last

type: string

required: true

maxLength: 100

item

minValue: 1900-01-01

maxValue: Value calculated by: now() as date + 1 day

linkId: 2

definition: SDC Question Library

text: What is this person's date of birth?

type: date

required: true

item

linkId: 3

definition: SDC Question Library

text: What is this person's gender?

type: choice

required: true

answerValueSet: AdministrativeGender

item

linkId: 4

definition: SDC Question Library

text: What is this person's current mailing address?

type: group

required: true

Items

-ExtensionLinkIdDefinitionTextTypeRequiredAnswerValueSet
* 4.1 display
* 4Demographics.address.streetSDC Question LibraryStreet addressstring
* 4Demographics.address.citySDC Question LibraryCity/Townstring
* 4Demographics.address.stateSDC Question LibraryStatechoice Australian States - example value set
*, 4Demographics.address.postalCodeSDC Question LibraryPostal Codestringtrue

item

Item population context: %patient.contact(person)

Variable: 'patientcontact.'(linkIdPrefix)

linkId: 5

type: group

required: true

item

Variable: %linkIdPrefix + 'name.'(linkIdPrefix)

constraint

url

key

value: qcontact-1

url

severity

value: error

url

human

value: Must have either first or last name

url

expression

value: item.where(linkId=%linkIdPrefix+'1').exists() or item.where(linkId=%linkIdPrefix+'2').exists()

Variable: iif(%person.name.where(use='official').exists(),%person.name.where(use='official')[0],%person.name[0])(name)

linkId: patientcontact.1

definition: SDC Question Library

text: What is the person's official name?

type: group

item

item

item

item

Initial Expression: %person.telecom.where(use='phone').first()

linkId: patientcontact.2

definition: http://example.org/StructureDefinition/non-existent-library#Stuff.phone

text: Phone number

type: string

required: true

outcome

OperationOutcome/null

Generated Narrative: OperationOutcome

issue

severity: warning

code: informational

details: Unable to resolve element definition http://example.org/StructureDefinition/non-existent-library#Stuff.phone when assembling Questionnaire/sdc-modular-contact. Some constraints and behavior may not be represented ()

expression: Questionnaire.item[1].definition

issue

severity: warning

code: informational

details: Unable to resolve element definition http://example.org/StructureDefinition/non-existent-library#Stuff.phone when assembling Questionnaire/sdc-modular-contact. Some constraints and behavior may not be represented ()

expression: Questionnaire.item[1].definition