MCC eCare Plan Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-mcc/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/mcc/StructureDefinition/MCCQuestionnaireResponse | Version: 1.0.0 | |||
Active as of 2024-08-13 | Computable Name: MCCQuestionnaireResponse |
This profile constrains US Core QuestionnaireResponse Profile for use in the MCC FHIR Care Plan or other FHIR Care Plans.
The US Core QuestionnaireResponse Profile sets minimum expectations for the Immunization Resource to record, search, and fetch immunizations associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. In addition to the requirements set forth in US Core Immunization Profile this derived profile is designed to add requirements to the following elements:
Value sets pertinent to this profile are found on the MCC Questionnaire Response Library Value Set
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 | 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 |
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. | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
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 |
Slices for extension | Content/Rules for all slices | |||
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(US Core Patient Profile) | (USCDI) The subject of the questions |
authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
author | SΣ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | Device | US Core RelatedPerson Profile) | (USCDI) Person who received and recorded the answers |
source | Σ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core RelatedPerson Profile) | The person who answered the questions |
item | SC | 0..* | BackboneElement | (USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer |
Slices for extension | Content/Rules for all slices | |||
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 | (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 |
Slices for extension | Content/Rules for all slices | |||
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 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
valueDecimal | decimal | |||
valueString | string | |||
valueCoding | Coding | |||
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.1 from the FHIR Standard | |
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from 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. | |||||
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
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(US Core Patient Profile) | (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(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | Device | US Core RelatedPerson Profile) | (USCDI) Person who received and recorded the answers | ||||
source | Σ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core RelatedPerson Profile) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | (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 | (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 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
valueBoolean | boolean | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal S | |||||||
valueInteger | integer | |||||||
valueString | string S | |||||||
valueCoding | Coding S | |||||||
valueUri | uri | |||||||
valueQuantity | Quantity | |||||||
valueAttachment | Attachment | |||||||
valueReference | Reference(Any) | |||||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
QuestionnaireResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1 from the FHIR Standard | ||||
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from 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
Must-Support: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreQuestionnaireResponseProfile
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 |
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. | |
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
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 |
Slices for extension | Content/Rules for all slices | |||
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(US Core Patient Profile) | (USCDI) The subject of the questions |
authored | SΣ | 1..1 | dateTime | (USCDI) Date the answers were gathered |
author | SΣ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | Device | US Core RelatedPerson Profile) | (USCDI) Person who received and recorded the answers |
source | Σ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core RelatedPerson Profile) | The person who answered the questions |
item | SC | 0..* | BackboneElement | (USCDI) Groups and questions qrs-1: Nested item can't be beneath both item and answer |
Slices for extension | Content/Rules for all slices | |||
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 | (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 |
Slices for extension | Content/Rules for all slices | |||
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 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
valueDecimal | decimal | |||
valueString | string | |||
valueCoding | Coding | |||
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.1 from the FHIR Standard | |
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from 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. | |||||
resource-pertainsToGoal | S | 0..* | Reference(Goal) | The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources. URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
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(US Core Patient Profile) | (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(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | Device | US Core RelatedPerson Profile) | (USCDI) Person who received and recorded the answers | ||||
source | Σ | 0..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Patient Profile | US Core RelatedPerson Profile) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | (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 | (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 | (USCDI) Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
valueBoolean | boolean | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal S | |||||||
valueInteger | integer | |||||||
valueString | string S | |||||||
valueCoding | Coding S | |||||||
valueUri | uri | |||||||
valueQuantity | Quantity | |||||||
valueAttachment | Attachment | |||||||
valueReference | Reference(Any) | |||||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
QuestionnaireResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1 from the FHIR Standard | ||||
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from 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
Must-Support: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron