This page is part of the Clinical Guidelines (v2.0.0: STU2) 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/uv/cpg/StructureDefinition/cpg-questionnaireresponse | Version: 2.0.0 | |||
Active as of 2024-11-26 | Computable Name: CPGQuestionnaireResponse | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.102 |
The response to a particular questionnaire as an activity within the context of a computable clinical practice guideline
This is an activity event profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | QuestionnaireResponse | |||
identifier | S | 0..1 | Identifier | Unique id for this set of answers |
questionnaire | S | 0..1 | canonical(Questionnaire) | Form being answered |
status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
subject | S | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions |
encounter | S | 0..1 | Reference(CPG Encounter) | Encounter created as part of |
authored | S | 0..1 | dateTime | Date the answers were gathered |
author | S | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers |
source | S | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions |
item | S | 0..* | BackboneElement | Groups and questions |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
questionnaire | SΣ | 0..1 | canonical(Questionnaire) | Form being answered |
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
subject | SΣ | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions |
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Encounter created as part of |
authored | SΣ | 0..1 | dateTime | Date the answers were gathered |
author | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers |
source | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions |
item | SC | 0..* | BackboneElement | Groups and questions qrs-1: Nested item can't be beneath both item and answer |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Pointer to specific item from Questionnaire | |
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 |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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Σ | 0..1 | canonical(Questionnaire) | Form being answered | ||||
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
subject | SΣ | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions | ||||
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Encounter created as part of | ||||
authored | SΣ | 0..1 | dateTime | Date the answers were gathered | ||||
author | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers | ||||
source | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | 1..1 | string | Pointer to specific item from Questionnaire | |||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
text | 0..1 | string | Name for group or question text | |||||
answer | 0..* | BackboneElement | The response(s) to the question | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
item | 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() |
This structure is derived from QuestionnaireResponse
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | QuestionnaireResponse | |||
identifier | S | 0..1 | Identifier | Unique id for this set of answers |
questionnaire | S | 0..1 | canonical(Questionnaire) | Form being answered |
status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
subject | S | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions |
encounter | S | 0..1 | Reference(CPG Encounter) | Encounter created as part of |
authored | S | 0..1 | dateTime | Date the answers were gathered |
author | S | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers |
source | S | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions |
item | S | 0..* | BackboneElement | Groups and questions |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
questionnaire | SΣ | 0..1 | canonical(Questionnaire) | Form being answered |
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
subject | SΣ | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions |
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Encounter created as part of |
authored | SΣ | 0..1 | dateTime | Date the answers were gathered |
author | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers |
source | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions |
item | SC | 0..* | BackboneElement | Groups and questions qrs-1: Nested item can't be beneath both item and answer |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Pointer to specific item from Questionnaire | |
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 |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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Σ | 0..1 | canonical(Questionnaire) | Form being answered | ||||
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
subject | SΣ | 0..1 | Reference(CPG Patient | CPG Related Person) | The subject of the questions | ||||
encounter | SΣ | 0..1 | Reference(CPG Encounter) | Encounter created as part of | ||||
authored | SΣ | 0..1 | dateTime | Date the answers were gathered | ||||
author | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | Person who received and recorded the answers | ||||
source | SΣ | 0..1 | Reference(CPG Patient | CPG Practitioner | CPG Practitioner Role | CPG Related Person) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | 1..1 | string | Pointer to specific item from Questionnaire | |||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
text | 0..1 | string | Name for group or question text | |||||
answer | 0..* | BackboneElement | The response(s) to the question | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
item | 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() |
This structure is derived from QuestionnaireResponse
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron