Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.virtually.healthcare/StructureDefinition/QuestionnaireResponse | Version: 0.1.0-current | |||
Draft as of 2024-12-02 | Computable Name: QuestionnaireResponse |
Based on HL7 Structured Data Capture
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 | A structured set of questions and their answers | |
identifier | S | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations |
questionnaire | S | 1..1 | canonical(Questionnaire) | Form being answered |
subject | S | 1..1 | Reference(Patient) | The subject of the questions |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
encounter | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR | |
authored | S | 0..1 | dateTime | When the form was completed. Required for POST operations |
author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
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 | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations |
questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered |
status | ?!Σ | 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) | The subject of the questions |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
encounter | Σ | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR |
authored | SΣ | 0..1 | dateTime | When the form was completed. Required for POST operations |
author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
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 |
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 | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
partOf | Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
status | ?!Σ | 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) | The subject of the questions | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | Σ | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR | ||||
authored | SΣ | 0..1 | dateTime | When the form was completed. Required for POST operations | ||||
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 | C | 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.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types 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 |
This structure is derived from QuestionnaireResponse
Differential View
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
identifier | S | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations |
questionnaire | S | 1..1 | canonical(Questionnaire) | Form being answered |
subject | S | 1..1 | Reference(Patient) | The subject of the questions |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
encounter | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR | |
authored | S | 0..1 | dateTime | When the form was completed. Required for POST operations |
author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
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 | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations |
questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered |
status | ?!Σ | 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) | The subject of the questions |
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |
encounter | Σ | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR |
authored | SΣ | 0..1 | dateTime | When the form was completed. Required for POST operations |
author | SΣ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Person who received and recorded the answers |
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 |
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 | 1..1 | CommonResourceIdentifiers | Identifier of the completed form. Required for POST operations | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
partOf | Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
status | ?!Σ | 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) | The subject of the questions | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | 0..1 | NHSNumbers | An identifier intended for computation | |||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | Σ | 0..1 | Reference(Encounter) | The encounter where the data was captured in. Required for GP system writeaback, optional for CDR | ||||
authored | SΣ | 0..1 | dateTime | When the form was completed. Required for POST operations | ||||
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 | C | 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.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types 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 |
This structure is derived from QuestionnaireResponse
Other representations of profile: CSV, Excel, Schematron