StructureDefinition Extension-England-TypedPeriod

Canonical_URLDescriptionProfile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod

This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods.

This extension has been created from an ODS use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ODS and can be used for other scenarios.

Context of Use: Organization, OrganizationAffiliation, Extension-England-OrganisationRole

Tree View

url1..1System.StringFixed Value
valueCodingCoding
url1..1System.StringFixed Value
valuePeriodPeriod
url1..1System.StringFixed Value

Table View

Extension..
Extension.extension2..
Extension.extension1..1
Extension.extension.url..
Extension.extension.value[x]Coding1..
Extension.extension1..1
Extension.extension.url..
Extension.extension.value[x]Period1..
Extension.url..
Extension.value[x]..0


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-England-TypedPeriod" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" />
    <version value="1.0.0" />
    <name value="ExtensionEnglandTypedPeriod" />
    <title value="Extension England Typed Period" />
    <status value="active" />
    <date value="2023-12-07" />
    <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 time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods." />
    <purpose value="This extension has been created from an ODS use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ODS and can be used for other scenarios." />
    <copyright value="Copyright &#169; 2023+ NHS England 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&#160; 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&#160; 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>
    <context>
        <type value="extension" />
        <expression value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" />
    </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 recording of a period related to the specified date type." />
            <definition value="This supports the recording of a period related to the specified date type. The date/time period is carried along with a code to identify the type of period." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <min value="2" />
        </element>
        <element id="Extension.extension:dateType">
            <path value="Extension.extension" />
            <sliceName value="dateType" />
            <short value="Whether the Date Period is &#39;Legal&#39; or &#39;Operational&#39;." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:dateType.url">
            <path value="Extension.extension.url" />
            <fixedUri value="dateType" />
        </element>
        <element id="Extension.extension:dateType.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="A ValueSet to identify the type of period." />
            <min value="1" />
            <type>
                <code value="Coding" />
            </type>
            <binding>
                <strength value="extensible" />
                <description value="The type of period data." />
                <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-PeriodType" />
            </binding>
        </element>
        <element id="Extension.extension:period">
            <path value="Extension.extension" />
            <sliceName value="period" />
            <short value="The specific business related date or time period." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:period.url">
            <path value="Extension.extension.url" />
            <fixedUri value="period" />
        </element>
        <element id="Extension.extension:period.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The date or time period." />
            <min value="1" />
            <type>
                <code value="Period" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-England-TypedPeriod",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod",
    "version": "1.0.0",
    "name": "ExtensionEnglandTypedPeriod",
    "title": "Extension England Typed Period",
    "status": "active",
    "date": "2023-12-07",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods.",
    "purpose": "This extension has been created from an ODS use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ODS and can be used for other scenarios.",
    "copyright": "Copyright © 2023+ NHS England 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",
            "expression": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "This supports the recording of a period related to the specified date type.",
                "definition": "This supports the recording of a period related to the specified date type. The date/time period is carried along with a code to identify the type of period."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "min": 2
            },
            {
                "id": "Extension.extension:dateType",
                "path": "Extension.extension",
                "sliceName": "dateType",
                "short": "Whether the Date Period is 'Legal' or 'Operational'.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:dateType.url",
                "path": "Extension.extension.url",
                "fixedUri": "dateType"
            },
            {
                "id": "Extension.extension:dateType.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "A ValueSet to identify the type of period.",
                "min": 1,
                "type":  [
                    {
                        "code": "Coding"
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "description": "The type of period data.",
                    "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-PeriodType"
                }
            },
            {
                "id": "Extension.extension:period",
                "path": "Extension.extension",
                "sliceName": "period",
                "short": "The specific business related date or time period.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:period.url",
                "path": "Extension.extension.url",
                "fixedUri": "period"
            },
            {
                "id": "Extension.extension:period.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The date or time period.",
                "min": 1,
                "type":  [
                    {
                        "code": "Period"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

None provided at this time.

Extension Specific Guidance

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