Structured Data Capture
2.8.0 - CI Build

Structured Data Capture, published by HL7 International - FHIR Infrastructure Work Group. This is not an authorized publication; it is the continuous build for version 2.8.0). This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: Adaptive Questionnaire Response

Defining URL:http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt
Version:2.8.0
Name:QuestionnaireResponseAdapt
Title:Adaptive Questionnaire Response
Status:Draft as of 2021-10-26T00:03:21+00:00
Definition:

Defines how the questionnaire response resource is used to reflect form data within the ONC's Structured Data Capture standard.

Publisher:HL7 International - FHIR Infrastructure Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt

Scope and Usage

This profile sets expectations for use of the QuestionnaireResponse resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.

Boundaries and Relationships

This profile is related to the Adaptive Questionnaire Profile which defines the characteristic of an adaptive form "design". This profile focuses on the constraints appropriate to capturing the "answer(s)" to an adaptive form.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseAdaptive Questionnaire Response
... contained S1..*ResourceContained, inline Resources
... questionnaire S1..1canonical(Adaptive Questionnaire)Form being answered
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... authored S1..1dateTimeDate the answers were gathered
... author S0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... item S0..*BackboneElementGroups and questions
.... linkId S1..1stringPointer to specific item from Questionnaire
.... answer S0..*BackboneElementThe response(s) to the question
..... value[x] S0..1Single-valued answer to the question
...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueStringstring
...... valueCodingCoding
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseAdaptive Questionnaire Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S1..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(Adaptive Questionnaire)Form being answered
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text 0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueStringstring
...... valueCodingCoding
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseAdaptive Questionnaire Response
... contained 1..*ResourceContained, inline Resources
... questionnaire Σ1..1canonical(Adaptive Questionnaire)Form being answered
... status ?!Σ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... authored Σ1..1dateTimeDate the answers were gathered
... author Σ0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... item I0..*BackboneElementGroups and questions
.... linkId 1..1stringPointer to specific item from Questionnaire
.... answer 0..*BackboneElementThe response(s) to the question
..... value[x] 0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueStringstring
...... valueCodingCoding
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item 0..*See item (QuestionnaireResponse)Nested groups and questions
.... item 0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseAdaptive Questionnaire Response
... contained S1..*ResourceContained, inline Resources
... questionnaire S1..1canonical(Adaptive Questionnaire)Form being answered
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... authored S1..1dateTimeDate the answers were gathered
... author S0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... item S0..*BackboneElementGroups and questions
.... linkId S1..1stringPointer to specific item from Questionnaire
.... answer S0..*BackboneElementThe response(s) to the question
..... value[x] S0..1Single-valued answer to the question
...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueStringstring
...... valueCodingCoding
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseAdaptive Questionnaire Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S1..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(Adaptive Questionnaire)Form being answered
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text 0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueStringstring
...... valueCodingCoding
...... valueUriuri
...... valueQuantityQuantity
...... valueAttachmentAttachment
...... valueReferenceReference(Any)
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.languagepreferredCommonLanguages
Max Binding: AllLanguages
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3QuestionnaireResponseIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4QuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5QuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6QuestionnaireResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1QuestionnaireResponse.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.questionnaireAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.authoredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qrs-1QuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()
ele-1QuestionnaireResponse.item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.linkIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.answer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.answer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.answer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.answer.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answer.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())