FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Extension-England-TypedPeriod

Packagefhir.r4.nhsengland.stu1
Resource TypeStructureDefinition
IdExtension-England-TypedPeriod
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=fhir.r4.nhsengland.stu1@1.5.0&canonical=https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
URLhttps://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
Version1.1.0
Statusactive
Date2025-06-25
NameExtensionEnglandTypedPeriod
TitleExtension England Typed Period
Realmus
Authorityhl7
DescriptionThis 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, operational, or system effective periods
PurposeThis extension has been created from an ODS use-case in which there is a requirement to hold data for Legal and Operational dates, an additional code value of system-effective period, is now added to enable the use of this extension in RelatedPerson network use case.
CopyrightCopyright © 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.
TypeExtension
Kindcomplex-type

Resources that use this resource

StructureDefinition
England-Organization-ODSEngland Organization ODS
England-OrganizationAffiliation-ODSEngland Organization Affiliation ODS
Extension-England-OrganisationRoleExtension England Organisation Role

Resources that this resource uses

ValueSet
England-PeriodTypeEngland Period Type

Examples of Use for Extension

No extension usage examples found


Narrative

No narrative content found in resource


Source

{
  "resourceType": "StructureDefinition",
  "id": "Extension-England-TypedPeriod",
  "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod",
  "version": "1.1.0",
  "name": "ExtensionEnglandTypedPeriod",
  "title": "Extension England Typed Period",
  "status": "active",
  "date": "2025-06-25",
  "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, operational, or system effective 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, an additional code value of system-effective period, is now added to enable the use of this extension in RelatedPerson network use case.",
  "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": "element",
      "expression": "RelatedPerson"
    }
  ],
  "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' , 'Operational' or 'System-Effective'",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Extension.extension:dateType.extension",
        "path": "Extension.extension.extension",
        "max": "0"
      },
      {
        "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.extension",
        "path": "Extension.extension.extension",
        "max": "0"
      },
      {
        "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"
      }
    ]
  }
}