NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. 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/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Resource Profile: PH_QuestionnaireResponse - Detailed Descriptions

Page standards status: Draft

Definitions for the PH-QuestionnaireResponse resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. QuestionnaireResponse
Definition | A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Short | A structured set of questions and their answers
Comments | The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Form, QuestionnaireAnswers
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. QuestionnaireResponse.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..01
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. QuestionnaireResponse.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..01
Binding | The codes SHOULD be taken from CommonLanguages http://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. QuestionnaireResponse.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..01
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. QuestionnaireResponse.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..0*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
10. QuestionnaireResponse.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. QuestionnaireResponse.modifierExtension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | ExtensionExtensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. QuestionnaireResponse.identifier
Definition | A business identifier assigned to a particular completed (or partially completed) questionnaire.
Short | Unique id for this set of answers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..01
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Used for tracking, registration and other business purposes.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. QuestionnaireResponse.basedOn
Definition | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
Short | Request fulfilled by this QuestionnaireResponse
Control | 0..0*
Type | Reference(CarePlan, ServiceRequest)
Is Modifier | false
Summary | true
Requirements | Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.
Alternate Names | order
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. QuestionnaireResponse.partOf
Definition | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
Short | Part of this action
Comments | Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.
Control | 0..0*
Type | Reference(Observation, Procedure)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. QuestionnaireResponse.questionnaire
Definition | The Questionnaire that defines and organizes the questions for which answers are being provided.
Short | Form being answered
Comments | If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).
Control | 0..01
Type | canonical(Questionnaire)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.
Alternate Names | Form
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. QuestionnaireResponse.status
Definition | The position of the questionnaire response within its overall lifecycle.
Short | in-progress | completed | amended | entered-in-error | stopped
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from QuestionnaireResponseStatus http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1` ) Lifecycle status of the questionnaire response.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. QuestionnaireResponse.subject
Definition | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
Short | The subject of the questions
Comments | If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.
Control | 0..01
Type | Reference(Resource)
Is Modifier | false
Summary | true
Requirements | Allows linking the answers to the individual the answers describe. May also affect access control.
Alternate Names | Patient, Focus
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. QuestionnaireResponse.encounter
Definition | The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
Short | Encounter created as part of
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.
Control | 0..01
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Requirements | Provides context for the information that was captured. May also affect access control.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. QuestionnaireResponse.authored
Definition | The date and/or time that this set of answers were last changed.
Short | Date the answers were gathered
Comments | May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.
Control | 0..01
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.
Alternate Names | Date Created, Date published, Date Issued, Date updated
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. QuestionnaireResponse.author
Definition | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
Short | Person who received and recorded the answers
Comments | Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.
Control | 0..01
Type | Reference(Device, Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | true
Requirements | Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.
Alternate Names | Laboratory, Service, Practitioner, Department, Company, Performer
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. QuestionnaireResponse.source
Definition | The person who answered the questions about the subject.
Short | The person who answered the questions
Comments | If not specified, no inference can be made about who provided the data.
Control | 0..01
Type | Reference(Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Summary | true
Requirements | When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. QuestionnaireResponse
2. QuestionnaireResponse.meta
4. QuestionnaireResponse.meta.extension:hfRecordedDate
Slice Name | hfRecordedDate
Control | 0..1
Type | Extension(The recorded date indicating when the record was uploaded by the health facility.) (Extension Type: dateTime)
6. QuestionnaireResponse.meta.extension:hfLastUpdated
Slice Name | hfLastUpdated
Control | 0..*
Type | Extension(The date indicating when the record was last updated by the health facility.) (Extension Type: dateTime)
8. QuestionnaireResponse.meta.lastUpdated
Short | When the resource was uploaded to the NHDR.
10. QuestionnaireResponse.implicitRules
Control | 0..0
12. QuestionnaireResponse.language
Control | 0..0
14. QuestionnaireResponse.text
Control | 0..0
16. QuestionnaireResponse.contained
Control | 0..0
18. QuestionnaireResponse.extension
Control | 0..0
20. QuestionnaireResponse.modifierExtension
Control | 0..0
22. QuestionnaireResponse.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
24. QuestionnaireResponse.basedOn
Control | 0..0
26. QuestionnaireResponse.partOf
Control | 0..0
28. QuestionnaireResponse.questionnaire
Control | 0..0
30. QuestionnaireResponse.subject
Control | 0..0
32. QuestionnaireResponse.encounter
Control | 0..0
34. QuestionnaireResponse.authored
Control | 0..0
36. QuestionnaireResponse.author
Control | 0..0
38. QuestionnaireResponse.source
Control | 0..0
40. QuestionnaireResponse.item
42. QuestionnaireResponse.item.id
Control | 0..0
44. QuestionnaireResponse.item.extension
Control | 0..0
46. QuestionnaireResponse.item.modifierExtension
Control | 0..0
48. QuestionnaireResponse.item.definition
Control | 0..0
50. QuestionnaireResponse.item.text
Control | 0..0
52. QuestionnaireResponse.item.answer
54. QuestionnaireResponse.item.answer.id
Control | 0..0
56. QuestionnaireResponse.item.answer.extension
Control | 0..0
58. QuestionnaireResponse.item.answer.modifierExtension
Control | 0..0
60. QuestionnaireResponse.item.answer.item
Control | 0..0
62. QuestionnaireResponse.item.item
Control | 0..0

Guidance on how to interpret the contents of this table can be foundhere

0. QuestionnaireResponse
Definition | A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Short | A structured set of questions and their answers
Comments | The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.
Control | 0..*
Is Modifier | false
Summary | false
Alternate Names | Form, QuestionnaireAnswers
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. QuestionnaireResponse.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. QuestionnaireResponse.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. QuestionnaireResponse.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. QuestionnaireResponse.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `QuestionnaireResponse.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. QuestionnaireResponse.meta.extension:hfRecordedDate
Slice Name | hfRecordedDate
Definition | The recorded date indicating when the record was uploaded by the health facility.
Short | The recorded date indicating when the record was uploaded by the health facility.
Control | 0..1
Type | Extension(The recorded date indicating when the record was uploaded by the health facility.) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
12. QuestionnaireResponse.meta.extension:hfLastUpdated
Slice Name | hfLastUpdated
Definition | The date indicating when the record was last updated by the health facility.
Short | The date indicating when the record was last updated by the health facility.
Control | 0..*
Type | Extension(The date indicating when the record was last updated by the health facility.) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
14. QuestionnaireResponse.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. QuestionnaireResponse.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource was uploaded to the NHDR.
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. QuestionnaireResponse.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. QuestionnaireResponse.meta.profile
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 0..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. QuestionnaireResponse.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. QuestionnaireResponse.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. QuestionnaireResponse.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..0
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. QuestionnaireResponse.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..0
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. QuestionnaireResponse.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..0
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. QuestionnaireResponse.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..0
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
34. QuestionnaireResponse.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
36. QuestionnaireResponse.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. QuestionnaireResponse.identifier
Definition | A business identifier assigned to a particular completed (or partially completed) questionnaire.
Short | Unique id for this set of answers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Used for tracking, registration and other business purposes.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. QuestionnaireResponse.basedOn
Definition | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
Short | Request fulfilled by this QuestionnaireResponse
Control | 0..0
Type | Reference(CarePlan, ServiceRequest)
Is Modifier | false
Summary | true
Requirements | Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.
Alternate Names | order
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. QuestionnaireResponse.partOf
Definition | A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
Short | Part of this action
Comments | Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.
Control | 0..0
Type | Reference(Observation, Procedure)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. QuestionnaireResponse.questionnaire
Definition | The Questionnaire that defines and organizes the questions for which answers are being provided.
Short | Form being answered
Comments | If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).
Control | 0..0
Type | canonical(Questionnaire)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.
Alternate Names | Form
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. QuestionnaireResponse.status
Definition | The position of the questionnaire response within its overall lifecycle.
Short | in-progress | completed | amended | entered-in-error | stopped
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from QuestionnaireResponseStatus (required to `http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1` ) Lifecycle status of the questionnaire response.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. QuestionnaireResponse.subject
Definition | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
Short | The subject of the questions
Comments | If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.
Control | 0..0
Type | Reference(Resource)
Is Modifier | false
Summary | true
Requirements | Allows linking the answers to the individual the answers describe. May also affect access control.
Alternate Names | Patient, Focus
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. QuestionnaireResponse.encounter
Definition | The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
Short | Encounter created as part of
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.
Control | 0..0
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Requirements | Provides context for the information that was captured. May also affect access control.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. QuestionnaireResponse.authored
Definition | The date and/or time that this set of answers were last changed.
Short | Date the answers were gathered
Comments | May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.
Control | 0..0
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.
Alternate Names | Date Created, Date published, Date Issued, Date updated
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. QuestionnaireResponse.author
Definition | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
Short | Person who received and recorded the answers
Comments | Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.
Control | 0..0
Type | Reference(Device, Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | true
Requirements | Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.
Alternate Names | Laboratory, Service, Practitioner, Department, Company, Performer
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. QuestionnaireResponse.source
Definition | The person who answered the questions about the subject.
Short | The person who answered the questions
Comments | If not specified, no inference can be made about who provided the data.
Control | 0..0
Type | Reference(Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Summary | true
Requirements | When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. QuestionnaireResponse.item
Definition | A group or question item from the original questionnaire for which answers are provided.
Short | Groups and questions
Comments | Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qrs-1: Nested item can't be beneath both item and answer (`(answer.exists() and item.exists()).not()`)
60. QuestionnaireResponse.item.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. QuestionnaireResponse.item.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
64. QuestionnaireResponse.item.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
66. QuestionnaireResponse.item.linkId
Definition | The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
Short | Pointer to specific item from Questionnaire
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. QuestionnaireResponse.item.definition
Definition | A reference to an ElementDefinition that provides the details for the item.
Short | ElementDefinition - details for the item
Comments | The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed.
Control | 0..0
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. QuestionnaireResponse.item.text
Definition | Text that is displayed above the contents of the group or as the text of the question being answered.
Short | Name for group or question text
Control | 0..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Allows the questionnaire response to be read without access to the questionnaire.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. QuestionnaireResponse.item.answer
Definition | The respondent's answer(s) to the question.
Short | The response(s) to the question
Comments | The value is nested because we cannot have a repeating structure that has variable type.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. QuestionnaireResponse.item.answer.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..0
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. QuestionnaireResponse.item.answer.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
78. QuestionnaireResponse.item.answer.modifierExtension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
80. QuestionnaireResponse.item.answer.value[x]
Definition | The answer (or one of the answers) provided by the respondent to the question.
Short | Single-valued answer to the question
Comments | More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.
Control | 0..1
Binding | For example codes, see QuestionnaireAnswerCodes (example to `http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1` ) Code indicating the response provided for a question.
Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Ability to retain a single-valued answer to a question.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. QuestionnaireResponse.item.answer.item
Definition | Nested groups and/or questions found within this particular answer.
Short | Nested groups and questions
Control | 0..0
Type | Seettp://hl7.org/fhir/StructureDefinition/QuestionnaireResponse#QuestionnaireResponse.item
Is Modifier | false
Summary | false
Requirements | It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. QuestionnaireResponse.item.item
Definition | Questions or sub-groups nested beneath a question or group.
Short | Nested questionnaire response items
Control | 0..0
Type | Seettp://hl7.org/fhir/StructureDefinition/QuestionnaireResponse#QuestionnaireResponse.item
Is Modifier | false
Summary | false
Requirements | Reports can consist of complex nested groups.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)