StructureDefinition-UKCore-Questionnaire

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire1.2.02022-12-16

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


Profile_Purpose

This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain.

urlΣ0..1uri
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
versionΣ0..1string
nameΣ I0..1string
titleΣ0..1string
derivedFrom0..*canonical(UK Core Questionnaire)
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
subjectTypeΣ0..*codeBinding
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
description0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
codeΣ0..*CodingBinding
linkId1..1string
definition0..1uri
codeI0..*Coding
prefix0..1string
text0..1string
type1..1codeBinding
question1..1string
operator1..1codeBinding
answerBooleanboolean
answerDecimaldecimal
answerIntegerinteger
answerDatedate
answerDateTimedateTime
answerTimetime
answerStringstring
answerCodingCoding
answerQuantityQuantity
answerReferenceReference(Resource)
enableBehaviorI0..1codeBinding
requiredI0..1boolean
repeatsI0..1boolean
readOnlyI0..1boolean
maxLengthI0..1integer
answerValueSetI0..1canonical(ValueSet)
valueIntegerinteger
valueDatedate
valueTimetime
valueStringstring
valueCodingCoding
valueReferenceReference(Resource)
initialSelected0..1boolean
valueBooleanboolean
valueDecimaldecimal
valueIntegerinteger
valueDatedate
valueDateTimedateTime
valueTimetime
valueStringstring
valueUriuri
valueAttachmentAttachment
valueCodingCoding
valueQuantityQuantity
valueReferenceReference(Resource)
itemI0..*see (item)

Table View

Questionnaire..
Questionnaire.identifier..
Questionnaire.identifier.assignerReference(UK Core Organization)..
Questionnaire.derivedFromcanonical(UK Core Questionnaire)..
Questionnaire.code..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Questionnaire" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" />
    <version value="1.2.0" />
    <name value="UKCoreQuestionnaire" />
    <title value="UK Core Questionnaire" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Questionnaire](https://hl7.org/fhir/R4/Questionnaire.html)." />
    <purpose value="This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain." />
    <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>
    <mapping>
        <identity value="objimpl" />
        <uri value="http://hl7.org/fhir/object-implementation" />
        <name value="Object Implementation Information" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Questionnaire" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Questionnaire" />
    <derivation value="constraint" />
    <differential>
        <element id="Questionnaire.identifier.assigner">
            <path value="Questionnaire.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Questionnaire.derivedFrom">
            <path value="Questionnaire.derivedFrom" />
            <type>
                <code value="canonical" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" />
            </type>
        </element>
        <element id="Questionnaire.code">
            <path value="Questionnaire.code" />
            <binding>
                <strength value="preferred" />
                <description value="A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-QuestionnaireQuestionCodes" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Questionnaire",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire",
    "version": "1.2.0",
    "name": "UKCoreQuestionnaire",
    "title": "UK Core Questionnaire",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Questionnaire](https://hl7.org/fhir/R4/Questionnaire.html).",
    "purpose": "This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain.",
    "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"
        },
        {
            "identity": "objimpl",
            "uri": "http://hl7.org/fhir/object-implementation",
            "name": "Object Implementation Information"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Questionnaire",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Questionnaire",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Questionnaire.identifier.assigner",
                "path": "Questionnaire.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Questionnaire.derivedFrom",
                "path": "Questionnaire.derivedFrom",
                "type":  [
                    {
                        "code": "canonical",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire"
                        ]
                    }
                ]
            },
            {
                "id": "Questionnaire.code",
                "path": "Questionnaire.code",
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-QuestionnaireQuestionCodes"
                }
            }
        ]
    }
}

Examples

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

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:
idtargetProfile
UKCore-FamilyMemberHistoryhttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; http://hl7.org/fhir/StructureDefinition/PlanDefinition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire; http://hl7.org/fhir/StructureDefinition/ActivityDefinition; http://hl7.org/fhir/StructureDefinition/Measure; http://hl7.org/fhir/StructureDefinition/OperationDefinition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance; https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-Procedurehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; http://hl7.org/fhir/StructureDefinition/PlanDefinition; http://hl7.org/fhir/StructureDefinition/ActivityDefinition; http://hl7.org/fhir/StructureDefinition/Measure; http://hl7.org/fhir/StructureDefinition/OperationDefinition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire; https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan; https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; http://hl7.org/fhir/StructureDefinition/Group; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; 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-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; http://hl7.org/fhir/StructureDefinition/Substance; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-Questionnairehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire
UKCore-QuestionnaireResponsehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan; https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; 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; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; 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; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization

Example Usage Scenarios

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

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

Profile Specific Implementation Guidance:

Minimum Viable Content

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

Element Reason
Questionnaire.url Canonical identifier for this questionnaire, represented as a URI (globally unique).
Questionnaire.title Name for this questionnaire (human friendly).
Questionnaire.status The status of this questionnaire. Enables tracking the life-cycle of the content.
Questionnaire.subjectType Resource that can be subject of QuestionnaireResponse.
Questionnaire.item Questions and sections within the Questionnaire.
Questionnaire.item.linkId Unique id for item in questionnaire.
Questionnaire.item.text The text of a question.
Questionnaire.item.type Defines the format in which the user is to be prompted for the answer.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
Questionnaire.code Preferred ValueSet UKCore-QuestionnaireQuestionCodes

derivedFrom

The definition resource being referenced SHALL conform to the Profile UKCore-Questionnaire.