QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. 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: 6.0.0 | |||
| Active as of 2023-08-01 | 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 | USCoreQuestionnaireResponseProfile | |||
  subject | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions | |
| author | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) Person who received and recorded the answers | |
  item | 0..* | BackboneElement | (QI-Core)(USCDI) Groups and questions | |
 linkId | 1..1 | string | (QI-Core)(USCDI) Pointer to specific item from Questionnaire | |
| answer | ||||
 value[x] | 0..1 | (QI-Core)(USCDI) Single-valued answer to the question | ||
 valueCoding | Coding | |||
 valueString | string | |||
| valueDecimal | decimal | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueInteger | integer | |||
 valueQuantity | Quantity | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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. |
| 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) | (USCDI) 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 | (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 |
| status | ?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions |
| authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) Person who received and recorded the answers |
| item | SC | 0..* | BackboneElement | (QI-Core)(USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer |
| 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 | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
| valueCoding | Coding | |||
| valueString | string | |||
| valueDecimal | decimal | |||
| 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 | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| 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 sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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. | ||||
| 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 | |||||
| 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) | (USCDI) 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 | (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 | ||||
| value | 0..1 | string | Primitive value for canonical | |||||
| status | ?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer | ||||
| 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 | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| valueCoding | Coding S | |||||||
| valueString | string S | |||||||
| valueDecimal | decimal S | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueInteger | integer | |||||||
| 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 | URI | |||
| QuestionnaireResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| 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() |
This structure is derived from USCoreQuestionnaireResponseProfile
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from USCoreQuestionnaireResponseProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | USCoreQuestionnaireResponseProfile | |||
| subject | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions | |
| author | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) Person who received and recorded the answers | |
| item | 0..* | BackboneElement | (QI-Core)(USCDI) Groups and questions | |
| linkId | 1..1 | string | (QI-Core)(USCDI) Pointer to specific item from Questionnaire | |
| answer | ||||
| value[x] | 0..1 | (QI-Core)(USCDI) Single-valued answer to the question | ||
| valueCoding | Coding | |||
| valueString | string | |||
| valueDecimal | decimal | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueInteger | integer | |||
| valueQuantity | Quantity | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | C | 0..* | USCoreQuestionnaireResponseProfile | US Core Profile based on SDC QuestionnaireResponse sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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. |
| 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) | (USCDI) 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 | (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 |
| status | ?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions |
| authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) Person who received and recorded the answers |
| item | SC | 0..* | BackboneElement | (QI-Core)(USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer |
| 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 | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
| valueCoding | Coding | |||
| valueString | string | |||
| valueDecimal | decimal | |||
| 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 | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| 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 sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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. | ||||
| 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 | |||||
| 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) | (USCDI) 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 | (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 | ||||
| value | 0..1 | string | Primitive value for canonical | |||||
| status | ?!SΣ | 1..1 | code | (USCDI) in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore PractitionerRole | QICore Device | QICore RelatedPerson | US Core Implantable Device Profile) | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer | ||||
| 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 | (QI-Core)(USCDI) 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 | (QI-Core)(USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| valueCoding | Coding S | |||||||
| valueString | string S | |||||||
| valueDecimal | decimal S | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueInteger | integer | |||||||
| 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 | URI | |||
| QuestionnaireResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| 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() |
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
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#6.0.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change