CardinalKit Mobile Health Data FHIR Implementation Guide
1.0.0 - release
CardinalKit Mobile Health Data FHIR Implementation Guide
1.0.0 - release
CardinalKit Mobile Health Data FHIR Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: http://cardinalkit.org/fhir/StructureDefinition/ck-questionnaireresponse | Version: 1.0.0 | |||
| Active as of 2022-08-26 | Computable Name: CKQuestionnaireResponseProfile | |||
QuestionnaireResponse Profile used to represent survey results in CardinalKit applications
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from QuestionnaireResponse
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  QuestionnaireResponse | S | 0..* | QuestionnaireResponse | A structured set of questions and their answers |
  identifier | S | 1..1 | Identifier | Unique id for this set of answers |
| questionnaire | S | 1..1 | canonical(Questionnaire) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
| subject | S | 0..1 | Reference(Resource) | The subject of the questions |
| authored | S | 1..1 | dateTime | Date the answers were gathered |
 item | S | 1..* | BackboneElement | Groups and questions |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | S | 0..* | QuestionnaireResponse | A structured set of questions and their answers | ||||
 id | Σ | 0..1 | string | 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 | Identifier | Unique id for this set of answers | ||||
 basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
| partOf | Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
| questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject | SΣ | 0..1 | Reference(Resource) | The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
| author | Σ | 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 | SI | 1..* | BackboneElement | Groups and questions | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId | 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
| identifier | Σ | 1..1 | Identifier | Unique id for this set of answers |
| questionnaire | Σ | 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 | Σ | 0..1 | Reference(Resource) | The subject of the questions |
| authored | Σ | 1..1 | dateTime | Date the answers were gathered |
| item | I | 1..* | BackboneElement | Groups and questions |
| Documentation for this format | ||||
This structure is derived from QuestionnaireResponse
Differential View
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | S | 0..* | QuestionnaireResponse | A structured set of questions and their answers |
| identifier | S | 1..1 | Identifier | Unique id for this set of answers |
| questionnaire | S | 1..1 | canonical(Questionnaire) | Form being answered |
| status | S | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped |
| subject | S | 0..1 | Reference(Resource) | The subject of the questions |
| authored | S | 1..1 | dateTime | Date the answers were gathered |
| item | S | 1..* | BackboneElement | Groups and questions |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse | S | 0..* | QuestionnaireResponse | A structured set of questions and their answers | ||||
| id | Σ | 0..1 | string | 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 | Identifier | Unique id for this set of answers | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
| partOf | Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
| questionnaire | SΣ | 1..1 | canonical(Questionnaire) | Form being answered | ||||
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject | SΣ | 0..1 | Reference(Resource) | The subject of the questions | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
| author | Σ | 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 | SI | 1..* | BackboneElement | Groups and questions | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId | 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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| QuestionnaireResponse.language | preferred | CommonLanguages Max Binding: AllLanguages |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes |
| Id | Grade | Path | 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 | QuestionnaireResponse.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.questionnaire | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.authored | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qrs-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() | |
| ele-1 | error | QuestionnaireResponse.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.linkId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.answer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.answer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | QuestionnaireResponse.item.answer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | QuestionnaireResponse.item.answer.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.answer.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | QuestionnaireResponse.item.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |