QI-Core Implementation Guide
5.0.0 - STU5
QI-Core Implementation Guide
5.0.0 - STU5
This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-questionnaireresponse | Version: 5.0.0 | |||
| Active as of 2022-04-20 | Computable Name: QICoreQuestionnaireResponse | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
The QI 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 |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreQuestionnaireResponseProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  QuestionnaireResponse | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | |
  subject | S | 1..1 | Reference(QICore Patient) | The subject of the questions |
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of |
| author | S | 0..1 | Reference(QICore Practitioner S | QICore Organization S | QICore Patient S | QICore PractitionerRole S | QICore Device | QICore RelatedPerson S | US Core Implantable Device Profile) | Person who received and recorded the answers |
| source | SΣ | 0..1 | Reference(QICore Patient S | QICore Practitioner | QICore PractitionerRole S | QICore RelatedPerson S) | The person who answered the questions |
  item | S | 0..* | BackboneElement | Groups and questions |
 linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | ||||
 value[x] | S | 0..1 | Single-valued answer to the question | |
 valueBoolean | boolean | |||
| valueDate | date S | |||
| valueDateTime | dateTime S | |||
| valueTime | time | |||
| valueDecimal | decimal S | |||
| valueInteger | integer S | |||
| valueString | string S | |||
 valueCoding | Coding S | |||
| valueUri | uri | |||
| valueQuantity | Quantity S | |||
| valueAttachment | Attachment | |||
 valueReference | Reference(Any) | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse |
 meta | SΣ | 0..1 | Meta | Metadata about the resource |
  Slices for tag | SΣ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by pattern:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
 tag:All Slices | Content/Rules for all slices | |||
  code | Σ | 1..1 | code | Symbol in syntax defined by the system |
  tag:sdoh | SΣ | 0..1 | Coding | SDOH Tag Binding: US Core Tags ValueSet (required) Required Pattern: At least the following |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sdoh | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| signature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| 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. | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
| questionnaire | SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | Form being answered |
| questionnaireDisplay | S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display |
| 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 |
| 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(QICore Patient) | The subject of the questions |
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore RelatedPerson) | Person who received and recorded the answers |
| source | SΣ | 0..1 | Reference(QICore Patient | QICore PractitionerRole | QICore RelatedPerson) | The person who answered the questions |
| item | SC | 0..* | BackboneElement | Groups and questions |
| itemMedia | 0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
| ItemSignature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 |
| itemAnswerMedia | 0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
| ordinalValue | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |
| 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. | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| 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 | Conformance | ValueSet / Code |
| QuestionnaireResponse.meta.tag | example | CommonTags |
| QuestionnaireResponse.meta.tag:sdoh | required | Pattern: sdoh |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | 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 | **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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Slices for tag | SΣ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by pattern:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| tag:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag:sdoh | SΣ | 0..1 | Coding | SDOH Tag Binding: US Core Tags ValueSet (required) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sdoh | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| signature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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. | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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) | 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 | |||||
| questionnaireDisplay | S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | ||||
| 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 | ||||
| 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(QICore Patient) | The subject of the questions | ||||
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(QICore Practitioner S | QICore Organization S | QICore Patient S | QICore PractitionerRole S | QICore Device | QICore RelatedPerson S | US Core Implantable Device Profile) | Person who received and recorded the answers | ||||
| source | SΣ | 0..1 | Reference(QICore Patient S | QICore Practitioner | QICore PractitionerRole S | QICore RelatedPerson S) | The person who answered the questions | ||||
| item | SC | 0..* | BackboneElement | Groups and questions | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMedia | 0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| ItemSignature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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 | 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 | |||||
| itemAnswerMedia | 0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| ordinalValue | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
| 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 S | |||||||
| valueDateTime | dateTime S | |||||||
| valueTime | time | |||||||
| valueDecimal | decimal S | |||||||
| valueInteger | integer S | |||||||
| valueString | string S | |||||||
| valueCoding | Coding S | |||||||
| valueUri | uri | |||||||
| valueQuantity | Quantity S | |||||||
| 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 | Conformance | ValueSet / Code | ||||
| QuestionnaireResponse.meta.security | extensible | All Security Labels | ||||
| QuestionnaireResponse.meta.tag | example | CommonTags | ||||
| QuestionnaireResponse.meta.tag:sdoh | required | Pattern: sdoh | ||||
| QuestionnaireResponse.language | preferred | CommonLanguages
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from USCoreQuestionnaireResponseProfile
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from USCoreQuestionnaireResponseProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | |
| subject | S | 1..1 | Reference(QICore Patient) | The subject of the questions |
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of |
| author | S | 0..1 | Reference(QICore Practitioner S | QICore Organization S | QICore Patient S | QICore PractitionerRole S | QICore Device | QICore RelatedPerson S | US Core Implantable Device Profile) | Person who received and recorded the answers |
| source | SΣ | 0..1 | Reference(QICore Patient S | QICore Practitioner | QICore PractitionerRole S | QICore RelatedPerson S) | The person who answered the questions |
| item | S | 0..* | BackboneElement | Groups and questions |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | ||||
| value[x] | S | 0..1 | Single-valued answer to the question | |
| valueBoolean | boolean | |||
| valueDate | date S | |||
| valueDateTime | dateTime S | |||
| valueTime | time | |||
| valueDecimal | decimal S | |||
| valueInteger | integer S | |||
| valueString | string S | |||
| valueCoding | Coding S | |||
| valueUri | uri | |||
| valueQuantity | Quantity S | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Any) | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse |
| meta | SΣ | 0..1 | Meta | Metadata about the resource |
| Slices for tag | SΣ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by pattern:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| tag:All Slices | Content/Rules for all slices | |||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| tag:sdoh | SΣ | 0..1 | Coding | SDOH Tag Binding: US Core Tags ValueSet (required) Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sdoh | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| signature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| 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. | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
| questionnaire | SΣ | 1..1 | canonical(SDCBaseQuestionnaire) | Form being answered |
| questionnaireDisplay | S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display |
| 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 |
| 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(QICore Patient) | The subject of the questions |
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore RelatedPerson) | Person who received and recorded the answers |
| source | SΣ | 0..1 | Reference(QICore Patient | QICore PractitionerRole | QICore RelatedPerson) | The person who answered the questions |
| item | SC | 0..* | BackboneElement | Groups and questions |
| itemMedia | 0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
| ItemSignature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 |
| itemAnswerMedia | 0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
| ordinalValue | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |
| 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. | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| 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 | Conformance | ValueSet / Code |
| QuestionnaireResponse.meta.tag | example | CommonTags |
| QuestionnaireResponse.meta.tag:sdoh | required | Pattern: sdoh |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | 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 | **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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Slices for tag | SΣ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by pattern:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| tag:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| tag:sdoh | SΣ | 0..1 | Coding | SDOH Tag Binding: US Core Tags ValueSet (required) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sdoh | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| signature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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. | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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) | 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 | |||||
| questionnaireDisplay | S | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | ||||
| 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 | ||||
| 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(QICore Patient) | The subject of the questions | ||||
| encounter | SΣ | 0..1 | Reference(QICore Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(QICore Practitioner S | QICore Organization S | QICore Patient S | QICore PractitionerRole S | QICore Device | QICore RelatedPerson S | US Core Implantable Device Profile) | Person who received and recorded the answers | ||||
| source | SΣ | 0..1 | Reference(QICore Patient S | QICore Practitioner | QICore PractitionerRole S | QICore RelatedPerson S) | The person who answered the questions | ||||
| item | SC | 0..* | BackboneElement | Groups and questions | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMedia | 0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| ItemSignature | 0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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 | 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 | |||||
| itemAnswerMedia | 0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| ordinalValue | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
| 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 S | |||||||
| valueDateTime | dateTime S | |||||||
| valueTime | time | |||||||
| valueDecimal | decimal S | |||||||
| valueInteger | integer S | |||||||
| valueString | string S | |||||||
| valueCoding | Coding S | |||||||
| valueUri | uri | |||||||
| valueQuantity | Quantity S | |||||||
| 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 | Conformance | ValueSet / Code | ||||
| QuestionnaireResponse.meta.security | extensible | All Security Labels | ||||
| QuestionnaireResponse.meta.tag | example | CommonTags | ||||
| QuestionnaireResponse.meta.tag:sdoh | required | Pattern: sdoh | ||||
| QuestionnaireResponse.language | preferred | CommonLanguages
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from USCoreQuestionnaireResponseProfile
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#5.0.0 based on FHIR 4.0.1. Generated 2023-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change