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_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTimedraft2.2.02023-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

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueCodeableConceptCodeableConcept
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueDateTimedateTime
url1..1uriAuto Value

Detailed Descriptions

Extension
ShortThis 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.

Cardinality0..*
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension
ShortAdditional content defined by implementations
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.

Cardinality2..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:dateTimeType
ShortCode to identify the type of time/date.
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.

Cardinality1..1
TypeExtension
Aliasextensions, 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.

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
Extension.extension:dateTimeType.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:dateTimeType.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:dateTimeType.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
dateTimeType
Mappings
  • rim: N/A
Extension.extension:dateTimeType.value[x]
ShortA 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).

Cardinality1..1
TypeCodeableConcept
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
Extension.extension:dateTime
ShortThe specific business related date and/or time.
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.

Cardinality1..1
TypeExtension
Aliasextensions, 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.

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
Extension.extension:dateTime.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:dateTime.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:dateTime.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
dateTime
Mappings
  • rim: N/A
Extension.extension:dateTime.value[x]
ShortThe date and/or time.
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypedateTime
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedDateTime
Mappings
  • rim: N/A
Extension.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
Typebase64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A

Table View

Extension..
Extension.extension2..
Extension.extension:dateTimeType1..1
Extension.extension:dateTimeType.url..
Extension.extension:dateTimeType.value[x]CodeableConcept1..
Extension.extension:dateTime1..1
Extension.extension:dateTime.url..
Extension.extension:dateTime.value[x]dateTime1..
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 © 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="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:

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

N/A

Extension Specific Guidance

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

StructureDefinition Extension-UKCore-TypedPeriod

Context of Use Organization
OrganizationAffiliation

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPerioddraft1.0.02023-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

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valueCodingCoding
id0..1string
extensionC0..*Extension
url1..1uriAuto Value
valuePeriodPeriod
url1..1uriAuto Value

Detailed Descriptions

Extension
ShortThis 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.

Cardinality0..*
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension
ShortAdditional content defined by implementations
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.

Cardinality2..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:dataType
ShortWhether the Date Period is 'Legal' or 'Operational'.
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.

Cardinality1..1
TypeExtension
Aliasextensions, 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.

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
Extension.extension:dataType.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:dataType.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:dataType.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
dataType
Mappings
  • rim: N/A
Extension.extension:dataType.value[x]
ShortA ValueSet to identify the type of period.
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypeCoding
Binding

The type of period data.

UKCorePeriodType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:period
ShortThe specific business related date or time 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.

Cardinality1..1
TypeExtension
Aliasextensions, 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.

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
Extension.extension:period.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:period.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

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
Extension.extension:period.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
period
Mappings
  • rim: N/A
Extension.extension:period.value[x]
ShortThe date or time period.
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypePeriod
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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.

Auto Value
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod
Mappings
  • rim: N/A
Extension.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
Typebase64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A

Table View

Extension..
Extension.extension2..
Extension.extension:dataType1..1
Extension.extension:dataType.url..
Extension.extension:dataType.value[x]Coding1..
Extension.extension:period1..1
Extension.extension:period.url..
Extension.extension:period.value[x]Period1..
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"
}
]
}
}

Feedback

Click here to:

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

N/A

Extension Specific Guidance

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