Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0-ballot - ballot
Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0-ballot - ballot
This page is part of the electronic Long-Term Services and Supports Implementation Guide (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/QuestionnaireResponse-eltss | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: QuestionnaireResponse_eltss | ||
To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch retrieve captures the responses to form/survey and assessment tools such as the Protocol for Responding to and Assessing Patients’ Assets, Risks, and Experiences (PRAPARE) Survey. This profile is based on the Structured Data Capture (SDC) Questionnaire Response Profile and identifies the additional core elements, extensions, vocabularies and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific uses cases.
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 | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
  identifier | S | 0..1 | Identifier | Unique id for this set of answers |
 questionnaire | S | 0..1 | canonical(Questionnaire_eltss) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
 subject | S | 1..1 | Reference(Patient_eltss S | Resource) | The subject of the questions |
| authored | S | 0..1 | dateTime | Date the answers were gathered |
| author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
 item | S | 0..* | BackboneElement | Groups and questions |
 linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
  value[x] | S | 0..1 | Single-valued answer to the question | |
 valueBoolean | boolean S | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime S | |||
| valueTime | time | |||
| valueString | string S | |||
| valueUri | uri S | |||
 valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
 valueReference | Reference(Resource) | |||
| item | S | 0..* | Nested groups and questions | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
| 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_eltss) | 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Σ | 1..1 | Reference(Patient_eltss) | The subject of the questions |
| authored | SΣ | 0..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| item | SC | 0..* | BackboneElement | Groups and questions |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| 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 | |||
| valueDateTime | dateTime | |||
| valueString | string | |||
| valueUri | uri | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |||||
| 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_eltss) | 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Σ | 1..1 | Reference(Patient_eltss S | Resource) | The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 0..1 | dateTime | Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | 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 | Groups and questions | ||||
| 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 | S | 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 | S | 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] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| valueBoolean | boolean S | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime S | |||||||
| valueTime | time | |||||||
| valueString | string S | |||||||
| valueUri | uri S | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
| item | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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 |
| 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
Mandatory: 1 element
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
| identifier | S | 0..1 | Identifier | Unique id for this set of answers |
| questionnaire | S | 0..1 | canonical(Questionnaire_eltss) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
| subject | S | 1..1 | Reference(Patient_eltss S | Resource) | The subject of the questions |
| authored | S | 0..1 | dateTime | Date the answers were gathered |
| author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| item | S | 0..* | BackboneElement | Groups and questions |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| value[x] | S | 0..1 | Single-valued answer to the question | |
| valueBoolean | boolean S | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime S | |||
| valueTime | time | |||
| valueString | string S | |||
| valueUri | uri S | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | S | 0..* | Nested groups and questions | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
| 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_eltss) | 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Σ | 1..1 | Reference(Patient_eltss) | The subject of the questions |
| authored | SΣ | 0..1 | dateTime | Date the answers were gathered |
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
| item | SC | 0..* | BackboneElement | Groups and questions |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| answer | S | 0..* | BackboneElement | The response(s) to the question |
| 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 | |||
| valueDateTime | dateTime | |||
| valueString | string | |||
| valueUri | uri | |||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |||||
| 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_eltss) | 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Σ | 1..1 | Reference(Patient_eltss S | Resource) | The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 0..1 | dateTime | Date the answers were gathered | ||||
| author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | 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 | Groups and questions | ||||
| 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 | S | 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 | S | 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] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| valueBoolean | boolean S | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime S | |||||||
| valueTime | time | |||||||
| valueString | string S | |||||||
| valueUri | uri S | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
| item | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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 |
| 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
Mandatory: 1 element
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Human and Social Services. Package hl7.fhir.us.eltss#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change