Definitions for the ehealth-questionnaireresponse Profile.
1. 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. |
Control | 0..* |
Alternate Names | Form, QuestionnaireAnswers |
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. |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
2. QuestionnaireResponse.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
3. QuestionnaireResponse.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
4. 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
5. QuestionnaireResponse.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable Max Binding: All Languages |
Type | code |
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). |
6. QuestionnaireResponse.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
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 in formation is added later. |
7. 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained 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. |
8. QuestionnaireResponse.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on QuestionnaireResponse.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. QuestionnaireResponse.extension:quality | |
SliceName | quality |
Definition | The minimum requirements for qualities |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(quality) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. QuestionnaireResponse.modifierExtension | |
Definition | 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
11. QuestionnaireResponse.identifier | |
Definition | A business identifier assigned to a particular completed (or partially completed) questionnaire. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Requirements | Used for tracking, registration and other business purposes. |
12. QuestionnaireResponse.basedOn | |
Definition | The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. |
Control | 1..1 |
Type | Reference(ehealth-procedurerequest) |
Requirements | Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon. |
Alternate Names | order |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Request fulfilled by this QuestionnaireResponse. |
13. QuestionnaireResponse.parent | |
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. |
Control | 0..1 |
Type | Reference(ehealth-observation | Procedure) |
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. |
14. QuestionnaireResponse.questionnaire | |
Definition | The Questionnaire that defines and organizes the questions for which answers are being provided. |
Control | 1..1 |
Type | Reference(ehealth-questionnaire) |
Requirements | Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form. |
Alternate Names | Form |
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.). |
15. QuestionnaireResponse.status | |
Definition | The position of the questionnaire response within its overall lifecycle. |
Control | 1..1 |
Binding | Lifecycle status of the questionnaire response. The codes SHALL be taken from QuestionnaireResponseStatus |
Type | code |
Is Modifier | true |
Requirements | The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
16. 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. |
Control | 1..1 |
Type | Reference(Resource) |
Requirements | Allows linking the answers to the individual the answers describe. May also affect access control. |
Alternate Names | Patient, Focus |
Comments | If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types. |
17. QuestionnaireResponse.context | |
Definition | The encounter or episode of care with primary association to the questionnaire response. |
Control | 1..1 |
Type | Reference(Encounter | ehealth-episodeofcare) |
Requirements | Provides context for the information that was captured. May also affect access control. |
Comments | A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter. |
18. QuestionnaireResponse.authored | |
Definition | The date and/or time that this set of answers were last changed. |
Control | 1..1 |
Type | dateTime |
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 |
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 may not know the value, however it SHOULD be populated if possible. |
19. QuestionnaireResponse.author | |
Definition | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
Control | 0..1 |
Type | Reference(ehealth-device | ehealth-practitioner | ehealth-patient | ehealth-relatedperson) |
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 |
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. |
20. QuestionnaireResponse.source | |
Definition | The person who answered the questions about the subject. |
Control | 1..1 |
Type | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson) |
Requirements | When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions. |
Comments | If not specified, no inference can be made about who provided the data. |
21. QuestionnaireResponse.item | |
Definition | A group or question item from the original questionnaire for which answers are provided. |
Control | 0..* |
Type | BackboneElement |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) qrs-1: Nested item can't be beneath both item and answer (: (answer.exists() and item.exists()).not()) |
22. 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. |
Control | 0..1 |
Type | string |
23. QuestionnaireResponse.item.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
24. QuestionnaireResponse.item.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
25. QuestionnaireResponse.item.linkId | |
Definition | The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. |
Control | 1..1 |
Type | string |
Requirements | Items can repeat in the answers, so a direct 1..1 correspondence by position may not exist - requiring correspondence by identifier. |
26. QuestionnaireResponse.item.definition | |
Definition | A reference to an ElementDefinition that provides the details for the item. |
Control | 0..1 |
Type | uri |
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. |
Comments | The ElementDefinition must be in a StructureDefinition or a DataElement, 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. |
27. QuestionnaireResponse.item.text | |
Definition | Text that is displayed above the contents of the group or as the text of the question being answered. |
Control | 0..1 |
Type | string |
Requirements | Allows the questionnaire response to be read without access to the questionnaire. |
28. QuestionnaireResponse.item.subject | |
Definition | More specific subject this section's answers are about, details the subject given in QuestionnaireResponse. |
Control | 0..1 |
Type | Reference(Resource) |
Requirements | Sometimes a group of answers is about a specific participant, artifact or piece of information in the patient's care or record, e.g. a specific Problem, RelatedPerson, Allergy etc. |
29. QuestionnaireResponse.item.answer | |
Definition | The respondent's answer(s) to the question. |
Control | 0..* |
Type | BackboneElement |
Comments | The value is nested because we cannot have a repeating structure that has variable type. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
30. 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. |
Control | 0..1 |
Type | string |
31. QuestionnaireResponse.item.answer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
32. QuestionnaireResponse.item.answer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
33. QuestionnaireResponse.item.answer.value[x] | |
Definition | The answer (or one of the answers) provided by the respondent to the question. |
Control | 0..1 |
Binding | Code indicating the response provided for a question. For example codes, see Questionnaire Answer Codes |
Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Ability to retain a single-valued answer to a 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. |
34. QuestionnaireResponse.item.answer.item | |
Definition | Nested groups and/or questions found within this particular answer. |
Control | 0..* |
Type | See QuestionnaireResponse.item |
Requirements | It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. |
Comments | Nested questionnaire response items. Answers shall be provided in accordance with the questionnaire. Questionnaires, however, formed using nested items are likely to produce questionnaire responses that cannot be transformed to Clinical Document Architecture (CDA) counterparts without loss. |
35. QuestionnaireResponse.item.item | |
Definition | Questions or sub-groups nested beneath a question or group. |
Control | 0..* |
Type | See QuestionnaireResponse.item |
Requirements | Reports can consist of complex nested groups. |
Comments | Nested groups and questions. Answers shall be provided in accordance with the questionnaire. Questionnaires, however, formed using nested items are likely to produce questionnaire responses that cannot be transformed to Clinical Document Architecture (CDA) counterparts without loss. |