UK Core Implementation Guide Assets in Development

Please note:

This is an Implementation Guide for UK Core FHIR Assets in Development.
There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
Therefore this Implementation Guide must not be implemented.
Please follow the guidance on the "Contact Us" page if you need any assistance.

Clinical and Technical Assurance Extensions for Future Sprints

This library contains the Extensions which are proposed to be included in the UK Core for a future Clinical and Technical Assurance Sprint. These have a status of draft and a low maturity level. For more information on maturity levels see the section in the active Extensions library below. These are currently not hard-coded in the associated profiles and as part of the C&TA process may be rejected for inclusion in the UK Core active Extensions library.

Extensions	Status	Context of Use	modifierExtension	Use Case / C&TA Sprint
Extension UKCore-TypedDateTime	draft	Communication, Encounter, Organization, OrganizationAffiliation	NO	ODS
Extension UKCore-TypedPeriod	draft	Organization, OrganizationAffiliation	NO	ODS

StructureDefinition Extension-UKCore-TypedDateTime

Context of Use

Communication, Encounter, Organization, OrganizationAffiliation

Canonical_URL	Status	Current_Version	Last_Updated	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime	draft	2.2.0	2023-10-13	This supports the exchange of dates and/or times. The extension date and/or time is carried along with a code to identify the type of date and/or time.	This extension extends the Encounter and the Communication resources to support the exchange of information describing the specific business related date and/or time.

Tree View

Extension	I		Extension	Element Id Extension Short description This supports the exchange of dates and/or times. Definition This supports the exchange of dates and/or times. The extension date and/or time is carried along with a code to identify the type of date and/or time. 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
extension	I	2..*	Extension	There are no (further) constraints on this element Element Id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) 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
dateTimeType	I	1..1	Extension	Element Id Extension.extension:dateTimeType Short description Code to identify the type of time/date. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. 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.extension:dateTimeType.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 dateTimeType Mappings rim:N/A
value[x]		1..1	Binding	Element Id Extension.extension:dateTimeType.value[x] Short description A ValueSet to identify the type of date time. Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding The type of date time. UKCoreDateTimeType (extensible) 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
dateTime	I	1..1	Extension	Element Id Extension.extension:dateTime Short description The specific business related date and/or time. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. 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.extension:dateTime.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 dateTime Mappings rim:N/A
value[x]		1..1		Element Id Extension.extension:dateTime.value[x] Short description The date and/or time. Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
valueDateTime			dateTime	Data Type dateTime
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-TypedDateTime Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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

Detailed Descriptions

Extension
Definition	This supports the exchange of dates and/or times. The extension date and/or time is carried along with a code to identify the type of date and/or time.
Cardinality	0...*
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	2...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTimeType
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTimeType.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
Extension.extension:dateTimeType.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTimeType.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	System.String
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.
Fixed Value	dateTimeType
Mappings	rim:N/A
Extension.extension:dateTimeType.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	1...1
Type	CodeableConcept
Binding	The type of date time. UKCoreDateTimeType (extensible)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTime
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTime.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	System.String
Mappings	rim:n/a
Extension.extension:dateTime.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim:n/a rim:N/A
Extension.extension:dateTime.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	System.String
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.
Fixed Value	dateTime
Mappings	rim:N/A
Extension.extension:dateTime.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	1...1
Type	dateTime
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	System.String
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.
Fixed Value	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime
Mappings	rim:N/A
Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	0...0
Type	base64Binary
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim:n/a rim:N/A

Table View

Extension		..
Extension.extension		2..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	CodeableConcept	1..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	dateTime	1..
Extension.url		..
Extension.value[x]		..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-TypedDateTime" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime" />
    <version value="2.2.0" />
    <name value="ExtensionUKCoreTypedDateTime" />
    <title value="Extension UK Core Typed Date Time" />
    <status value="draft" />
    <date value="2023-10-13" />
    <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 supports the exchange of dates and/or times.  The extension date and/or time is carried along with a code to identify the type of date and/or time." />
    <purpose value="This extension extends the Encounter and the Communication resources to support the exchange of information describing the specific business related date and/or time." />
    <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="Encounter" />
    </context>
    <context>
        <type value="element" />
        <expression value="Communication" />
    </context>
    <context>
        <type value="element" />
        <expression value="Organization" />
    </context>
    <context>
        <type value="element" />
        <expression value="OrganizationAffiliation" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="This supports the exchange of dates and/or times." />
            <definition value="This supports the exchange of dates and/or times.  The extension date and/or time is carried along with a code to identify the type of date and/or time." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <min value="2" />
        </element>
        <element id="Extension.extension:dateTimeType">
            <path value="Extension.extension" />
            <sliceName value="dateTimeType" />
            <short value="Code to identify the type of time/date." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:dateTimeType.url">
            <path value="Extension.extension.url" />
            <fixedUri value="dateTimeType" />
        </element>
        <element id="Extension.extension:dateTimeType.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="A ValueSet to identify the type of date time." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="extensible" />
                <description value="The type of date time." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DateTimeType" />
            </binding>
        </element>
        <element id="Extension.extension:dateTime">
            <path value="Extension.extension" />
            <sliceName value="dateTime" />
            <short value="The specific business related date and/or  time." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:dateTime.url">
            <path value="Extension.extension.url" />
            <fixedUri value="dateTime" />
        </element>
        <element id="Extension.extension:dateTime.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The date and/or time." />
            <min value="1" />
            <type>
                <code value="dateTime" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-TypedDateTime",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime",
    "version": "2.2.0",
    "name": "ExtensionUKCoreTypedDateTime",
    "title": "Extension UK Core Typed Date Time",
    "status": "draft",
    "date": "2023-10-13",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This supports the exchange of dates and/or times.  The extension date and/or time is carried along with a code to identify the type of date and/or time.",
    "purpose": "This extension extends the Encounter and the Communication resources to support the exchange of information describing the specific business related date and/or time.",
    "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": "Encounter"
        },
        {
            "type": "element",
            "expression": "Communication"
        },
        {
            "type": "element",
            "expression": "Organization"
        },
        {
            "type": "element",
            "expression": "OrganizationAffiliation"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "This supports the exchange of dates and/or times.",
                "definition": "This supports the exchange of dates and/or times.  The extension date and/or time is carried along with a code to identify the type of date and/or time."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "min": 2
            },
            {
                "id": "Extension.extension:dateTimeType",
                "path": "Extension.extension",
                "sliceName": "dateTimeType",
                "short": "Code to identify the type of time/date.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:dateTimeType.url",
                "path": "Extension.extension.url",
                "fixedUri": "dateTimeType"
            },
            {
                "id": "Extension.extension:dateTimeType.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "A ValueSet to identify the type of date time.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "description": "The type of date time.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DateTimeType"
                }
            },
            {
                "id": "Extension.extension:dateTime",
                "path": "Extension.extension",
                "sliceName": "dateTime",
                "short": "The specific business related date and/or  time.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:dateTime.url",
                "path": "Extension.extension.url",
                "fixedUri": "dateTime"
            },
            {
                "id": "Extension.extension:dateTime.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The date and/or time.",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Feedback

Click here to:

Report issue for Extension-UKCore-TypedDateTime

Examples

N/A

Extension Specific Guidance

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

StructureDefinition Extension-UKCore-TypedPeriod