This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the sdc-response Profile.
QuestionnaireResponse(SDC-Response) | |
Definition | Sets expectations for supported capabilities for questionnaire responses for SDC-conformant systems. |
Control | 0..* |
Type | QuestionnaireResponse |
Alternate Names | Form, Form Data |
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. Bundles always have an id, though it is usually a generated UUID. |
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 |
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 as much as possible. |
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 http://tools.ietf.org/html/bcp47 |
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). |
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. |
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. |
QuestionnaireResponse.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
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. |
QuestionnaireResponse.identifier | |
Definition | A business identifier assigned to a particular completed (or partially completed) questionnaire. |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Requirements | Used for tracking, registration and other business purposes. |
QuestionnaireResponse.questionnaire | |
Definition | Indicates the Questionnaire resource that defines the form for which answers are being provided. |
Control | 1..1 |
Type | Reference(Structured Data Capture Questionnaire Design) |
Must Support | true |
Requirements | Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form. |
Alternate Names | Form |
QuestionnaireResponse.status | |
Definition | The lifecycle status of the questionnaire response as a whole. |
Control | 1..1 |
Binding | Lifecycle status of the questionnaire response. The codes SHALL be taken from QuestionnaireResponseStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. Questionnaire resources with just questions may serve as template forms, with the applicable publication statuses. |
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(Patient) |
Must Support | true |
Requirements | The subject context must be known. |
Alternate Names | Patient, Focus |
QuestionnaireResponse.author | |
Definition | Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. |
Control | 0..1 |
Type | Choice of: Reference(Device), Reference(Practitioner), Reference(Patient), Reference(RelatedPerson) |
Must Support | 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 |
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. |
QuestionnaireResponse.authored | |
Definition | Identifies when this version of the answer set was created. Changes whenever the answers are updated. |
Control | 1..1 |
Type | dateTime |
Must Support | 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 |
Comments | May be different from the update time of the resource itself, because that is the status of the collection and authoring. This element is optional to allow for systems that may not know the value, however it SHOULD be populated if possible. |
QuestionnaireResponse.source | |
Definition | The person who answered the questions about the subject. |
Control | 0..1 |
Type | Choice of: Reference(Patient), Reference(Practitioner), Reference(RelatedPerson) |
Requirements | When answering questions about a subject that is minor, incapable of answering or an animal, another human source is used to answer the questions. |
Comments | If not specified, no inference can be made about who provided the data. |
QuestionnaireResponse.encounter | |
Definition | Encounter during which this set of questionnaire response were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers. |
Control | 0..1 |
Type | Reference(Encounter) |
Requirements | Some institutions track questionnaires under a specific encounter. |
QuestionnaireResponse.item(item) | |
Definition | Corresponds to a group or question item from the original questionnaire. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
QuestionnaireResponse.item.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
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. |
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. |
QuestionnaireResponse.item.linkId | |
Definition | Identifies the item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Items can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by identifier. |
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 |
Must Support | true |
Requirements | Allows the questionnaire response to be read without access to the questionnaire. |
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. |
QuestionnaireResponse.item.answer | |
Definition | The respondent's answer(s) to the question. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Comments | The value is nested because we cannot have a repeating structure that has variable type. |
QuestionnaireResponse.item.answer.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
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. |
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. |
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. |
Type | Choice of: boolean, date, dateTime, time, instant, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
QuestionnaireResponse.item.answer.item | |
Definition | Nested groups and/or questions found within this particular answer. |
Control | 0..* |
Type | See item |
Requirements | It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. |
QuestionnaireResponse.item.item | |
Definition | Questions or sub-groups nested beneath a question or group. |
Control | 0..* |
Type | See item |
Must Support | true |
Requirements | Reports can consist of complex nested groups. |