This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: QuestionnaireResponse - Detailed Descriptions

Definitions for the sdc-questionnaireresponse Profile.

1. QuestionnaireResponse
Definition

Sets expectations for supported capabilities for questionnaire responses for SDC-conformant systems.

Control0..*
Alternate NamesForm, QuestionnaireAnswers, Form Data
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.

InvariantsDefined on this element
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.

Control0..1
Typeid
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 might not always be associated with version changes to the resource.

Control0..1
TypeMeta
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
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.

5. QuestionnaireResponse.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
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 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.

Control0..1
TypeNarrative
Alternate Namesnarrative, 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 information 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.

Control0..*
TypeResource
Alternate Namesinline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. QuestionnaireResponse.extension
Definition

An Extension

Control0..*
TypeExtension
9. QuestionnaireResponse.extension:signature
Definition

Represents a wet or electronic signature for either the form overall or for the question or item it's associated with.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(signature) (Extension Type: Signature)
InvariantsDefined on this element
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())
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 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Must Supporttrue
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 ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

Control0..*
TypeReference(CarePlan | ServiceRequest)
Requirements

Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.

Alternate Namesorder
13. 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.

Control0..*
TypeReference(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.

Control1..1
Typecanonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire)
Must Supporttrue
Requirements

Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.

Alternate NamesForm
Comments

For SDC, this SHALL be the version-specific URL of the form as hosted on the Form Manager.

15. QuestionnaireResponse.questionnaire.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
16. QuestionnaireResponse.questionnaire.extension
Definition

An Extension

Control0..*
TypeExtension
17. QuestionnaireResponse.questionnaire.extension:questionnaireDisplay
Definition

The title or other name to display when referencing a resource by canonical URL.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(Display Name) (Extension Type: string)
Must Supporttrue
Comments

This SHALL be the title of the Questionnaire at the time the QuestionnaireResponse was originally authored.

InvariantsDefined on this element
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())
18. QuestionnaireResponse.questionnaire.value
Definition

Primitive value for canonical

Control0..1
19. QuestionnaireResponse.status
Definition

The position of the questionnaire response within its overall lifecycle.

Control1..1
BindingLifecycle status of the questionnaire response.
The codes SHALL be taken from QuestionnaireResponseStatus
Typecode
Is Modifiertrue
Must Supporttrue
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.

20. 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.

Control1..1
TypeReference(Patient)
Must Supporttrue
Requirements

Allows linking the answers to the individual the answers describe. May also affect access control.

Alternate NamesPatient, 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.

21. QuestionnaireResponse.encounter
Definition

The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

Control0..1
TypeReference(Encounter)
Requirements

Provides context for the information that was captured. May also affect access control.

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.

22. QuestionnaireResponse.authored
Definition

Identifies when this version of the answer set was created. Changes whenever the answers are updated.

Control1..1
TypedateTime
Must Supporttrue
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 NamesDate 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 might not know the value, however it SHOULD be populated if possible.

23. QuestionnaireResponse.author
Definition

Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

Control0..1
TypeReference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
Must Supporttrue
Requirements

Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.

Alternate NamesLaboratory, 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.

24. QuestionnaireResponse.source
Definition

The person who answered the questions about the subject.

Control0..1
TypeReference(Patient | Practitioner | PractitionerRole | 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.

25. QuestionnaireResponse.item
Definition

A group or question item from the original questionnaire for which answers are provided.

Control0..*
TypeBackboneElement
Must Supporttrue
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).

InvariantsDefined on this element
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())
26. 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.

Control0..1
Typestring
27. QuestionnaireResponse.item.extension
Definition

An Extension

Control0..*
TypeExtension
28. QuestionnaireResponse.item.extension:ItemSignature
Definition

Represents a wet or electronic signature for either the form overall or for the question or item it's associated with.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(signature) (Extension Type: Signature)
InvariantsDefined on this element
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())
29. 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 in which it is contained 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 can 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

30. QuestionnaireResponse.item.linkId
Definition

The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

Control1..1
Typestring
Must Supporttrue
Requirements

Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.

31. QuestionnaireResponse.item.definition
Definition

A reference to an ElementDefinition that provides the details for the item.

Control0..1
Typeuri
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, 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.

32. QuestionnaireResponse.item.text
Definition

Text that is displayed above the contents of the group or as the text of the question being answered.

Control0..1
Typestring
Must Supporttrue
Requirements

Allows the questionnaire response to be read without access to the questionnaire.

33. QuestionnaireResponse.item.answer
Definition

The respondent's answer(s) to the question.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

The value is nested because we cannot have a repeating structure that has variable type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. 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.

Control0..1
Typestring
35. QuestionnaireResponse.item.answer.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

36. 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 in which it is contained 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 can 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

37. QuestionnaireResponse.item.answer.value[x]
Definition

The answer (or one of the answers) provided by the respondent to the question.

Control0..1
BindingCode indicating the response provided for a question.
For example codes, see QuestionnaireAnswerCodes
TypeChoice of: boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
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. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.

38. QuestionnaireResponse.item.answer.value[x]
Definition

The answer (or one of the answers) provided by the respondent to the question.

Control0..1
BindingCode indicating the response provided for a question.
For example codes, see QuestionnaireAnswerCodes
TypeCoding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
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. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.

39. QuestionnaireResponse.item.answer.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
40. QuestionnaireResponse.item.answer.value[x].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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

41. QuestionnaireResponse.item.answer.value[x].extension:ordinalValue
Definition

A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores.

Control0..1
TypeExtension(Ordinal Value) (Extension Type: decimal)
Comments

Scores are commonly encountered in various clinical assessment scales. Assigning a value to a concept should generally be done in a formal code system that defines the value, or in an applicable value set for the concept, but some concepts do not have a formal definition (or are not even represented as a concept formally, especially in Questionnaires, so this extension is allowed to appear ouside those preferred contexts. Scores may even be assigned arbitrarily during use (hence, on Coding). The value may be constrained to an integer in some contexts of use. Todo: Scoring algorithms may also be defined directly, but how this is done is not yet defined.

42. QuestionnaireResponse.item.answer.value[x].extension:ordinalValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
43. QuestionnaireResponse.item.answer.value[x].extension:ordinalValue.extension
Definition

An Extension

Control0..0
TypeExtension
44. QuestionnaireResponse.item.answer.value[x].extension:ordinalValue.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/ordinalValue
45. QuestionnaireResponse.item.answer.value[x].extension:ordinalValue.valueDecimal
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typedecimal
46. QuestionnaireResponse.item.answer.value[x].system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

47. QuestionnaireResponse.item.answer.value[x].version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

48. QuestionnaireResponse.item.answer.value[x].code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Requirements

Need to refer to a particular code in the system.

49. QuestionnaireResponse.item.answer.value[x].display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

50. QuestionnaireResponse.item.answer.value[x].userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

51. QuestionnaireResponse.item.answer.item
Definition

Nested groups and/or questions found within this particular answer.

Control0..*
TypeSee QuestionnaireResponse.item
Must Supporttrue
Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.

52. QuestionnaireResponse.item.item
Definition

Questions or sub-groups nested beneath a question or group.

Control0..*
TypeSee QuestionnaireResponse.item
Must Supporttrue
Requirements

Reports can consist of complex nested groups.