Structured Data Capture
3.0.0-preview - STU 3
Structured Data Capture
3.0.0-preview - STU 3
This page is part of the Structured Data Capture FHIR IG (v3.0.0-preview: STU 3 Draft) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt | Version: 3.0.0-preview | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: QuestionnaireResponseAdapt | ||
Defines how the questionnaire response resource is used to reflect form data within the ONC’s Structured Data Capture standard.
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.
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.
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:
Maturity: 3
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  QuestionnaireResponse | 0..* | QuestionnaireResponse | Adaptive Questionnaire Response | |
  contained | S | 1..* | Resource | Contained, inline Resources |
 questionnaire | S | 1..1 | canonical(Adaptive Questionnaire) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
 subject | S | 1..1 | Reference(Patient) | The subject of the questions |
| authored | S | 1..1 | dateTime | Date the answers were gathered |
| author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
 item | S | 0..* | BackboneElement | Groups and questions |
 linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
 answer | S | 0..* | BackboneElement | The response(s) to the question |
  value[x] | S | 0..1 | Single-valued answer to the question | |
| valueBoolean | boolean | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
 valueCoding | Coding | |||
| valueUri | uri | |||
| valueQuantity | Quantity | |||
| valueAttachment | Attachment | |||
 valueReference | Reference(Any) | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | Adaptive Questionnaire Response | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | S | 1..* | Resource | Contained, inline Resources |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Unique 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..1 | canonical(Adaptive Questionnaire) | Form being answered |
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
| subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions |
| item | SI | 0..* | BackboneElement | Groups and questions |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| text | 0..1 | string | Name for group or question text | |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
| valueBoolean | boolean | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueUri | uri | |||
| valueQuantity | Quantity | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Any) | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | Adaptive Questionnaire Response | |
| contained | 1..* | Resource | Contained, inline Resources | |
| questionnaire | Σ | 1..1 | canonical(Adaptive Questionnaire) | Form being answered |
| status | ?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
| subject | Σ | 1..1 | Reference(Patient) | The subject of the questions |
| authored | Σ | 1..1 | dateTime | Date the answers were gathered |
| author | Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| item | I | 0..* | BackboneElement | Groups and questions |
| linkId | 1..1 | string | Pointer to specific item from Questionnaire | |
| answer | 0..* | BackboneElement | The response(s) to the question | |
| value[x] | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||
| valueBoolean | boolean | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueUri | uri | |||
| valueQuantity | Quantity | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Any) | |||
| item | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | |
| item | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |
| 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:
Maturity: 3
Differential View
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | Adaptive Questionnaire Response | |
| contained | S | 1..* | Resource | Contained, inline Resources |
| questionnaire | S | 1..1 | canonical(Adaptive Questionnaire) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
| subject | S | 1..1 | Reference(Patient) | The subject of the questions |
| authored | S | 1..1 | dateTime | Date the answers were gathered |
| author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| item | S | 0..* | BackboneElement | Groups and questions |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| value[x] | S | 0..1 | Single-valued answer to the question | |
| valueBoolean | boolean | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueUri | uri | |||
| valueQuantity | Quantity | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Any) | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | Adaptive Questionnaire Response | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | S | 1..* | Resource | Contained, inline Resources |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Unique 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..1 | canonical(Adaptive Questionnaire) | Form being answered |
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
| subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions |
| item | SI | 0..* | BackboneElement | Groups and questions |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| text | 0..1 | string | Name for group or question text | |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
| valueBoolean | boolean | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueUri | uri | |||
| valueQuantity | Quantity | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Any) | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| QuestionnaireResponse.language | preferred | CommonLanguages Max Binding: AllLanguages |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | QuestionnaireResponse | If 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-4 | error | QuestionnaireResponse | If 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-5 | error | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | QuestionnaireResponse | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | QuestionnaireResponse.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.questionnaire | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.authored | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() | |
| ele-1 | error | QuestionnaireResponse.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.linkId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.answer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.answer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.answer.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2022+ HL7 International - FHIR Infrastructure Work Group. Package hl7.fhir.uv.sdc#3.0.0-preview based on FHIR 4.0.1. Generated 2022-02-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change