UK Core Implementation Guide 0.5.0 - STU1

StructureDefinition-UKCore-QuestionnaireResponse

Defines the UK Core constraints and extensions on the QuestionnaireResponse resource for the minimal set of data to query and retrieve a complete or partial list of answers to a set of questions completed when responding to a questionnaire.

Profile Purpose

This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
questionnaireΣ0..1canonical(UK Core Questionnaire)
statusΣ ?!1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authoredΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
linkId1..1string
definition0..1uri
text0..1string
valueBooleanboolean
valueDecimaldecimal
valueIntegerinteger
valueDatedate
valueDateTimedateTime
valueTimetime
valueStringstring
valueUriuri
valueAttachmentAttachment
valueCodingCoding
valueQuantityQuantity
valueReferenceReference(Resource)
item0..*see (item)
item0..*see (item)

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
questionnaireΣ0..1canonical(UK Core Questionnaire)
statusΣ ?!1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authoredΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
linkId1..1string
definition0..1uri
text0..1string
valueBooleanboolean
valueDecimaldecimal
valueIntegerinteger
valueDatedate
valueDateTimedateTime
valueTimetime
valueStringstring
valueUriuri
valueAttachmentAttachment
valueCodingCoding
valueQuantityQuantity
valueReferenceReference(Resource)
item0..*see (item)
item0..*see (item)

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
questionnaireΣ0..1canonical(UK Core Questionnaire)
statusΣ ?!1..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authoredΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
linkId1..1string
definition0..1uri
text0..1string
valueBooleanboolean
valueDecimaldecimal
valueIntegerinteger
valueDatedate
valueDateTimedateTime
valueTimetime
valueStringstring
valueUriuri
valueAttachmentAttachment
valueCodingCoding
valueQuantityQuantity
valueReferenceReference(Resource)
item0..*see (item)
item0..*see (item)

Table View

QuestionnaireResponse..
QuestionnaireResponse.identifier..
QuestionnaireResponse.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.basedOnReference(UK Core CarePlan | UK Core ServiceRequest)..
QuestionnaireResponse.basedOn.identifier..
QuestionnaireResponse.basedOn.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.partOfReference(UK Core Observation | UK Core Procedure)..
QuestionnaireResponse.partOf.identifier..
QuestionnaireResponse.partOf.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.questionnairecanonical(UK Core Questionnaire)..
QuestionnaireResponse.subject..
QuestionnaireResponse.subject.identifier..
QuestionnaireResponse.subject.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.encounterReference(UK Core Encounter)..
QuestionnaireResponse.encounter.identifier..
QuestionnaireResponse.encounter.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.authorReference(UK Core Organization | UK Core Patient | UK Core Device | UK Core Practitioner | UK Core RelatedPerson | UK Core PractitionerRole)..
QuestionnaireResponse.author.identifier..
QuestionnaireResponse.author.identifier.assignerReference(UK Core Organization)..
QuestionnaireResponse.sourceReference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient)..
QuestionnaireResponse.source.identifier..
QuestionnaireResponse.source.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-QuestionnaireResponse" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" />
    <version value="1.1.0" />
    <name value="UKCoreQuestionnaireResponse" />
    <title value="UK Core QuestionnaireResponse" />
    <status value="active" />
    <date value="2022-05-20" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the QuestionnaireResponse resource for the minimal set of data to query and retrieve a complete or partial list of answers to a set of questions completed when responding to a questionnaire." />
    <purpose value="This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern 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.identifier.assigner">
            <path value="QuestionnaireResponse.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.basedOn">
            <path value="QuestionnaireResponse.basedOn" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest" />
            </type>
        </element>
        <element id="QuestionnaireResponse.basedOn.identifier.assigner">
            <path value="QuestionnaireResponse.basedOn.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.partOf">
            <path value="QuestionnaireResponse.partOf" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure" />
            </type>
        </element>
        <element id="QuestionnaireResponse.partOf.identifier.assigner">
            <path value="QuestionnaireResponse.partOf.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.questionnaire">
            <path value="QuestionnaireResponse.questionnaire" />
            <type>
                <code value="canonical" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" />
            </type>
        </element>
        <element id="QuestionnaireResponse.subject.identifier.assigner">
            <path value="QuestionnaireResponse.subject.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.encounter">
            <path value="QuestionnaireResponse.encounter" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
            </type>
        </element>
        <element id="QuestionnaireResponse.encounter.identifier.assigner">
            <path value="QuestionnaireResponse.encounter.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.author">
            <path value="QuestionnaireResponse.author" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="QuestionnaireResponse.author.identifier.assigner">
            <path value="QuestionnaireResponse.author.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="QuestionnaireResponse.source">
            <path value="QuestionnaireResponse.source" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="QuestionnaireResponse.source.identifier.assigner">
            <path value="QuestionnaireResponse.source.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-QuestionnaireResponse",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse",
    "version": "1.1.0",
    "name": "UKCoreQuestionnaireResponse",
    "title": "UK Core QuestionnaireResponse",
    "status": "active",
    "date": "2022-05-20",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the QuestionnaireResponse resource for the minimal set of data to query and retrieve a complete or partial list of answers to a set of questions completed when responding to a questionnaire.",
    "purpose": "This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "QuestionnaireResponse",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "QuestionnaireResponse.identifier.assigner",
                "path": "QuestionnaireResponse.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.basedOn",
                "path": "QuestionnaireResponse.basedOn",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.basedOn.identifier.assigner",
                "path": "QuestionnaireResponse.basedOn.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.partOf",
                "path": "QuestionnaireResponse.partOf",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.partOf.identifier.assigner",
                "path": "QuestionnaireResponse.partOf.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.questionnaire",
                "path": "QuestionnaireResponse.questionnaire",
                "type":  [
                    {
                        "code": "canonical",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.subject.identifier.assigner",
                "path": "QuestionnaireResponse.subject.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.encounter",
                "path": "QuestionnaireResponse.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.encounter.identifier.assigner",
                "path": "QuestionnaireResponse.encounter.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.author",
                "path": "QuestionnaireResponse.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.author.identifier.assigner",
                "path": "QuestionnaireResponse.author.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.source",
                "path": "QuestionnaireResponse.source",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "QuestionnaireResponse.source.identifier.assigner",
                "path": "QuestionnaireResponse.source.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Example Usage Scenarios

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

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

Profile specific implementation guidance:

identifier

A business identifier assigned to a particular completed (or partially completed) questionnaire.

Provider Systems

It is recommended that the identifier value is a Universally Unique Identifier (UUID) as there is no nationally recognised business identifier for an instance of a recorded Appointment.

Consumer Systems

Consumer systems MUST consume this data.


basedOn

The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse.

The resource being referenced should conform to one of the following:


partOf

A procedure or observation that this questionnaire was performed as part of the execution of.

The resource being referenced should conform to one of the following:


questionnaire

The Questionnaire that defines and organizes the questions for which answers are being provided.

The definition resource being referenced should conform to the following:


status

The position of the questionnaire response within its overall lifecycle.

This element MUST be present and use a value from the CodeSystem below:

HTML View

This code system http://hl7.org/fhir/questionnaire-answers-status defines the following codes:

CodeDisplayDefinition
in-progressIn ProgressThis QuestionnaireResponse has been partially filled out with answers but changes or additions are still expected to be made to it.
completedCompletedThis QuestionnaireResponse has been filled out with answers and the current content is regarded as definitive.
amendedAmendedThis QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards.
entered-in-errorEntered in ErrorThis QuestionnaireResponse was entered in error and voided.
stoppedStoppedThis QuestionnaireResponse has been partially filled out with answers but has been abandoned. It is unknown whether changes or additions are expected to be made to it.

Table View

CodeSystem.id[0]questionnaire-answers-status
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]fhir
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]3
CodeSystem.url[0]http://hl7.org/fhir/questionnaire-answers-status
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.448
CodeSystem.version[0]4.0.1
CodeSystem.name[0]QuestionnaireResponseStatus
CodeSystem.title[0]QuestionnaireResponseStatus
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]Lifecycle status of the questionnaire response.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/questionnaire-answers-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]in-progress
CodeSystem.concept[0].display[0]In Progress
CodeSystem.concept[0].definition[0]This QuestionnaireResponse has been partially filled out with answers but changes or additions are still expected to be made to it.
CodeSystem.concept[1].code[0]completed
CodeSystem.concept[1].display[0]Completed
CodeSystem.concept[1].definition[0]This QuestionnaireResponse has been filled out with answers and the current content is regarded as definitive.
CodeSystem.concept[2].code[0]amended
CodeSystem.concept[2].display[0]Amended
CodeSystem.concept[2].definition[0]This QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards.
CodeSystem.concept[3].code[0]entered-in-error
CodeSystem.concept[3].display[0]Entered in Error
CodeSystem.concept[3].definition[0]This QuestionnaireResponse was entered in error and voided.
CodeSystem.concept[4].code[0]stopped
CodeSystem.concept[4].display[0]Stopped
CodeSystem.concept[4].definition[0]This QuestionnaireResponse has been partially filled out with answers but has been abandoned. It is unknown whether changes or additions are expected to be made to it.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="questionnaire-answers-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://hl7.org/fhir/questionnaire-answers-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.448" />
    </identifier>
    <version value="4.0.1" />
    <name value="QuestionnaireResponseStatus" />
    <title value="QuestionnaireResponseStatus" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="Lifecycle status of the questionnaire response." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/questionnaire-answers-status" />
    <content value="complete" />
    <concept>
        <code value="in-progress" />
        <display value="In Progress" />
        <definition value="This QuestionnaireResponse has been partially filled out with answers but changes or additions are still expected to be made to it." />
    </concept>
    <concept>
        <code value="completed" />
        <display value="Completed" />
        <definition value="This QuestionnaireResponse has been filled out with answers and the current content is regarded as definitive." />
    </concept>
    <concept>
        <code value="amended" />
        <display value="Amended" />
        <definition value="This QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards." />
    </concept>
    <concept>
        <code value="entered-in-error" />
        <display value="Entered in Error" />
        <definition value="This QuestionnaireResponse was entered in error and voided." />
    </concept>
    <concept>
        <code value="stopped" />
        <display value="Stopped" />
        <definition value="This QuestionnaireResponse has been partially filled out with answers but has been abandoned. It is unknown whether changes or additions are expected to be made to it." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "questionnaire-answers-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "fhir"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://hl7.org/fhir/questionnaire-answers-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.448"
        }
    ],
    "version": "4.0.1",
    "name": "QuestionnaireResponseStatus",
    "title": "QuestionnaireResponseStatus",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "Lifecycle status of the questionnaire response.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/questionnaire-answers-status",
    "content": "complete",
    "concept":  [
        {
            "code": "in-progress",
            "display": "In Progress",
            "definition": "This QuestionnaireResponse has been partially filled out with answers but changes or additions are still expected to be made to it."
        },
        {
            "code": "completed",
            "display": "Completed",
            "definition": "This QuestionnaireResponse has been filled out with answers and the current content is regarded as definitive."
        },
        {
            "code": "amended",
            "display": "Amended",
            "definition": "This QuestionnaireResponse has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards."
        },
        {
            "code": "entered-in-error",
            "display": "Entered in Error",
            "definition": "This QuestionnaireResponse was entered in error and voided."
        },
        {
            "code": "stopped",
            "display": "Stopped",
            "definition": "This QuestionnaireResponse has been partially filled out with answers but has been abandoned. It is unknown whether changes or additions are expected to be made to it."
        }
    ]
}

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.


subject

The subject of the questionnaire response.

Reference to any FHIR resource. Where a UK Core profile exists the resource being referenced should conform to the profile.


encounter

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

The resource being referenced should conform to the following:


authored

The date and/or time that this set of answers were last changed.


author

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

The resource being referenced should conform to one of the following:


source

The person who answered the questions about the subject.

The resource being referenced should conform to one of the following:


item

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

item.linkId

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

item.definition

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

item.text

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

item.answer

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

  • item.answer.value[x] Optional answer (or one of the answers) provided by the respondent to the question.
  • item.answer.item Optional nested groups and/or questions found within this particular answer.

item.item

Text, questions and other groups to be nested beneath a question or group.


back to top