UK Core Implementation Guide 0.5.0 - STU1

StructureDefinition-UKCore-Questionnaire

Defines the UK Core constraints and extensions on the Questionnaire resource for the minimal set of data to query and retrieve questionnaire information.

Profile Purpose

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

Snapshot View

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)

Differential View

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)

Hybrid View

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.1.0" />
    <name value="UKCoreQuestionnaire" />
    <title value="UK Core Questionnaire" />
    <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 Questionnaire resource for the minimal set of data to query and retrieve the questionnaire information." />
    <purpose value="This profile is used to organize 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.1.0",
    "name": "UKCoreQuestionnaire",
    "title": "UK Core Questionnaire",
    "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 Questionnaire resource for the minimal set of data to query and retrieve the questionnaire information.",
    "purpose": "This profile is used to organize 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"
                }
            }
        ]
    }
}

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:

url

An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.


identifier

A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.

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.


version

A business identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance.


name

A natural language name identifying the questionnaire.


title

A short, descriptive, user-friendly title for the questionnaire.


derivedFrom

The URL of a Questionnaire that this Questionnaire is based on.

The definition resource being referenced should conform to the following:


status

The status of this questionnaire.

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

HTML View

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

CodeDisplayDefinition
draftDraftThis resource is still under development and is not yet considered to be ready for normal use.
activeActiveThis resource is ready for normal use.
retiredRetiredThis resource has been withdrawn or superseded and should no longer be used.
unknownUnknownThe authoring system does not know which of the status values currently applies for this resource. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.

Additional Language Displays

CodeNederlands (Dutch, nl)Русский (Russian, ru)
draftontwerpчерновик
activeactiefактивный
retiredverouderdудалён
unknown

Table View

CodeSystem.id[0]publication-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]cds
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].valueCode[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/publication-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.4
CodeSystem.version[0]4.0.1
CodeSystem.name[0]PublicationStatus
CodeSystem.title[0]PublicationStatus
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]The lifecycle status of an artifact.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/publication-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]draft
CodeSystem.concept[0].display[0]Draft
CodeSystem.concept[0].definition[0]This resource is still under development and is not yet considered to be ready for normal use.
CodeSystem.concept[0].designation[0].language[0]ru
CodeSystem.concept[0].designation[0].value[0]черновик
CodeSystem.concept[0].designation[1].language[0]nl
CodeSystem.concept[0].designation[1].value[0]ontwerp
CodeSystem.concept[1].code[0]active
CodeSystem.concept[1].display[0]Active
CodeSystem.concept[1].definition[0]This resource is ready for normal use.
CodeSystem.concept[1].designation[0].language[0]ru
CodeSystem.concept[1].designation[0].value[0]активный
CodeSystem.concept[1].designation[1].language[0]nl
CodeSystem.concept[1].designation[1].value[0]actief
CodeSystem.concept[2].code[0]retired
CodeSystem.concept[2].display[0]Retired
CodeSystem.concept[2].definition[0]This resource has been withdrawn or superseded and should no longer be used.
CodeSystem.concept[2].designation[0].language[0]ru
CodeSystem.concept[2].designation[0].value[0]удалён
CodeSystem.concept[2].designation[1].language[0]nl
CodeSystem.concept[2].designation[1].value[0]verouderd
CodeSystem.concept[3].code[0]unknown
CodeSystem.concept[3].display[0]Unknown
CodeSystem.concept[3].definition[0]The authoring system does not know which of the status values currently applies for this resource. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="publication-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cds" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/publication-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.4" />
    </identifier>
    <version value="4.0.1" />
    <name value="PublicationStatus" />
    <title value="PublicationStatus" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="The lifecycle status of an artifact." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/publication-status" />
    <content value="complete" />
    <concept>
        <code value="draft" />
        <display value="Draft" />
        <definition value="This resource is still under development and is not yet considered to be ready for normal use." />
        <designation>
            <language value="ru" />
            <value value="черновик" />
        </designation>
        <designation>
            <language value="nl" />
            <value value="ontwerp" />
        </designation>
    </concept>
    <concept>
        <code value="active" />
        <display value="Active" />
        <definition value="This resource is ready for normal use." />
        <designation>
            <language value="ru" />
            <value value="активный" />
        </designation>
        <designation>
            <language value="nl" />
            <value value="actief" />
        </designation>
    </concept>
    <concept>
        <code value="retired" />
        <display value="Retired" />
        <definition value="This resource has been withdrawn or superseded and should no longer be used." />
        <designation>
            <language value="ru" />
            <value value="удалён" />
        </designation>
        <designation>
            <language value="nl" />
            <value value="verouderd" />
        </designation>
    </concept>
    <concept>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="The authoring system does not know which of the status values currently applies for this resource.  Note: This concept is not to be used for &quot;other&quot; - one of the listed statuses is presumed to apply, it&#39;s just not known which one." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "publication-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "cds"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/publication-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.4"
        }
    ],
    "version": "4.0.1",
    "name": "PublicationStatus",
    "title": "PublicationStatus",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "The lifecycle status of an artifact.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
    "content": "complete",
    "concept":  [
        {
            "code": "draft",
            "display": "Draft",
            "definition": "This resource is still under development and is not yet considered to be ready for normal use.",
            "designation":  [
                {
                    "language": "ru",
                    "value": "черновик"
                },
                {
                    "language": "nl",
                    "value": "ontwerp"
                }
            ]
        },
        {
            "code": "active",
            "display": "Active",
            "definition": "This resource is ready for normal use.",
            "designation":  [
                {
                    "language": "ru",
                    "value": "активный"
                },
                {
                    "language": "nl",
                    "value": "actief"
                }
            ]
        },
        {
            "code": "retired",
            "display": "Retired",
            "definition": "This resource has been withdrawn or superseded and should no longer be used.",
            "designation":  [
                {
                    "language": "ru",
                    "value": "удалён"
                },
                {
                    "language": "nl",
                    "value": "verouderd"
                }
            ]
        },
        {
            "code": "unknown",
            "display": "Unknown",
            "definition": "The authoring system does not know which of the status values currently applies for this resource.  Note: This concept is not to be used for \"other\" - one of the listed statuses is presumed to apply, it's just not known which one."
        }
    ]
}

This element is labelled as a modifier because applications should not use a retired Questionnaire without due consideration.


experimental

A Boolean value to indicate that this questionnaire is authored for testing purposes and is not intended to be used for genuine usage.


subjectType

The types of subjects that can be the subject of responses created for the questionnaire.

This element is optional and can only use values from the FHIR required ResourceType ValueSet. The ValueSet is not listed below due to its size.


date

The date (and optionally time) when the questionnaire was published.


publisher

The name of the organization or individual that published the questionnaire.


contact

Contact details to assist a user in finding and communicating with the publisher.


description

A free text natural language description of the questionnaire from a consumer's perspective.


useContext

The content was developed with a focus and intent of supporting the contexts that are listed.


jurisdiction

A legal or geographic region in which the questionnaire is intended to be used.

This element currently uses the FHIR extensible jurisdiction ValueSet.


purpose

Explanation of why this questionnaire is needed and why it has been designed as it has.


approvalDate

The date on which the resource content was approved by the publisher.


lastReviewDate

The date on which the resource content was last reviewed.


effectivePeriod

The period during which the questionnaire content was or is planned to be in active use.


code

An identifier for this question or group of questions in a particular terminology.

This element currently uses ValueSet UKCore-QuestionnaireQuestionCodes consisting of any concept from SNOMED. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future.

item

A particular question, question grouping or display text that is part of the questionnaire.

item.linkId

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

item.definition

This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource.

item.code

A terminology code that corresponds to this group or question.

This element currently uses a FHIR example Questionnaire Question Codes ValueSet consisting of any concept from LOINC.

item.prefix

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

item.text

The name of a section, the text of a question or text content for a display item.

item.type

The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

Defines the format in which the user is to be prompted for the answer.

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

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

HTML View

This code system http://hl7.org/fhir/item-type defines the following codes:

LvlCodeDisplayDefinitionnotSelectable
1groupGroupAn item with no direct answer but should have at least one child item.
1displayDisplayText for display that will not capture an answer or have child items.
1questionQuestionAn item that defines a specific answer to be captured, and which may have child items. (the answer provided in the QuestionnaireResponse should be of the defined datatype).True
2  booleanBooleanQuestion with a yes/no answer (valueBoolean).
2  decimalDecimalQuestion with is a real number answer (valueDecimal).
2  integerIntegerQuestion with an integer answer (valueInteger).
2  dateDateQuestion with a date answer (valueDate).
2  dateTimeDate TimeQuestion with a date and time answer (valueDateTime).
2  timeTimeQuestion with a time (hour:minute:second) answer independent of date. (valueTime).
2  stringStringQuestion with a short (few words to short sentence) free-text entry answer (valueString).
2  textTextQuestion with a long (potentially multi-paragraph) free-text entry answer (valueString).
2  urlUrlQuestion with a URL (website, FTP site, etc.) answer (valueUri).
2  choiceChoiceQuestion with a Coding drawn from a list of possible answers (specified in either the answerOption property, or via the valueset referenced in the answerValueSet property) as an answer (valueCoding).
2  open-choiceOpen ChoiceAnswer is a Coding drawn from a list of possible answers (as with the choice type) or a free-text entry in a string (valueCoding or valueString).
2  attachmentAttachmentQuestion with binary content such as an image, PDF, etc. as an answer (valueAttachment).
2  referenceReferenceQuestion with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference).
2  quantityQuantityQuestion with a combination of a numeric value and unit, potentially with a comparator (<, >, etc.) as an answer. (valueQuantity) There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that can be used to define what unit should be captured (or the unit that has a ucum conversion from the provided unit).

Properties

CodeURLDescriptionType
notSelectablehttp://hl7.org/fhir/concept-properties#notSelectableIndicates that the code is abstract - only intended to be used as a selector for other conceptsBoolean

Table View

CodeSystem.id[0]item-type
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/item-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.445
CodeSystem.version[0]4.0.1
CodeSystem.name[0]QuestionnaireItemType
CodeSystem.title[0]QuestionnaireItemType
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]Distinguishes groups from questions and display text and indicates data type for questions.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/item-type
CodeSystem.content[0]complete
CodeSystem.property[0].code[0]notSelectable
CodeSystem.property[0].uri[0]http://hl7.org/fhir/concept-properties#notSelectable
CodeSystem.property[0].description[0]Indicates that the code is abstract - only intended to be used as a selector for other concepts
CodeSystem.property[0].type[0]boolean
CodeSystem.concept[0].code[0]group
CodeSystem.concept[0].display[0]Group
CodeSystem.concept[0].definition[0]An item with no direct answer but should have at least one child item.
CodeSystem.concept[1].code[0]display
CodeSystem.concept[1].display[0]Display
CodeSystem.concept[1].definition[0]Text for display that will not capture an answer or have child items.
CodeSystem.concept[2].code[0]question
CodeSystem.concept[2].display[0]Question
CodeSystem.concept[2].definition[0]An item that defines a specific answer to be captured, and which may have child items. (the answer provided in the QuestionnaireResponse should be of the defined datatype).
CodeSystem.concept[2].property[0].code[0]notSelectable
CodeSystem.concept[2].property[0].valueBoolean[0]True
CodeSystem.concept[2].concept[0].code[0]boolean
CodeSystem.concept[2].concept[0].display[0]Boolean
CodeSystem.concept[2].concept[0].definition[0]Question with a yes/no answer (valueBoolean).
CodeSystem.concept[2].concept[1].code[0]decimal
CodeSystem.concept[2].concept[1].display[0]Decimal
CodeSystem.concept[2].concept[1].definition[0]Question with is a real number answer (valueDecimal).
CodeSystem.concept[2].concept[2].code[0]integer
CodeSystem.concept[2].concept[2].display[0]Integer
CodeSystem.concept[2].concept[2].definition[0]Question with an integer answer (valueInteger).
CodeSystem.concept[2].concept[3].code[0]date
CodeSystem.concept[2].concept[3].display[0]Date
CodeSystem.concept[2].concept[3].definition[0]Question with a date answer (valueDate).
CodeSystem.concept[2].concept[4].code[0]dateTime
CodeSystem.concept[2].concept[4].display[0]Date Time
CodeSystem.concept[2].concept[4].definition[0]Question with a date and time answer (valueDateTime).
CodeSystem.concept[2].concept[5].code[0]time
CodeSystem.concept[2].concept[5].display[0]Time
CodeSystem.concept[2].concept[5].definition[0]Question with a time (hour:minute:second) answer independent of date. (valueTime).
CodeSystem.concept[2].concept[6].code[0]string
CodeSystem.concept[2].concept[6].display[0]String
CodeSystem.concept[2].concept[6].definition[0]Question with a short (few words to short sentence) free-text entry answer (valueString).
CodeSystem.concept[2].concept[7].code[0]text
CodeSystem.concept[2].concept[7].display[0]Text
CodeSystem.concept[2].concept[7].definition[0]Question with a long (potentially multi-paragraph) free-text entry answer (valueString).
CodeSystem.concept[2].concept[8].code[0]url
CodeSystem.concept[2].concept[8].display[0]Url
CodeSystem.concept[2].concept[8].definition[0]Question with a URL (website, FTP site, etc.) answer (valueUri).
CodeSystem.concept[2].concept[9].code[0]choice
CodeSystem.concept[2].concept[9].display[0]Choice
CodeSystem.concept[2].concept[9].definition[0]Question with a Coding drawn from a list of possible answers (specified in either the answerOption property, or via the valueset referenced in the answerValueSet property) as an answer (valueCoding).
CodeSystem.concept[2].concept[10].code[0]open-choice
CodeSystem.concept[2].concept[10].display[0]Open Choice
CodeSystem.concept[2].concept[10].definition[0]Answer is a Coding drawn from a list of possible answers (as with the choice type) or a free-text entry in a string (valueCoding or valueString).
CodeSystem.concept[2].concept[11].code[0]attachment
CodeSystem.concept[2].concept[11].display[0]Attachment
CodeSystem.concept[2].concept[11].definition[0]Question with binary content such as an image, PDF, etc. as an answer (valueAttachment).
CodeSystem.concept[2].concept[12].code[0]reference
CodeSystem.concept[2].concept[12].display[0]Reference
CodeSystem.concept[2].concept[12].definition[0]Question with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference).
CodeSystem.concept[2].concept[13].code[0]quantity
CodeSystem.concept[2].concept[13].display[0]Quantity
CodeSystem.concept[2].concept[13].definition[0]Question with a combination of a numeric value and unit, potentially with a comparator (<, >, etc.) as an answer. (valueQuantity) There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that can be used to define what unit should be captured (or the unit that has a ucum conversion from the provided unit).

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="item-type" />
    <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/item-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.445" />
    </identifier>
    <version value="4.0.1" />
    <name value="QuestionnaireItemType" />
    <title value="QuestionnaireItemType" />
    <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="Distinguishes groups from questions and display text and indicates data type for questions." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/item-type" />
    <content value="complete" />
    <property>
        <code value="notSelectable" />
        <uri value="http://hl7.org/fhir/concept-properties#notSelectable" />
        <description value="Indicates that the code is abstract - only intended to be used as a selector for other concepts" />
        <type value="boolean" />
    </property>
    <concept>
        <code value="group" />
        <display value="Group" />
        <definition value="An item with no direct answer but should have at least one child item." />
    </concept>
    <concept>
        <code value="display" />
        <display value="Display" />
        <definition value="Text for display that will not capture an answer or have child items." />
    </concept>
    <concept>
        <code value="question" />
        <display value="Question" />
        <definition value="An item that defines a specific answer to be captured, and which may have child items. (the answer provided in the QuestionnaireResponse should be of the defined datatype)." />
        <property>
            <code value="notSelectable" />
            <valueBoolean value="true" />
        </property>
        <concept>
            <code value="boolean" />
            <display value="Boolean" />
            <definition value="Question with a yes/no answer (valueBoolean)." />
        </concept>
        <concept>
            <code value="decimal" />
            <display value="Decimal" />
            <definition value="Question with is a real number answer (valueDecimal)." />
        </concept>
        <concept>
            <code value="integer" />
            <display value="Integer" />
            <definition value="Question with an integer answer (valueInteger)." />
        </concept>
        <concept>
            <code value="date" />
            <display value="Date" />
            <definition value="Question with a date answer (valueDate)." />
        </concept>
        <concept>
            <code value="dateTime" />
            <display value="Date Time" />
            <definition value="Question with a date and time answer (valueDateTime)." />
        </concept>
        <concept>
            <code value="time" />
            <display value="Time" />
            <definition value="Question with a time (hour:minute:second) answer independent of date. (valueTime)." />
        </concept>
        <concept>
            <code value="string" />
            <display value="String" />
            <definition value="Question with a short (few words to short sentence) free-text entry answer (valueString)." />
        </concept>
        <concept>
            <code value="text" />
            <display value="Text" />
            <definition value="Question with a long (potentially multi-paragraph) free-text entry answer (valueString)." />
        </concept>
        <concept>
            <code value="url" />
            <display value="Url" />
            <definition value="Question with a URL (website, FTP site, etc.) answer (valueUri)." />
        </concept>
        <concept>
            <code value="choice" />
            <display value="Choice" />
            <definition value="Question with a Coding drawn from a list of possible answers (specified in either the answerOption property, or via the valueset referenced in the answerValueSet property) as an answer (valueCoding)." />
        </concept>
        <concept>
            <code value="open-choice" />
            <display value="Open Choice" />
            <definition value="Answer is a Coding drawn from a list of possible answers (as with the choice type) or a free-text entry in a string (valueCoding or valueString)." />
        </concept>
        <concept>
            <code value="attachment" />
            <display value="Attachment" />
            <definition value="Question with binary content such as an image, PDF, etc. as an answer (valueAttachment)." />
        </concept>
        <concept>
            <code value="reference" />
            <display value="Reference" />
            <definition value="Question with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference)." />
        </concept>
        <concept>
            <code value="quantity" />
            <display value="Quantity" />
            <definition value="Question with a combination of a numeric value and unit, potentially with a comparator (&lt;, &gt;, etc.) as an answer. (valueQuantity) There is an extension &#39;http://hl7.org/fhir/StructureDefinition/questionnaire-unit&#39; that can be used to define what unit should be captured (or the unit that has a ucum conversion from the provided unit)." />
        </concept>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "item-type",
    "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/item-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.445"
        }
    ],
    "version": "4.0.1",
    "name": "QuestionnaireItemType",
    "title": "QuestionnaireItemType",
    "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": "Distinguishes groups from questions and display text and indicates data type for questions.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/item-type",
    "content": "complete",
    "property":  [
        {
            "code": "notSelectable",
            "uri": "http://hl7.org/fhir/concept-properties#notSelectable",
            "description": "Indicates that the code is abstract - only intended to be used as a selector for other concepts",
            "type": "boolean"
        }
    ],
    "concept":  [
        {
            "code": "group",
            "display": "Group",
            "definition": "An item with no direct answer but should have at least one child item."
        },
        {
            "code": "display",
            "display": "Display",
            "definition": "Text for display that will not capture an answer or have child items."
        },
        {
            "code": "question",
            "display": "Question",
            "definition": "An item that defines a specific answer to be captured, and which may have child items. (the answer provided in the QuestionnaireResponse should be of the defined datatype).",
            "property":  [
                {
                    "code": "notSelectable",
                    "valueBoolean": true
                }
            ],
            "concept":  [
                {
                    "code": "boolean",
                    "display": "Boolean",
                    "definition": "Question with a yes/no answer (valueBoolean)."
                },
                {
                    "code": "decimal",
                    "display": "Decimal",
                    "definition": "Question with is a real number answer (valueDecimal)."
                },
                {
                    "code": "integer",
                    "display": "Integer",
                    "definition": "Question with an integer answer (valueInteger)."
                },
                {
                    "code": "date",
                    "display": "Date",
                    "definition": "Question with a date answer (valueDate)."
                },
                {
                    "code": "dateTime",
                    "display": "Date Time",
                    "definition": "Question with a date and time answer (valueDateTime)."
                },
                {
                    "code": "time",
                    "display": "Time",
                    "definition": "Question with a time (hour:minute:second) answer independent of date. (valueTime)."
                },
                {
                    "code": "string",
                    "display": "String",
                    "definition": "Question with a short (few words to short sentence) free-text entry answer (valueString)."
                },
                {
                    "code": "text",
                    "display": "Text",
                    "definition": "Question with a long (potentially multi-paragraph) free-text entry answer (valueString)."
                },
                {
                    "code": "url",
                    "display": "Url",
                    "definition": "Question with a URL (website, FTP site, etc.) answer (valueUri)."
                },
                {
                    "code": "choice",
                    "display": "Choice",
                    "definition": "Question with a Coding drawn from a list of possible answers (specified in either the answerOption property, or via the valueset referenced in the answerValueSet property) as an answer (valueCoding)."
                },
                {
                    "code": "open-choice",
                    "display": "Open Choice",
                    "definition": "Answer is a Coding drawn from a list of possible answers (as with the choice type) or a free-text entry in a string (valueCoding or valueString)."
                },
                {
                    "code": "attachment",
                    "display": "Attachment",
                    "definition": "Question with binary content such as an image, PDF, etc. as an answer (valueAttachment)."
                },
                {
                    "code": "reference",
                    "display": "Reference",
                    "definition": "Question with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference)."
                },
                {
                    "code": "quantity",
                    "display": "Quantity",
                    "definition": "Question with a combination of a numeric value and unit, potentially with a comparator (<, >, etc.) as an answer. (valueQuantity) There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that can be used to define what unit should be captured (or the unit that has a ucum conversion from the provided unit)."
                }
            ]
        }
    ]
}

item.enableWhen

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

This element is labelled as a modifier because if enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present.

  • item.enableWhen.question The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
  • item.enableWhen.operator Specifies the criteria by which the question is enabled.
  • item.enableWhen.answer[x] A value that the referenced question is tested using the specified operator in order for the item to be enabled.

item.enableBehavior

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

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

HTML View

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

CodeDisplayDefinition
allAllEnable the question when all the enableWhen criteria are satisfied.
anyAnyEnable the question when any of the enableWhen criteria are satisfied.

Table View

CodeSystem.id[0]questionnaire-enable-behavior
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-enable-behavior
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1008
CodeSystem.version[0]4.0.1
CodeSystem.name[0]EnableWhenBehavior
CodeSystem.title[0]EnableWhenBehavior
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]Controls how multiple enableWhen values are interpreted - whether all or any must be true.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]all
CodeSystem.concept[0].display[0]All
CodeSystem.concept[0].definition[0]Enable the question when all the enableWhen criteria are satisfied.
CodeSystem.concept[1].code[0]any
CodeSystem.concept[1].display[0]Any
CodeSystem.concept[1].definition[0]Enable the question when any of the enableWhen criteria are satisfied.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="questionnaire-enable-behavior" />
    <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-enable-behavior" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1008" />
    </identifier>
    <version value="4.0.1" />
    <name value="EnableWhenBehavior" />
    <title value="EnableWhenBehavior" />
    <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="Controls how multiple enableWhen values are interpreted -  whether all or any must be true." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior" />
    <content value="complete" />
    <concept>
        <code value="all" />
        <display value="All" />
        <definition value="Enable the question when all the enableWhen criteria are satisfied." />
    </concept>
    <concept>
        <code value="any" />
        <display value="Any" />
        <definition value="Enable the question when any of the enableWhen criteria are satisfied." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "questionnaire-enable-behavior",
    "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-enable-behavior",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1008"
        }
    ],
    "version": "4.0.1",
    "name": "EnableWhenBehavior",
    "title": "EnableWhenBehavior",
    "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": "Controls how multiple enableWhen values are interpreted -  whether all or any must be true.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior",
    "content": "complete",
    "concept":  [
        {
            "code": "all",
            "display": "All",
            "definition": "Enable the question when all the enableWhen criteria are satisfied."
        },
        {
            "code": "any",
            "display": "Any",
            "definition": "Enable the question when any of the enableWhen criteria are satisfied."
        }
    ]
}

item.required

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse.

item.repeats

An indication, if true, that the item may occur multiple times in the response.

item.readOnly

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

item.maxLength

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

item.answerValueSet

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

item.answerOption

One of the permitted answers for a "choice" or "open-choice" question.

  • item.answerOption.value[x] Mandatory potential answer that's allowed as the answer to this question.
  • item.answerOption.initialSelected Optionally indicates whether the answer value is selected when the list of possible answers is initially shown.

item.initial

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

item.item

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


back to top