Da Vinci Clinical Data Exchange (CDex)
2.1.0 - STU 2.1
Da Vinci Clinical Data Exchange (CDex)
2.1.0 - STU 2.1
Da Vinci Clinical Data Exchange (CDex), published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ecdx/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse | Version: 2.1.0 | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CDEXSDCQuestionnaireResponse | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.21.42.4 | |||||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
|||||
This profile is derived from the US Core QuestionnaireResponse Profile profile and enforces the various elements of signature documented in the CDex guide. It adds the following constraints:
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  QuestionnaireResponse |
C | 0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
Content/Rules for all slices | |||
   extension:signature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |
   extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |
  value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
 extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| identifier |
SΣ | 0..1 | Identifier | Unique id for this set of answers |
| questionnaire |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire(3.0.0)) | Form being answered |
 Slices for extension |
Content/Rules for all slices | |||
 extension:questionnaireDisplay |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display Constraints: ext-1 |
| extension:url |
S | 0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri Constraints: ext-1 |
| 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(US Core Patient Profile(7.0.0) S | Resource) | The subject of the questions |
| authored |
SΣ | 1..1 | dateTime | Date the answers were gathered |
| author |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | PractitionerRole | Device | US Core RelatedPerson Profile(7.0.0)) | Person who received and recorded the answers |
| item |
SC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia Constraints: ext-1 | |
| extension:ItemSignature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| linkId |
S | 1..1 | string | Pointer to specific item from Questionnaire |
| text |
S | 0..1 | string | Name for group or question text |
| answer |
S | 0..* | BackboneElement | The response(s) to the question |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia Constraints: ext-1 | |
| extension:ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
 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 S | |||
| valueInteger |
integer | |||
| valueString |
string S | |||
| valueCoding |
Coding S | |||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.implicitRules, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:signature.value[x], QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.identifier, QuestionnaireResponse.questionnaire, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.status, QuestionnaireResponse.subject, QuestionnaireResponse.authored, QuestionnaireResponse.author, QuestionnaireResponse.item, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.extension:ItemSignature.value[x], QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.linkId, QuestionnaireResponse.item.text, QuestionnaireResponse.item.answer, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension, QuestionnaireResponse.item.answer.value[x], QuestionnaireResponse.item.answer.item, QuestionnaireResponse.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer |
(answer.exists() and item.exists()).not()
|
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. |
subject.exists()
|
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
(QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:signature |
0..* | QRSignature(5.3.0) | A signature attesting to the content | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
 item |
0..* | BackboneElement | Groups and questions | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ItemSignature |
0..* | QRSignature(5.3.0) | A signature attesting to the content | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 | ||||
| id |
Σ | 0..1 | id | 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:signature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |||||
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
SΣ | 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(SDCBaseQuestionnaire(3.0.0)) | Form being answered | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:questionnaireDisplay |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display Constraints: ext-1 | ||||
| extension:url |
S | 0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri Constraints: ext-1 | ||||
| value |
0..1 | string | Primitive value for canonical | |||||
| 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(US Core Patient Profile(7.0.0) S | Resource) | 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(US Core Practitioner Profile(7.0.0) S | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | PractitionerRole | Device | US Core RelatedPerson Profile(7.0.0)) | Person who received and recorded the answers | ||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
| item |
SC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia Constraints: ext-1 | |||||
| extension:ItemSignature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |||||
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| linkId |
S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| text |
S | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia Constraints: ext-1 | |||||
| extension:ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 S | |||||||
| valueInteger |
integer | |||||||
| valueString |
string S | |||||||
| valueCoding |
Coding S | |||||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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, QuestionnaireResponse.implicitRules, QuestionnaireResponse.language, QuestionnaireResponse.text, QuestionnaireResponse.extension, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:signature.value[x], QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.identifier, QuestionnaireResponse.basedOn, QuestionnaireResponse.partOf, QuestionnaireResponse.questionnaire, QuestionnaireResponse.questionnaire.extension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.status, QuestionnaireResponse.subject, QuestionnaireResponse.encounter, QuestionnaireResponse.authored, QuestionnaireResponse.author, QuestionnaireResponse.source, QuestionnaireResponse.item, QuestionnaireResponse.item.extension, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.extension:ItemSignature.value[x], QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.linkId, QuestionnaireResponse.item.definition, QuestionnaireResponse.item.text, QuestionnaireResponse.item.answer, QuestionnaireResponse.item.answer.extension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension, QuestionnaireResponse.item.answer.value[x], QuestionnaireResponse.item.answer.item, QuestionnaireResponse.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | QuestionnaireResponse.extension, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.questionnaire.extension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.item.extension, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.answer.extension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer |
(answer.exists() and item.exists()).not()
|
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. |
subject.exists()
|
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
(QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
|
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:signature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| identifier |
SΣ | 0..1 | Identifier | Unique id for this set of answers |
| questionnaire |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire(3.0.0)) | Form being answered |
| Slices for extension |
Content/Rules for all slices | |||
| extension:questionnaireDisplay |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display Constraints: ext-1 |
| extension:url |
S | 0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri Constraints: ext-1 |
| 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(US Core Patient Profile(7.0.0) S | Resource) | The subject of the questions |
| authored |
SΣ | 1..1 | dateTime | Date the answers were gathered |
| author |
SΣ | 0..1 | Reference(US Core Practitioner Profile(7.0.0) S | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | PractitionerRole | Device | US Core RelatedPerson Profile(7.0.0)) | Person who received and recorded the answers |
| item |
SC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia Constraints: ext-1 | |
| extension:ItemSignature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| linkId |
S | 1..1 | string | Pointer to specific item from Questionnaire |
| text |
S | 0..1 | string | Name for group or question text |
| answer |
S | 0..* | BackboneElement | The response(s) to the question |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia Constraints: ext-1 | |
| extension:ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| 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 S | |||
| valueInteger |
integer | |||
| valueString |
string S | |||
| valueCoding |
Coding S | |||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.implicitRules, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:signature.value[x], QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.identifier, QuestionnaireResponse.questionnaire, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.status, QuestionnaireResponse.subject, QuestionnaireResponse.authored, QuestionnaireResponse.author, QuestionnaireResponse.item, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.extension:ItemSignature.value[x], QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.linkId, QuestionnaireResponse.item.text, QuestionnaireResponse.item.answer, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension, QuestionnaireResponse.item.answer.value[x], QuestionnaireResponse.item.answer.item, QuestionnaireResponse.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer |
(answer.exists() and item.exists()).not()
|
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. |
subject.exists()
|
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
(QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:signature |
0..* | QRSignature(5.3.0) | A signature attesting to the content | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| item |
0..* | BackboneElement | Groups and questions | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ItemSignature |
0..* | QRSignature(5.3.0) | A signature attesting to the content | |
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | USCoreQuestionnaireResponseProfile(7.0.0) | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 | ||||
| id |
Σ | 0..1 | id | 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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:signature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |||||
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
SΣ | 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(SDCBaseQuestionnaire(3.0.0)) | Form being answered | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:questionnaireDisplay |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display Constraints: ext-1 | ||||
| extension:url |
S | 0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri Constraints: ext-1 | ||||
| value |
0..1 | string | Primitive value for canonical | |||||
| 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(US Core Patient Profile(7.0.0) S | Resource) | 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(US Core Practitioner Profile(7.0.0) S | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | PractitionerRole | Device | US Core RelatedPerson Profile(7.0.0)) | Person who received and recorded the answers | ||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
| item |
SC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia Constraints: ext-1 | |||||
| extension:ItemSignature |
0..* | (Complex) | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature" | |||||
| value[x] |
1..1 | CDexDigitalSignature(2.1.0), Signature(4.0.1) | Value of extension | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| linkId |
S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| text |
S | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia Constraints: ext-1 | |||||
| extension:ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 S | |||||||
| valueInteger |
integer | |||||||
| valueString |
string S | |||||||
| valueCoding |
Coding S | |||||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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, QuestionnaireResponse.implicitRules, QuestionnaireResponse.language, QuestionnaireResponse.text, QuestionnaireResponse.extension, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:signature.value[x], QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.identifier, QuestionnaireResponse.basedOn, QuestionnaireResponse.partOf, QuestionnaireResponse.questionnaire, QuestionnaireResponse.questionnaire.extension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.status, QuestionnaireResponse.subject, QuestionnaireResponse.encounter, QuestionnaireResponse.authored, QuestionnaireResponse.author, QuestionnaireResponse.source, QuestionnaireResponse.item, QuestionnaireResponse.item.extension, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.extension:ItemSignature.value[x], QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.linkId, QuestionnaireResponse.item.definition, QuestionnaireResponse.item.text, QuestionnaireResponse.item.answer, QuestionnaireResponse.item.answer.extension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension, QuestionnaireResponse.item.answer.value[x], QuestionnaireResponse.item.answer.item, QuestionnaireResponse.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | QuestionnaireResponse.extension, QuestionnaireResponse.extension:signature, QuestionnaireResponse.extension:completionMode, QuestionnaireResponse.modifierExtension, QuestionnaireResponse.questionnaire.extension, QuestionnaireResponse.questionnaire.extension:questionnaireDisplay, QuestionnaireResponse.questionnaire.extension:url, QuestionnaireResponse.item.extension, QuestionnaireResponse.item.extension:itemMedia, QuestionnaireResponse.item.extension:ItemSignature, QuestionnaireResponse.item.modifierExtension, QuestionnaireResponse.item.answer.extension, QuestionnaireResponse.item.answer.extension:itemAnswerMedia, QuestionnaireResponse.item.answer.extension:ordinalValue, QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer |
(answer.exists() and item.exists()).not()
|
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. |
subject.exists()
|
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
(QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
|
Summary
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Payer/Provider Information Exchange Work Group.
Package hl7.fhir.us.davinci-cdex#2.1.0 based on FHIR 4.0.1.
Generated
2026-06-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change