NHS England Implementation Guide STU1

Notice

This version of the NHS England Implementation Guide is currently under development.
This is a 'pre-release' version and exists for the purpose of internal review of the Clinical and Technical Assurance Sprint 1, and is not suitable for development purposes.

StructureDefinition Extension-England-DateTime

Canonical_URL	Description	Profile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime	This supports the exchange of non-clinical business dates and 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, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time.

Context of Use:

Organization, OrganizationAffiliation

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
type	I	1..1	Extension	Element Id Extension.extension:type 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:type.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 type Mappings rim:N/A
value[x]		1..1	Binding	Element Id Extension.extension:type.value[x] Short description A ValueSet to identify the type of business 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 business date time. EnglandTypedDateTime (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
valueCoding			Coding	Data Type Coding
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.nhs.uk/England/StructureDefinition/Extension-England-DateTime 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

Table View

Extension		..
Extension.extension		2..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	Coding	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-England-DateTime" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime" />
    <version value="1.0.0" />
    <name value="ExtensionEnglandDateTime" />
    <title value="Extension England Date Time" />
    <status value="draft" />
    <date value="2023-10-24" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This supports the exchange of non-clinical business dates and 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, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time." />
    <copyright value="Copyright &#169; 2023+ 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="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:type">
            <path value="Extension.extension" />
            <sliceName value="type" />
            <short value="Code to identify the type of time/date." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:type.url">
            <path value="Extension.extension.url" />
            <fixedUri value="type" />
        </element>
        <element id="Extension.extension:type.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="A ValueSet to identify the type of business date time." />
            <min value="1" />
            <type>
                <code value="Coding" />
            </type>
            <binding>
                <strength value="extensible" />
                <description value="The type of business date time." />
                <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime" />
            </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.nhs.uk/England/StructureDefinition/Extension-England-DateTime" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-England-DateTime",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime",
    "version": "1.0.0",
    "name": "ExtensionEnglandDateTime",
    "title": "Extension England Date Time",
    "status": "draft",
    "date": "2023-10-24",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This supports the exchange of non-clinical business dates and 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, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time.",
    "copyright": "Copyright © 2023+ 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": "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:type",
                "path": "Extension.extension",
                "sliceName": "type",
                "short": "Code to identify the type of time/date.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:type.url",
                "path": "Extension.extension.url",
                "fixedUri": "type"
            },
            {
                "id": "Extension.extension:type.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "A ValueSet to identify the type of business date time.",
                "min": 1,
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "description": "The type of business date time.",
                    "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime"
                }
            },
            {
                "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.nhs.uk/England/StructureDefinition/Extension-England-DateTime"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Note:There is currently no example that uses this extension. An example will be added in a future release.

Propose a change to Extension-England-DateTime

Extension Specific Guidance

There is a binding within this extension to ValueSet-England-TypedDateTime

NHS England Implementation Guide STU1 - Sprint 1 Review

1.0.0-sprint-1-review