2.7.0 - STU 3 (2nd ballot)

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

The official URL for this profile is: 

http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse

Scope and Usage

This profile sets expectations for use of the QuestionnaireResponse resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.

For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the QuestionnaireResponse resource. It means that servers SHALL be capable of persisting those elements and returning them in response to requests.

Boundaries and Relationships

This profile is related to the SDC Questionnaire Profile which defines the characteristic of a form "design". This profile focuses on the constraints appropriate to capturing the "answer(s)" to a pre-defined form.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire (no profile found)

Extensions

This structure refers to these extensions:

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*SDC Questionnaire Response
... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... identifier S0..1Identifier
... basedOn 0..*Reference(CarePlan | ServiceRequest)
... partOf 0..*Reference(Observation | Procedure)
... questionnaire S1..1canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire)
.... display S1..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
... status S1..1code
... subject S1..1Reference(Patient)
... encounter 0..1Reference(Encounter)
... authored S1..1dateTime
... author S0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
... item S0..*BackboneElement
.... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... linkId S1..1string
.... text S0..1string
.... answer S0..*BackboneElement
..... value[x] S0..1boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference()
..... valueCoding S0..1Coding
​...... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
..... item S0..*Unknown reference to #QuestionnaireResponse.item
.... item S0..*Unknown reference to #QuestionnaireResponse.item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse I0..*SDC Questionnaire Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... questionnaireresponse-signature I0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire)Form being answered
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... display SI1..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
.... value 0..1Primitive value for canonical
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required)
... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaireresponse-signature I0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer SI0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference()Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example)
..... value[x] S0..1CodingSingle-valued answer to the question
Binding: QuestionnaireAnswerCodes (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/ordinalValue"
....... valueDecimal 0..1decimalValue of extension
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... item S0..*Unknown reference to #QuestionnaireResponse.item
Nested groups and questions
.... item S0..*Unknown reference to #QuestionnaireResponse.item
Nested questionnaire response items

doco Documentation for this format

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 15 elements

Structures

This structure refers to these other structures:

  • unable to summarise profile http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire (no profile found)

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*SDC Questionnaire Response
... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... identifier S0..1Identifier
... basedOn 0..*Reference(CarePlan | ServiceRequest)
... partOf 0..*Reference(Observation | Procedure)
... questionnaire S1..1canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire)
.... display S1..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
... status S1..1code
... subject S1..1Reference(Patient)
... encounter 0..1Reference(Encounter)
... authored S1..1dateTime
... author S0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
... item S0..*BackboneElement
.... questionnaireresponse-signature 0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... linkId S1..1string
.... text S0..1string
.... answer S0..*BackboneElement
..... value[x] S0..1boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference()
..... valueCoding S0..1Coding
​...... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
..... item S0..*Unknown reference to #QuestionnaireResponse.item
.... item S0..*Unknown reference to #QuestionnaireResponse.item

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse I0..*SDC Questionnaire Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... questionnaireresponse-signature I0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire)Form being answered
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... display SI1..1stringDisplay name for canonical reference
URL: http://hl7.org/fhir/StructureDefinition/display
.... value 0..1Primitive value for canonical
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required)
... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaireresponse-signature I0..*SignatureA signature attesting to the content
URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer SI0..*BackboneElementThe response(s) to the question
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference()Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example)
..... value[x] S0..1CodingSingle-valued answer to the question
Binding: QuestionnaireAnswerCodes (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... ordinalValue 0..1decimalAssigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/ordinalValue"
....... valueDecimal 0..1decimalValue of extension
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... item S0..*Unknown reference to #QuestionnaireResponse.item
Nested groups and questions
.... item S0..*Unknown reference to #QuestionnaireResponse.item
Nested questionnaire response items

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4QuestionnaireResponseIf 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-3QuestionnaireResponseIf 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-6QuestionnaireResponseA resource should have narrative for robust management
: text.div.exists()
dom-5QuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1QuestionnaireResponse.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.questionnaire.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.questionnaire.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.questionnaire.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.questionnaire.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qrs-1QuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()
ele-1QuestionnaireResponse.item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.answerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())