US Quality Core Implementation Guide, published by ASTP. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/us-quality-core/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.org/guides/astp/us-quality-core/StructureDefinition/us-quality-core-questionnaireresponse | Version: 0.1.0 | |||
| Active as of 2023-08-01 | Computable Name: USQualityCoreQuestionnaireResponse | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
The US Quality Core QuestionnaireResponse Profile is based upon the US Core QuestionnaireResponse Profile and sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch retrieve captures the responses to form/survey and defines the core set of elements and extensions for quality rule and measure authors.
| PHQ-9 QuestionnaireResponse Example |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
![]() ![]() ![]() |
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. | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Unique id for this set of answers |
![]() ![]() |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | (USCDI) Form being answered |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | (USCDI) 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 |
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
![]() ![]() |
SΣ | 1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions |
![]() ![]() |
SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers |
![]() ![]() |
SC | 0..* | BackboneElement | (USCDI) Groups and questions Constraints: qrs-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
![]() ![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | (USCDI) Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
![]() ![]() ![]() ![]() ![]() |
Coding S | |||
![]() ![]() ![]() ![]() ![]() |
string S | |||
![]() ![]() ![]() ![]() ![]() |
decimal S | |||
![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
![]() ![]() ![]() |
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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
This structure is derived from USCoreQuestionnaireResponseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | |
![]() ![]() |
1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions | |
![]() ![]() |
0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers | |
![]() ![]() |
0..* | BackboneElement | (USCDI) Groups and questions | |
![]() ![]() ![]() |
1..1 | string | (USCDI) Pointer to specific item from Questionnaire | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | (USCDI) Single-valued answer to the question | ||
![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Unique id for this set of answers | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
![]() ![]() |
Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
![]() ![]() |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | (USCDI) Form being answered | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | (USCDI) 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 | ||||
![]() ![]() ![]() |
0..1 | string | Primitive value for canonical | |||||
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
![]() ![]() |
SC | 0..* | BackboneElement | (USCDI) Groups and questions Constraints: qrs-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
![]() ![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | (USCDI) Pointer to specific item from Questionnaire | ||||
![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
![]() ![]() ![]() ![]() ![]() |
Coding S | |||||||
![]() ![]() ![]() ![]() ![]() |
string S | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal S | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
![]() ![]() ![]() |
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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
This structure is derived from USCoreQuestionnaireResponseProfile
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
![]() ![]() ![]() |
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. | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Unique id for this set of answers |
![]() ![]() |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | (USCDI) Form being answered |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | (USCDI) 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 |
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
![]() ![]() |
SΣ | 1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions |
![]() ![]() |
SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers |
![]() ![]() |
SC | 0..* | BackboneElement | (USCDI) Groups and questions Constraints: qrs-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
![]() ![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | (USCDI) Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
![]() ![]() ![]() ![]() ![]() |
Coding S | |||
![]() ![]() ![]() ![]() ![]() |
string S | |||
![]() ![]() ![]() ![]() ![]() |
decimal S | |||
![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
![]() ![]() ![]() |
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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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
This structure is derived from USCoreQuestionnaireResponseProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | |
![]() ![]() |
1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions | |
![]() ![]() |
0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers | |
![]() ![]() |
0..* | BackboneElement | (USCDI) Groups and questions | |
![]() ![]() ![]() |
1..1 | string | (USCDI) Pointer to specific item from Questionnaire | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | (USCDI) Single-valued answer to the question | ||
![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Unique id for this set of answers | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
![]() ![]() |
Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
![]() ![]() |
SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | (USCDI) Form being answered | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | (USCDI) 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 | ||||
![]() ![]() ![]() |
0..1 | string | Primitive value for canonical | |||||
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(US Quality Core Patient) | (USCDI) The subject of the questions | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Practitioner | US Quality Core Organization | US Quality Core Patient | US Quality Core PractitionerRole | US Quality Core Device | US Quality Core RelatedPerson | US Core Implantable Device Profile) | (USCDI) Person who received and recorded the answers | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
![]() ![]() |
SC | 0..* | BackboneElement | (USCDI) Groups and questions Constraints: qrs-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
![]() ![]() ![]() ![]() |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | (USCDI) Pointer to specific item from Questionnaire | ||||
![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
![]() ![]() ![]() ![]() ![]() |
Coding S | |||||||
![]() ![]() ![]() ![]() ![]() |
string S | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal S | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
![]() ![]() ![]() |
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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
This structure is derived from USCoreQuestionnaireResponseProfile
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron