Smart Health Checks
0.3.0 - ci-build
Smart Health Checks
0.3.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCQuestionnaireResponse | Version: 0.3.0 | |||
| Draft as of 2025-09-23 | Computable Name: SmartHealthChecksQuestionnaireResponse | |||
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
||||
This profile sets the minimum expectations for a QuestionnaireResponse resource to record, search and save form information when used within Smart Health Checks.
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:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||||
  id |
SOΣ | 1..1 | id | Logical id of this artifact
| ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
 text |
SO | 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
| ||||||
  Slices for extension |
Content/Rules for all slices | |||||||||
   extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||||
   extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||||
  value[x] |
1..1 | Value of extension | ||||||||
  valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
 valueUri |
uri | |||||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
 extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||||
 extension:source |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source" | |||||||
 value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| identifier |
SΣ | 0..1 | Identifier | Unique id for this set of answers | ||||||
| questionnaire |
SOΣ | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
 Slices for extension |
Content/Rules for all slices | |||||||||
 extension:questionnaireDisplay |
SO | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
| ||||||
| status |
?!SOΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
| ||||||
| subject |
SOΣ | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SOΣ | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
SOΣ | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
SOΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| item |
SOC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| linkId |
SO | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| text |
SO | 0..1 | string | Name for group or question text
| ||||||
| answer |
SO | 0..* | BackboneElement | The response(s) to the question
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| value[x] |
SO | 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 |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||||
| item |
SO | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1From the FHIR Standard | |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From 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() | |
| qrs-2 | error | QuestionnaireResponse.item | Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists() | |
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-3 | error | QuestionnaireResponse | Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1 |
This structure is derived from SDCQuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
0..* | SDCQuestionnaireResponse | Standard Questionnaire Response | |||||||
| id |
SO | 1..1 | id | Logical id of this artifact
| ||||||
| text |
SO | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||||
| questionnaire |
O | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:questionnaireDisplay |
O | 0..1 | DisplayName(5.3.0-ballot-tc1) | Display name for canonical reference
| ||||||
| status |
O | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped
| ||||||
| subject |
O | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SO | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
O | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
O | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| item |
O | 0..* | BackboneElement | Groups and questions
| ||||||
| linkId |
O | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| text |
O | 0..1 | string | Name for group or question text
| ||||||
| answer |
O | 0..* | BackboneElement | The response(s) to the question
| ||||||
| value[x] |
O | 0..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Single-valued answer to the question
| ||||||
| item |
O | 0..* | Nested questionnaire response items
| |||||||
| Documentation for this format | ||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||||
| id |
SOΣ | 1..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 |
SO | 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
| ||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||||
| extension:source |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source" | |||||||
| value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||||
| 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 |
SOΣ | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:questionnaireDisplay |
SO | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
| ||||||
| value |
0..1 | string | Primitive value for canonical | |||||||
| status |
?!SOΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
| ||||||
| subject |
SOΣ | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SOΣ | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
SOΣ | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
SOΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||||
| item |
SOC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| linkId |
SO | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||||
| text |
SO | 0..1 | string | Name for group or question text
| ||||||
| answer |
SO | 0..* | BackboneElement | The response(s) to the question
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| value[x] |
SO | 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 |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||||
| item |
SO | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| QuestionnaireResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1From the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From 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() | |
| qrs-2 | error | QuestionnaireResponse.item | Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists() | |
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-3 | error | QuestionnaireResponse | Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1 |
This structure is derived from SDCQuestionnaireResponse
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||||
| id |
SOΣ | 1..1 | id | Logical id of this artifact
| ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| text |
SO | 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
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||||
| extension:source |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source" | |||||||
| value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| identifier |
SΣ | 0..1 | Identifier | Unique id for this set of answers | ||||||
| questionnaire |
SOΣ | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:questionnaireDisplay |
SO | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
| ||||||
| status |
?!SOΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
| ||||||
| subject |
SOΣ | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SOΣ | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
SOΣ | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
SOΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| item |
SOC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| linkId |
SO | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| text |
SO | 0..1 | string | Name for group or question text
| ||||||
| answer |
SO | 0..* | BackboneElement | The response(s) to the question
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| value[x] |
SO | 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 |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||||
| item |
SO | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1From the FHIR Standard | |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From 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() | |
| qrs-2 | error | QuestionnaireResponse.item | Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists() | |
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-3 | error | QuestionnaireResponse | Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1 |
Differential View
This structure is derived from SDCQuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
0..* | SDCQuestionnaireResponse | Standard Questionnaire Response | |||||||
| id |
SO | 1..1 | id | Logical id of this artifact
| ||||||
| text |
SO | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||||
| questionnaire |
O | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:questionnaireDisplay |
O | 0..1 | DisplayName(5.3.0-ballot-tc1) | Display name for canonical reference
| ||||||
| status |
O | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped
| ||||||
| subject |
O | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SO | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
O | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
O | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| item |
O | 0..* | BackboneElement | Groups and questions
| ||||||
| linkId |
O | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| text |
O | 0..1 | string | Name for group or question text
| ||||||
| answer |
O | 0..* | BackboneElement | The response(s) to the question
| ||||||
| value[x] |
O | 0..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Single-valued answer to the question
| ||||||
| item |
O | 0..* | Nested questionnaire response items
| |||||||
| Documentation for this format | ||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||||
| id |
SOΣ | 1..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 |
SO | 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
| ||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||||
| value[x] |
1..1 | Value of extension | ||||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||||
| valueUri |
uri | |||||||||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||||
| extension:source |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..0 | |||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source" | |||||||
| value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||||
| 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 |
SOΣ | 1..1 | canonical(SDC Base Questionnaire) | Form being answered
| ||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:questionnaireDisplay |
SO | 0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
| ||||||
| value |
0..1 | string | Primitive value for canonical | |||||||
| status |
?!SOΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
| ||||||
| subject |
SOΣ | 1..1 | Reference(Patient) | The subject of the questions
| ||||||
| encounter |
SOΣ | 0..1 | Reference(Encounter) | Encounter created as part of
| ||||||
| authored |
SOΣ | 1..1 | dateTime | Date the answers were gathered
| ||||||
| author |
SOΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers
| ||||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||||
| item |
SOC | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| linkId |
SO | 1..1 | string | Pointer to specific item from Questionnaire
| ||||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||||
| text |
SO | 0..1 | string | Name for group or question text
| ||||||
| answer |
SO | 0..* | BackboneElement | The response(s) to the question
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| value[x] |
SO | 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 |
S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||||
| item |
SO | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| QuestionnaireResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1From the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From 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() | |
| qrs-2 | error | QuestionnaireResponse.item | Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-1 | best practice | QuestionnaireResponse | Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists() | |
| sdcqr-2 | best practice | QuestionnaireResponse | When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue() | |
| sdcqr-3 | error | QuestionnaireResponse | Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1 |
This structure is derived from SDCQuestionnaireResponse
Other representations of profile: CSV, Excel, Schematron