UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is for C&TA Sprint 7 Review.
This version is not suitable for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

StructureDefinition Extension-UKCore-PriorityReason

Canonical_URL	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason	This extends the Service Request Resource to support the underlying reason why a Service Request is urgent.	This is a Genomics use case to record the reason why an urgent test has been requested. This differs from supportingInfo in that it does not necessarily indicate why the test is being requested.

Context of Use

ServiceRequest.priority

Tree View

Extension	I		Extension	Element Id Extension Short description A SNOMED CT concept representing the reason a Service Request is urgent. Definition A SNOMED CT concept representing the reason a Service Request is urgent Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason Mappings rim:N/A
value[x]		1..1	Binding	Element Id Extension.value[x] Short description This describes the reason a service request is urgent Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes that define the reason why a service request is urgent. UKCoreServiceRequestReasonCode (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCodeableConcept			CodeableConcept	Data Type CodeableConcept

Table View

Extension		..
Extension.url		..
Extension.value[x]	CodeableConcept	1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-PriorityReason" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" />
    <version value="1.0.0" />
    <name value="ExtensionUKCorePriorityReason" />
    <title value="Extension UK Core Priority Reason" />
    <status value="active" />
    <date value="2023-04-28" />
    <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 extends the Service Request Resource to support the underlying reason why a Service Request is urgent." />
    <purpose value="This is a Genomics use case to record the reason why an urgent test has been requested. This differs from supportingInfo in that it does not necessarily indicate why the test is being requested." />
    <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="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="ServiceRequest.priority" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="A SNOMED CT concept representing the reason a Service Request is urgent." />
            <definition value="A SNOMED CT concept representing the reason a Service Request is urgent" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="This describes the reason a service request is urgent" />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="preferred" />
                <description value="A set of codes that define the reason why a service request is urgent." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-PriorityReason",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason",
    "version": "1.0.0",
    "name": "ExtensionUKCorePriorityReason",
    "title": "Extension UK Core Priority Reason",
    "status": "active",
    "date": "2023-04-28",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This extends the Service Request Resource to support the underlying reason why a Service Request is urgent.",
    "purpose": "This is a Genomics use case to record the reason why an urgent test has been requested. This differs from supportingInfo in that it does not necessarily indicate why the test is being requested.",
    "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": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "ServiceRequest.priority"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "A SNOMED CT concept representing the reason a Service Request is urgent.",
                "definition": "A SNOMED CT concept representing the reason a Service Request is urgent"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "This describes the reason a service request is urgent",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes that define the reason why a service request is urgent.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode"
                }
            }
        ]
    }
}

Examples

Priority Reason - An example to illustrate the priority reason extension, using a SNOMED CT concept, for a service request marked as urgent.
Example UKCore-Extension-PriorityReason

Priority Reason - An example to illustrate the priority reason extension, using a plain text reason, for a service request marked as urgent.
Example UKCore-Extension-PriorityReason-SendingAsText

Extension Specific Guidance

There is a binding within this extension to a ValueSet UKCore-ServiceRequestReasonCode.