SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-questionnaireresponse | Version: 0.1.0 | |||
| Active as of 2025-11-25 | Computable Name: HIEQuestionnaireResponse | |||
R4B QuestionnaireResponse profiled for HIE capture. Emphasizes linkage to Questionnaire, subject and encounter context, authorship, and structured item answers.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..1 | Identifier | Unique id for this set of answers |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
Σ | 0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse |
![]() ![]() |
Σ | 0..* | HIEReference(HIE Observation | Procedure) | Part of this action |
![]() ![]() |
SΣ | 1..1 | canonical(Questionnaire) | Form being answered |
![]() ![]() |
?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the questions |
![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
SΣ | 1..1 | dateTime | Date the answers were gathered |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions |
![]() ![]() |
SC | 1..* | BackboneElement | Groups and questions Constraints: qrs-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse | |
![]() ![]() |
0..* | HIEReference(HIE Observation | Procedure) | Part of this action | |
![]() ![]() |
S | 1..1 | canonical(Questionnaire) | Form being answered |
![]() ![]() |
S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | The subject of the questions |
![]() ![]() |
S | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
S | 1..1 | dateTime | Date the answers were gathered |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions | |
![]() ![]() |
S | 1..* | BackboneElement | Groups and questions |
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.exists())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Unique id for this set of answers | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
![]() ![]() |
Σ | 0..* | HIEReference(HIE Observation | Procedure) | Part of this action | ||||
![]() ![]() |
SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
![]() ![]() |
?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the questions | ||||
![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Groups and questions Constraints: qrs-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Binding this is problematic because one value set can't apply to both codes and quantities. | ||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
![]() ![]() ![]() |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.3.0 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | QuestionnaireResponse.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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()
|
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.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: 4 elements(4 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..1 | Identifier | Unique id for this set of answers |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
Σ | 0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse |
![]() ![]() |
Σ | 0..* | HIEReference(HIE Observation | Procedure) | Part of this action |
![]() ![]() |
SΣ | 1..1 | canonical(Questionnaire) | Form being answered |
![]() ![]() |
?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the questions |
![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
SΣ | 1..1 | dateTime | Date the answers were gathered |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers |
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions |
![]() ![]() |
SC | 1..* | BackboneElement | Groups and questions Constraints: qrs-1 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.exists())
|
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer |
(answer.exists() and item.exists()).not()
|
Differential View
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse | |
![]() ![]() |
0..* | HIEReference(HIE Observation | Procedure) | Part of this action | |
![]() ![]() |
S | 1..1 | canonical(Questionnaire) | Form being answered |
![]() ![]() |
S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | The subject of the questions |
![]() ![]() |
S | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of |
![]() ![]() |
S | 1..1 | dateTime | Date the answers were gathered |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers | |
![]() ![]() |
0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions | |
![]() ![]() |
S | 1..* | BackboneElement | Groups and questions |
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire |
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.exists())
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | QuestionnaireResponse | A structured set of questions and their answers Constraints: hie-qr-item-has-answer-or-children, hie-qr-answer-has-value-or-children | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Unique id for this set of answers | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | HIEReference(ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
![]() ![]() |
Σ | 0..* | HIEReference(HIE Observation | Procedure) | Part of this action | ||||
![]() ![]() |
SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
![]() ![]() |
?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the questions | ||||
![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Encounter) | Encounter created as part of | ||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | Person who received and recorded the answers | ||||
![]() ![]() |
Σ | 0..1 | HIEReference(HIE Practitioner | HIE PractitionerRole | HIE Patient | RelatedPerson) | The person who answered the questions | ||||
![]() ![]() |
SC | 1..* | BackboneElement | Groups and questions Constraints: qrs-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() |
S | 0..1 | string | Name for group or question text | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | The response(s) to the question | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Binding this is problematic because one value set can't apply to both codes and quantities. | ||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
![]() ![]() ![]() |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.3.0 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | QuestionnaireResponse.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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()
|
| hie-qr-answer-has-value-or-children | error | QuestionnaireResponse | Each answer must have a value or nested items |
answer.exists() implies answer.all(value.exists() or item.exists())
|
| hie-qr-item-has-answer-or-children | warning | QuestionnaireResponse | Each item must contain an answer or nested items |
item.exists() implies (item.answer.exists() or item.item.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: 4 elements(4 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron