QuestionnaireResponse

Description

QuestionnaireResponse is represented in the Patient Finder as the categories form and form responses. The text in the answers will be pseudonymized. If a link to a Questionnaire is provided, the questions will be taken from there. This is not obligatory as the questions may also be provided in the QuestionnaireResponse. The preferred solution for Patient Finder is to have the questions in the QuestionnaireResponse. The linkId needs to be unique.

The QuestionnaireResponse mapping includes a reference to a department.

Instances

An example of a QuestionnaireResponse resource can be found here: QuestionnaireResponse Example 1

An example of the matching Questionnaire resource can be found here: Questionnaire Example 1

Profile

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
departmentS I0..1Extension(Reference(Organization))
specialismS I0..1Extension(Reference(Organization))
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueS Σ0..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
basedOnΣ0..*Reference(CarePlan | ServiceRequest)
partOfΣ0..*Reference(Observation | Procedure)
questionnaireS Σ0..1canonical(Questionnaire)
statusS Σ ?!1..1codeBinding
subjectS Σ0..1Reference(Patient)
encounterΣ0..1Reference(Encounter)
authoredS Σ0..1dateTime
authorS Σ0..1Reference(Practitioner)
sourceΣ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
linkIdS1..1string
definition0..1uri
textS0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
valueUriuri
valueAttachmentAttachment
valueReferenceReference(Resource)
valueDecimalS0..1decimal
valueIntegerS0..1integer
valueQuantityS0..1Quantity
valueDateS0..1date
valueDateTimeS0..1dateTime
valueTimeS0..1time
valueBooleanS0..1boolean
valueStringS0..1string
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
item0..*see (item)
item0..*see (item)
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="pf-questionnaire-response" />
    <url value="https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-questionnaire-response" />
    <name value="PatientFinderQuestionnaireResponse" />
    <title value="QuestionnaireResponse" />
    <status value="draft" />
    <description value="QuestionnaireResponse is represented in the Patient Finder as the categories form and form responses. The text in the answers will be pseudonymized. If a link to a Questionnaire is provided, the questions will be taken from there. This is not obligatory as the questions may also be provided in the QuestionnaireResponse. The preferred solution for Patient Finder is to have the questions in the QuestionnaireResponse. The linkId needs to be unique." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="fhir-patient-finder-mapping" />
        <name value="FHIR to Patient Finder Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="QuestionnaireResponse" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
    <derivation value="constraint" />
    <differential>
        <element id="QuestionnaireResponse.extension">
            <path value="QuestionnaireResponse.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.extension:department">
            <path value="QuestionnaireResponse.extension" />
            <sliceName value="department" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.iqvia.com/patientfinder/extension/department-organization" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="(Organization) department responsible for the registration of the form" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.extension:specialism">
            <path value="QuestionnaireResponse.extension" />
            <sliceName value="specialism" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.iqvia.com/patientfinder/extension/specialism-organization" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="(Organization) specialism responsible for the registration of the questionnaire" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.identifier">
            <path value="QuestionnaireResponse.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.identifier.value">
            <path value="QuestionnaireResponse.identifier.value" />
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form fact source id" />
            </mapping>
        </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" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.authored">
            <path value="QuestionnaireResponse.authored" />
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response start date" />
            </mapping>
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form start date" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.author">
            <path value="QuestionnaireResponse.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="(Practitioner) practitioner used for care provdider name" />
            </mapping>
        </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" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response question ID" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.text">
            <path value="QuestionnaireResponse.item.text" />
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response question" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <slicing>
                <discriminator>
                    <type value="type" />
                    <path value="$this" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueDecimal">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueDecimal" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="decimal" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response numeric answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueInteger">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueInteger" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="integer" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response numeric answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueQuantity">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueQuantity" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Quantity" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response numeric answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueDate">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueDate" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="date" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response date answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueDateTime">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueDateTime" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="dateTime" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response date answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueTime">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueTime" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="time" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response date answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueBoolean">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueBoolean" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="boolean" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response textual answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueString">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueString" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response textual answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueCoding">
            <path value="QuestionnaireResponse.item.answer.value[x]" />
            <sliceName value="valueCoding" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Coding" />
            </type>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueCoding.code">
            <path value="QuestionnaireResponse.item.answer.value[x].code" />
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response textual answer" />
            </mapping>
        </element>
        <element id="QuestionnaireResponse.item.answer.value[x]:valueCoding.display">
            <path value="QuestionnaireResponse.item.answer.value[x].display" />
            <mustSupport value="true" />
            <mapping>
                <identity value="fhir-patient-finder-mapping" />
                <map value="form response textual answer" />
            </mapping>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "pf-questionnaire-response",
    "url": "https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-questionnaire-response",
    "name": "PatientFinderQuestionnaireResponse",
    "title": "QuestionnaireResponse",
    "status": "draft",
    "description": "QuestionnaireResponse is represented in the Patient Finder as the categories form and form responses. The text in the answers will be pseudonymized. If a link to a Questionnaire is provided, the questions will be taken from there. This is not obligatory as the questions may also be provided in the QuestionnaireResponse. The preferred solution for Patient Finder is to have the questions in the QuestionnaireResponse. The linkId needs to be unique.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "fhir-patient-finder-mapping",
            "name": "FHIR to Patient Finder Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "QuestionnaireResponse",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "QuestionnaireResponse.extension",
                "path": "QuestionnaireResponse.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.extension:department",
                "path": "QuestionnaireResponse.extension",
                "sliceName": "department",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.iqvia.com/patientfinder/extension/department-organization"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "(Organization) department responsible for the registration of the form"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.extension:specialism",
                "path": "QuestionnaireResponse.extension",
                "sliceName": "specialism",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.iqvia.com/patientfinder/extension/specialism-organization"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "(Organization) specialism responsible for the registration of the questionnaire"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.identifier",
                "path": "QuestionnaireResponse.identifier",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.identifier.value",
                "path": "QuestionnaireResponse.identifier.value",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form fact source id"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.questionnaire",
                "path": "QuestionnaireResponse.questionnaire",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.status",
                "path": "QuestionnaireResponse.status",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.subject",
                "path": "QuestionnaireResponse.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.authored",
                "path": "QuestionnaireResponse.authored",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response start date"
                    },
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form start date"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.author",
                "path": "QuestionnaireResponse.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Practitioner"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "(Practitioner) practitioner used for care provdider name"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item",
                "path": "QuestionnaireResponse.item",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item.linkId",
                "path": "QuestionnaireResponse.item.linkId",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response question ID"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.text",
                "path": "QuestionnaireResponse.item.text",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response question"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueDecimal",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueDecimal",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "decimal"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response numeric answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueInteger",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueInteger",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "integer"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response numeric answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueQuantity",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueQuantity",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Quantity"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response numeric answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueDate",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueDate",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "date"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response date answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueDateTime",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueDateTime",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response date answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueTime",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueTime",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "time"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response date answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueBoolean",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueBoolean",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "boolean"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response textual answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueString",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueString",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response textual answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueCoding",
                "path": "QuestionnaireResponse.item.answer.value[x]",
                "sliceName": "valueCoding",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Coding"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueCoding.code",
                "path": "QuestionnaireResponse.item.answer.value[x].code",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response textual answer"
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.item.answer.value[x]:valueCoding.display",
                "path": "QuestionnaireResponse.item.answer.value[x].display",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "fhir-patient-finder-mapping",
                        "map": "form response textual answer"
                    }
                ]
            }
        ]
    }
}
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-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()
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())
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())
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())
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: 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: 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...1
TypeExtension
Must SupportTrue
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
QuestionnaireResponse.extension:department
DefinitionThe organization representing the department.
Cardinality0...1
TypeExtension(Reference(Organization))
Must SupportTrue
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.

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
  • fhir-patient-finder-mapping: (Organization) department responsible for the registration of the form
QuestionnaireResponse.extension:specialism
DefinitionThe organization representing the specialism.
Cardinality0...1
TypeExtension(Reference(Organization))
Must SupportTrue
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.

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
  • fhir-patient-finder-mapping: (Organization) specialism responsible for the registration of the questionnaire
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.

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
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
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: .id
QuestionnaireResponse.identifier.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.identifier.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
QuestionnaireResponse.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
QuestionnaireResponse.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
QuestionnaireResponse.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
QuestionnaireResponse.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
  • fhir-patient-finder-mapping: form fact source id
QuestionnaireResponse.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
QuestionnaireResponse.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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())
Mappings
  • 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
  • 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
  • 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(Patient)
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())
Mappings
  • 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())
Mappings
  • 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
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • rim: .participation[typeCode=AUT].time
  • fhir-patient-finder-mapping: form response start date
  • fhir-patient-finder-mapping: form start date
QuestionnaireResponse.author
DefinitionPerson who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
Cardinality0...1
TypeReference(Practitioner)
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())
Mappings
  • workflow: Event.performer
  • w5: FiveWs.author
  • rim: .participation[typeCode=AUT].role
  • fhir-patient-finder-mapping: (Practitioner) practitioner used for care provdider name
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())
Mappings
  • 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: .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.

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id
  • fhir-patient-finder-mapping: form response question 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: .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
Must SupportTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .text
  • fhir-patient-finder-mapping: form response question
QuestionnaireResponse.item.answer
DefinitionThe respondent's answer(s) to the question.
Cardinality0...*
TypeBackboneElement
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: .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.

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

SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
QuestionnaireResponse.item.answer.value[x]:valueDecimal
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typedecimal
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response numeric answer
QuestionnaireResponse.item.answer.value[x]:valueInteger
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typeinteger
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response numeric answer
QuestionnaireResponse.item.answer.value[x]:valueQuantity
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
TypeQuantity
Binding

Code indicating the response provided for a question.

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response numeric answer
QuestionnaireResponse.item.answer.value[x]:valueDate
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typedate
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response date answer
QuestionnaireResponse.item.answer.value[x]:valueDateTime
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
TypedateTime
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response date answer
QuestionnaireResponse.item.answer.value[x]:valueTime
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typetime
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response date answer
QuestionnaireResponse.item.answer.value[x]:valueBoolean
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typeboolean
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response textual answer
QuestionnaireResponse.item.answer.value[x]:valueString
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
Typestring
Binding

Code indicating the response provided for a question.

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .item
  • fhir-patient-finder-mapping: form response textual answer
QuestionnaireResponse.item.answer.value[x]:valueCoding
DefinitionThe answer (or one of the answers) provided by the respondent to the question.
Cardinality0...1
TypeCoding
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: .item
QuestionnaireResponse.item.answer.value[x]:valueCoding.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.value[x]:valueCoding.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
QuestionnaireResponse.item.answer.value[x]:valueCoding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
QuestionnaireResponse.item.answer.value[x]:valueCoding.version
DefinitionThe 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.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
QuestionnaireResponse.item.answer.value[x]:valueCoding.code
DefinitionA 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).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • fhir-patient-finder-mapping: form response textual answer
QuestionnaireResponse.item.answer.value[x]:valueCoding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • fhir-patient-finder-mapping: form response textual answer
QuestionnaireResponse.item.answer.value[x]:valueCoding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

Attribute list

Attribute Description Example
identifier.value The identifier of the questionnaire '12345a'
questionnaire A reference to the questionnaire '94518'
status The status of the response to the questionnaire 'completed'
extension:department A reference to the department that was responsible for the registration of the questionnaire 'Nuclear medicine'
extension:specialism A reference to the specialism that was responsible for the registration of the questionnaire 'Radiology'
subject A reference to the patient who answered the questions in the questionnaire
authored The startdate on which the question and answer are registered Format: YYYY-MM-DDThh:mm:ss+zz:zz
author (Practitioner) A reference to the person who recieved and recorder the answers to the questionnaire
item.linkId The unique identifier for the question '1.1'
item.text The question 'Do you have allergies?'
item.answer.value:valueDecimal The answer to the question if it is a decimal number '1.1'
item.answer.value:valueInteger The answer to the question if it is a number '1'
item.answer.value:valueQuantity The answer to the question if it is a quantity '1'
item.answer.value:valueDate The answer to the question if it is a date Format: YYYY-MM-DD
item.answer.value:valueDateTime The answer to the question if it is a datetime Format: YYYY-MM-DDThh:mm:ss+zz:zz
item.answer.value:valueTime The answer to the question if it is a time Format: hh:mm:ss+zz:zz
item.answer.value:valueBoolean The answer to the question if it is a boolean True
item.answer.value:valueString The answer to the question if it is a string 'Sometimes'
item.answer.value:valueCoding.code The answer to the question if it is the code for a codable concept 'LA6560-2'
item.answer.value:valueCoding.display The answer to the question if it is the display for a codable concept 'Confused'