StructureDefinition-UKCore-QuestionnaireResponse

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponsedraft1.2.02024-07-11

This profile defines the UK constraints and extensions on the International FHIR resource QuestionnaireResponse.


Profile_Purpose

This profile describes 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.

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierS Σ0..1Identifier
basedOnΣ I0..*Reference(CarePlan | ServiceRequest)
partOfΣ I0..*Reference(Observation | Procedure)
questionnaireS Σ0..1canonical(Questionnaire)
statusS Σ ?!1..1codeBinding
subjectS Σ I0..1Reference(Resource)
encounterΣ I0..1Reference(Encounter)
authoredS Σ0..1dateTime
authorS Σ I0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
sourceΣ I0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
linkIdS1..1string
definition0..1uri
text0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
valueBooleanboolean
valueDecimaldecimal
valueIntegerinteger
valueDatedate
valueDateTimedateTime
valueTimetime
valueStringstring
valueUriuri
valueAttachmentAttachment
valueCodingCoding
valueQuantityQuantity
valueReferenceReference(Resource)
item0..*see (item)
item0..*see (item)

Detailed Descriptions

QuestionnaireResponse
DefinitionA 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.
Cardinality0...*
AliasForm, 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
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Observation[moodCode=EVN]
QuestionnaireResponse.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
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.

QuestionnaireResponse.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
QuestionnaireResponse.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
QuestionnaireResponse.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
QuestionnaireResponse.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
QuestionnaireResponse.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
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.

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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.identifier
DefinitionA business identifier assigned to a particular completed (or partially completed) questionnaire.
Cardinality0...1
TypeIdentifier
Must SupportTrue
SummaryTrue
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())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: .id
QuestionnaireResponse.basedOn
DefinitionThe 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.
Cardinality0...*
TypeReference(CarePlan | ServiceRequest)
SummaryTrue
Aliasorder
Requirements

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

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.basedOn
  • rim: .outboundRelationship[typeCode=FLFS].target
QuestionnaireResponse.partOf
DefinitionA 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.
Cardinality0...*
TypeReference(Observation | Procedure)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.partOf
  • rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
QuestionnaireResponse.questionnaire
DefinitionThe Questionnaire that defines and organizes the questions for which answers are being provided.
Cardinality0...1
Typecanonical(Questionnaire)
Must SupportTrue
SummaryTrue
AliasForm
Requirements

Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original 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.).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.instantiates
  • rim: ./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]
QuestionnaireResponse.status
DefinitionThe position of the questionnaire response within its overall lifecycle.
Cardinality1...1
Typecode
Binding

Lifecycle status of the questionnaire response.

QuestionnaireResponseStatus (required)
Must SupportTrue
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • rim: .statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in-progress" from "published)
QuestionnaireResponse.subject
DefinitionThe 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.
Cardinality0...1
TypeReference(Resource)
Must SupportTrue
SummaryTrue
AliasPatient, Focus
Requirements

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

Comments

If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode=SBJ].role
  • w5: FiveWs.subject
QuestionnaireResponse.encounter
DefinitionThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
Cardinality0...1
TypeReference(Encounter)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.encounter
  • w5: FiveWs.context
  • rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
QuestionnaireResponse.authored
DefinitionThe date and/or time that this set of answers were last changed.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
AliasDate Created, Date published, Date Issued, Date updated
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.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • rim: .participation[typeCode=AUT].time
QuestionnaireResponse.author
DefinitionPerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
Cardinality0...1
TypeReference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
Must SupportTrue
SummaryTrue
AliasLaboratory, Service, Practitioner, Department, Company, Performer
Requirements

Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer
  • w5: FiveWs.author
  • rim: .participation[typeCode=AUT].role
QuestionnaireResponse.source
DefinitionThe person who answered the questions about the subject.
Cardinality0...1
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.source
  • rim: .participation[typeCode=INF].role
QuestionnaireResponse.item
DefinitionA group or question item from the original questionnaire for which answers are provided.
Cardinality0...*
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).

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()
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
QuestionnaireResponse.item.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
QuestionnaireResponse.item.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.item.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

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.

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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.item.linkId
DefinitionThe item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
Cardinality1...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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id
QuestionnaireResponse.item.definition
DefinitionA reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.
Cardinality0...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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code
QuestionnaireResponse.item.text
DefinitionText that is displayed above the contents of the group or as the text of the question being answered.
Cardinality0...1
Typestring
Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .text
QuestionnaireResponse.item.answer
DefinitionThe respondent's answer(s) to the question.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .value[type=LIST_ANY]
QuestionnaireResponse.item.answer.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
QuestionnaireResponse.item.answer.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.item.answer.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

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.

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()
Mappings
  • rim: n/a
  • rim: N/A
QuestionnaireResponse.item.answer.value[x]
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typeboolean
Binding

Code indicating the response provided for a question.

QuestionnaireAnswerCodes (example)
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .item
QuestionnaireResponse.item.answer.item
DefinitionNested groups and/or questions found within this particular answer.
Cardinality0...*
Typesee (item)
Requirements

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

Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
QuestionnaireResponse.item.item
DefinitionQuestions or sub-groups nested beneath a question or group.
Cardinality0...*
Typesee (item)
Requirements

Reports can consist of complex nested groups.

Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

Table View

QuestionnaireResponse..
QuestionnaireResponse.identifier..
QuestionnaireResponse.questionnaire..
QuestionnaireResponse.status..
QuestionnaireResponse.subject..
QuestionnaireResponse.authored..
QuestionnaireResponse.author..
QuestionnaireResponse.item..
QuestionnaireResponse.item.linkId..
QuestionnaireResponse.item.answer..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-QuestionnaireResponse" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" />
    <version value="1.2.0" />
    <name value="UKCoreQuestionnaireResponse" />
    <title value="UK Core Questionnaire Response" />
    <status value="draft" />
    <date value="2024-07-11" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [QuestionnaireResponse](https://hl7.org/fhir/R4/QuestionnaireResponse.html)." />
    <purpose value="This profile describes 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." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="QuestionnaireResponse" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
    <derivation value="constraint" />
    <differential>
        <element id="QuestionnaireResponse.identifier">
            <path value="QuestionnaireResponse.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.questionnaire">
            <path value="QuestionnaireResponse.questionnaire" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.status">
            <path value="QuestionnaireResponse.status" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.subject">
            <path value="QuestionnaireResponse.subject" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.authored">
            <path value="QuestionnaireResponse.authored" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.author">
            <path value="QuestionnaireResponse.author" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item">
            <path value="QuestionnaireResponse.item" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item.linkId">
            <path value="QuestionnaireResponse.item.linkId" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item.answer">
            <path value="QuestionnaireResponse.item.answer" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-QuestionnaireResponse",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse",
    "version": "1.2.0",
    "name": "UKCoreQuestionnaireResponse",
    "title": "UK Core Questionnaire Response",
    "status": "draft",
    "date": "2024-07-11",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [QuestionnaireResponse](https://hl7.org/fhir/R4/QuestionnaireResponse.html).",
    "purpose": "This profile describes 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.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "QuestionnaireResponse",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "QuestionnaireResponse.identifier",
                "path": "QuestionnaireResponse.identifier",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.questionnaire",
                "path": "QuestionnaireResponse.questionnaire",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.status",
                "path": "QuestionnaireResponse.status",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.subject",
                "path": "QuestionnaireResponse.subject",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.authored",
                "path": "QuestionnaireResponse.authored",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.author",
                "path": "QuestionnaireResponse.author",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item",
                "path": "QuestionnaireResponse.item",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item.linkId",
                "path": "QuestionnaireResponse.item.linkId",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item.answer",
                "path": "QuestionnaireResponse.item.answer",
                "mustSupport": true
            }
        ]
    }
}

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Feedback

Click here to:

Report issue for UKCore-QuestionnaireResponse, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

Baby Patient Survey - An example to illustrate a questionnaire response regarding a baby patient survey.
Example UKCore-QuestionnaireResponse-BabyPatientSurvey

End of Life Survey - An example to illustrate a questionnaire response regarding an end of life plan survey.
Example UKCore-QuestionnaireResponse-EOLPlan

Fitness For Work Survey - An example to illustrate a questionnaire response regarding a fitness for work survey.
Example UKCore-QuestionnaireResponse-FitnessForWork

Inpatient Survey Response - An example to illustrate a questionnaire response regarding an in-patient survey.
Example UKCore-QuestionnaireResponse-InpatientSurvey

Example Usage Scenarios

The following are example usage scenarios for the UK Core QuestionnaireResponse profile:

  • Query for details of a questionnaire response
  • Exchange questionnaire response information within a FHIR document or message.

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

Element Reason
QuestionnaireResponse.identifier Unique id for this set of answers.
QuestionnaireResponse.questionnaire The Questionnaire that defines and organizes the questions for which answers are being provided.
QuestionnaireResponse.status The position of the questionnaire response within its overall lifecycle.
QuestionnaireResponse.subject The subject of the questions.
QuestionnaireResponse.subject.display Plain text narrative that identifies the resource in addition to the resource reference.
QuestionnaireResponse.authored Date the answers were gathered.
QuestionnaireResponse.author Person who received and recorded the answers.
QuestionnaireResponse.item A group or question item from the original questionnaire for which answers are provided.
QuestionnaireResponse.item.linkId Pointer to specific item from Questionnaire.
QuestionnaireResponse.item.answer The response(s) to the question.

basedOn

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:


partOf

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:


questionnaire

Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Questionnaire.


subject

Where possible, it is expected that the resource being referenced SHOULD conform to the UK Core profile for that resource, if a profile exists.


encounter

Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.


author

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:


source

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles: