- 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.
StructureDefinition Extension-UKCore-TypedPeriod
Context of Use | Organization OrganizationAffiliation |
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod | draft | 1.0.0 | 2023-10-13 | This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is record 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. |
Tree View
Extension | I | Extension | |
id | 0..1 | string | |
extension | I | 2..* | Extension |
dataType | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | Binding | |
valueCoding | Coding | ||
period | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | ||
valuePeriod | Period | ||
url | 1..1 | uriFixed Value | |
value[x] | 0..0 |
Detailed Descriptions
Extension | |
Definition | This supports the recording of a period related to the specified date type. The period is carried along with a code to identify the type of data. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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 | string |
Mappings |
|
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 |
|
Mappings |
|
Extension.extension:dataType | |
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 |
|
Mappings |
|
Extension.extension:dataType.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 | string |
Mappings |
|
Extension.extension:dataType.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 |
|
Mappings |
|
Extension.extension:dataType.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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 | dataType |
Mappings |
|
Extension.extension:dataType.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 | Coding |
Binding | The type of period data. |
Invariants |
|
Mappings |
|
Extension.extension:period | |
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 |
|
Mappings |
|
Extension.extension:period.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 | string |
Mappings |
|
Extension.extension:period.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 |
|
Mappings |
|
Extension.extension:period.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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 | period |
Mappings |
|
Extension.extension:period.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 | Period |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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-TypedPeriod |
Mappings |
|
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 |
|
Mappings |
|
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] | Period | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-TypedPeriod" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod" /> <version value="1.0.0" /> <name value="ExtensionUKCoreTypedPeriod" /> <title value="Extension UK Core Typed Period" /> <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 time periods. The extension time period is carried along with a code to identify whether the data is record 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 © 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 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 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 period is carried along with a code to identify the type of data." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="2" /> </element> <element id="Extension.extension:dataType"> <path value="Extension.extension" /> <sliceName value="dataType" /> <short value="Whether the Date Period is 'Legal' or 'Operational'." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:dataType.url"> <path value="Extension.extension.url" /> <fixedUri value="dataType" /> </element> <element id="Extension.extension:dataType.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.hl7.org.uk/ValueSet/UKCore-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.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-TypedPeriod", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod", "version": "1.0.0", "name": "ExtensionUKCoreTypedPeriod", "title": "Extension UK Core Typed Period", "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 time periods. The extension time period is carried along with a code to identify whether the data is record 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 © 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": "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 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 period is carried along with a code to identify the type of data." }, { "id": "Extension.extension", "path": "Extension.extension", "min": 2 }, { "id": "Extension.extension:dataType", "path": "Extension.extension", "sliceName": "dataType", "short": "Whether the Date Period is 'Legal' or 'Operational'.", "min": 1, "max": "1" }, { "id": "Extension.extension:dataType.url", "path": "Extension.extension.url", "fixedUri": "dataType" }, { "id": "Extension.extension:dataType.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.hl7.org.uk/ValueSet/UKCore-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.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }