Extensions


Extension-England-EndpointBusinessScenario

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenariodraft0.1.02025-07-21

The Endpoint Business Scenario extension indicates if the endpoint is the main recipient for the message. In most cases, except for Service type 'GP', the entry should be 'Primary'. For Service Type of 'GP' the Primary endpoint will be used to receive messages from dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information. The 'Copy' endpoint is only used for Post Event Messaging (PEM) to GP services.

This extension is a Directory of Service (DoS) use case, Use to differentiate between primary message recipients and copy recipients, particularly important for GP services where separate endpoints may be required for direct patient dispositions versus Post Event Messaging (PEM) scenarios.


Tree View

id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueCodecode

Detailed Descriptions

Extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

Cardinality0..1
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.

Cardinality0..0
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.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.

Fixed Value
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario
Mappings
  • rim: N/A
Extension.value[x]
ShortBusiness scenario type for the endpoint
Definition

Indicates the business scenario for which this endpoint is intended. 'Primary' indicates the main recipient for messages (used for most services and for GP direct patient dispositions). 'Copy' indicates a copy recipient (used only for Post Event Messaging to GP services where patients have been treated by another service).

Cardinality1..1
Typecode
Binding

EnglandEndpointBusinessScenario (required)

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..1
Extension.extension..0
Extension.url..
Extension.value[x]code1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-England-EndpointBusinessScenario" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario" />
<version value="0.1.0" />
<name value="ExtensionEnglandEndpointBusinessScenario" />
<title value="Extension England Endpoint Business Scenario" />
<status value="draft" />
<date value="2025-07-21" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="The Endpoint Business Scenario extension indicates if the endpoint is the main recipient for the message. In most cases, except for Service type 'GP', the entry should be 'Primary'. For Service Type of 'GP' the Primary endpoint will be used to receive messages from dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information. The 'Copy' endpoint is only used for Post Event Messaging (PEM) to GP services." />
<purpose value="This extension is a Directory of Service (DoS) use case, Use to differentiate between primary message recipients and copy recipients, particularly important for GP services where separate endpoints may be required for direct patient dispositions versus Post Event Messaging (PEM) scenarios." />
<copyright value="Copyright © 2025+ 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" />
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="Endpoint" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<max value="1" />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Business scenario type for the endpoint" />
<definition value="Indicates the business scenario for which this endpoint is intended. 'Primary' indicates the main recipient for messages (used for most services and for GP direct patient dispositions). 'Copy' indicates a copy recipient (used only for Post Event Messaging to GP services where patients have been treated by another service)." />
<min value="1" />
<code value="code" />
</type>
<strength value="required" />
<valueSet value="https://fhir.nhs.uk/England/ValueSet/England-Endpoint-BusinessScenario" />
</binding>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-England-EndpointBusinessScenario",
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario",
"version": "0.1.0",
"name": "ExtensionEnglandEndpointBusinessScenario",
"title": "Extension England Endpoint Business Scenario",
"status": "draft",
"date": "2025-07-21",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "The Endpoint Business Scenario extension indicates if the endpoint is the main recipient for the message. In most cases, except for Service type 'GP', the entry should be 'Primary'. For Service Type of 'GP' the Primary endpoint will be used to receive messages from dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information. The 'Copy' endpoint is only used for Post Event Messaging (PEM) to GP services.",
"purpose": "This extension is a Directory of Service (DoS) use case, Use to differentiate between primary message recipients and copy recipients, particularly important for GP services where separate endpoints may be required for direct patient dispositions versus Post Event Messaging (PEM) scenarios.",
"copyright": "Copyright © 2025+ 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",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Endpoint"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Business scenario type for the endpoint",
"definition": "Indicates the business scenario for which this endpoint is intended. 'Primary' indicates the main recipient for messages (used for most services and for GP direct patient dispositions). 'Copy' indicates a copy recipient (used only for Post Event Messaging to GP services where patients have been treated by another service).",
"min": 1,
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/England/ValueSet/England-Endpoint-BusinessScenario"
}
}
]
}
}


Extension-England-EndpointCompression

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompressiondraft0.1.02025-07-21

The Endpoint Compression extension is used to signify if the message recipient is able to receive compressed data. This will translate to 'Compressed' or 'Uncompressed' respectively. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure.

This extension supports the Directory of Service (DoS) use case by enabling systems to determine whether an endpoint can accept compressed data, allowing for optimization of data transmission by reducing bandwidth requirements and potential messaging delays or failures.


Tree View

id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueBooleanboolean

Detailed Descriptions

Extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

Cardinality0..1
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.

Cardinality0..0
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.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.

Fixed Value
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression
Mappings
  • rim: N/A
Extension.value[x]
ShortIndicates if endpoint supports compressed data
Definition

A boolean value indicating whether the message recipient is able to receive compressed data. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure.

Cardinality1..1
Typeboolean
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..1
Extension.extension..0
Extension.url..
Extension.value[x]boolean1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-England-EndpointCompression" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression" />
<version value="0.1.0" />
<name value="ExtensionEnglandEndpointCompression" />
<title value="Extension England Endpoint Compression" />
<status value="draft" />
<date value="2025-07-21" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="The Endpoint Compression extension is used to signify if the message recipient is able to receive compressed data. This will translate to 'Compressed' or 'Uncompressed' respectively. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure." />
<purpose value="This extension supports the Directory of Service (DoS) use case by enabling systems to determine whether an endpoint can accept compressed data, allowing for optimization of data transmission by reducing bandwidth requirements and potential messaging delays or failures." />
<copyright value="Copyright © 2025+ 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" />
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="Endpoint" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<max value="1" />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Indicates if endpoint supports compressed data" />
<definition value="A boolean value indicating whether the message recipient is able to receive compressed data. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure." />
<min value="1" />
<code value="boolean" />
</type>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-England-EndpointCompression",
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression",
"version": "0.1.0",
"name": "ExtensionEnglandEndpointCompression",
"title": "Extension England Endpoint Compression",
"status": "draft",
"date": "2025-07-21",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "The Endpoint Compression extension is used to signify if the message recipient is able to receive compressed data. This will translate to 'Compressed' or 'Uncompressed' respectively. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure.",
"purpose": "This extension supports the Directory of Service (DoS) use case by enabling systems to determine whether an endpoint can accept compressed data, allowing for optimization of data transmission by reducing bandwidth requirements and potential messaging delays or failures.",
"copyright": "Copyright © 2025+ 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",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Endpoint"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Indicates if endpoint supports compressed data",
"definition": "A boolean value indicating whether the message recipient is able to receive compressed data. True indicates 'Compressed' capability, false indicates 'Uncompressed'. Compression reduces bandwidth requirements and can reduce messaging delays and/or failure.",
"min": 1,
"type": [
{
"code": "boolean"
}
]
}
]
}
}


Extension-England-LocationExtension


Tree View

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value

Detailed Descriptions

Extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

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.

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:UPRN
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..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:UPRN.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:UPRN.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:UPRN.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.

Fixed Value
UPRN
Mappings
  • rim: N/A
Extension.extension:UPRN.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..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:PAF
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..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:PAF.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:PAF.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:PAF.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.

Fixed Value
PAF
Mappings
  • rim: N/A
Extension.extension:PAF.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..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:eastings
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..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:eastings.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:eastings.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:eastings.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.

Fixed Value
eastings
Mappings
  • rim: N/A
Extension.extension:eastings.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..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:northings
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..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:northings.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:northings.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:northings.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.

Fixed Value
northings
Mappings
  • rim: N/A
Extension.extension:northings.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..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:what3words
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..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:what3words.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:what3words.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:what3words.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.

Fixed Value
what3words
Mappings
  • rim: N/A
Extension.extension:what3words.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..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:accuracy
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..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:accuracy.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:accuracy.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:accuracy.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.

Fixed Value
accuracy
Mappings
  • rim: N/A
Extension.extension:accuracy.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..1
Typestring
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.

Fixed Value
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension
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.extension:UPRN..1
Extension.extension:UPRN.url..
Extension.extension:UPRN.value[x]string..
Extension.extension:PAF..1
Extension.extension:PAF.url..
Extension.extension:PAF.value[x]string..
Extension.extension:eastings..1
Extension.extension:eastings.url..
Extension.extension:eastings.value[x]string..
Extension.extension:northings..1
Extension.extension:northings.url..
Extension.extension:northings.value[x]string..
Extension.extension:what3words..1
Extension.extension:what3words.url..
Extension.extension:what3words.value[x]string..
Extension.extension:accuracy..1
Extension.extension:accuracy.url..
Extension.extension:accuracy.value[x]string..
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-England-LocationExtension" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension" />
<version value="0.1.0" />
<name value="ExtensionEnglandLocationExtension" />
<title value="Extension England Location Extension" />
<status value="draft" />
<date value="2024-06-19" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="The Location extension is used to provide clarification, using alternative methods of describing a precise location." />
<purpose value="The Location extension is used to provide clarification, using alternative methods of describing a precise location." />
<copyright value="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 value="4.0.1" />
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="Location" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension.extension:UPRN">
<path value="Extension.extension" />
<sliceName value="UPRN" />
<max value="1" />
</element>
<element id="Extension.extension:UPRN.url">
<path value="Extension.extension.url" />
<fixedUri value="UPRN" />
</element>
<element id="Extension.extension:UPRN.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.extension:PAF">
<path value="Extension.extension" />
<sliceName value="PAF" />
<max value="1" />
</element>
<element id="Extension.extension:PAF.url">
<path value="Extension.extension.url" />
<fixedUri value="PAF" />
</element>
<element id="Extension.extension:PAF.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.extension:eastings">
<path value="Extension.extension" />
<sliceName value="eastings" />
<max value="1" />
</element>
<element id="Extension.extension:eastings.url">
<path value="Extension.extension.url" />
<fixedUri value="eastings" />
</element>
<element id="Extension.extension:eastings.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.extension:northings">
<path value="Extension.extension" />
<sliceName value="northings" />
<max value="1" />
</element>
<element id="Extension.extension:northings.url">
<path value="Extension.extension.url" />
<fixedUri value="northings" />
</element>
<element id="Extension.extension:northings.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.extension:what3words">
<path value="Extension.extension" />
<sliceName value="what3words" />
<max value="1" />
</element>
<element id="Extension.extension:what3words.url">
<path value="Extension.extension.url" />
<fixedUri value="what3words" />
</element>
<element id="Extension.extension:what3words.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.extension:accuracy">
<path value="Extension.extension" />
<sliceName value="accuracy" />
<max value="1" />
</element>
<element id="Extension.extension:accuracy.url">
<path value="Extension.extension.url" />
<fixedUri value="accuracy" />
</element>
<element id="Extension.extension:accuracy.value[x]">
<path value="Extension.extension.value[x]" />
<code value="string" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-England-LocationExtension",
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension",
"version": "0.1.0",
"name": "ExtensionEnglandLocationExtension",
"title": "Extension England Location Extension",
"status": "draft",
"date": "2024-06-19",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "The Location extension is used to provide clarification, using alternative methods of describing a precise location.",
"purpose": "The Location extension is used to provide clarification, using alternative methods of describing a precise location.",
"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",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Location"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension.extension:UPRN",
"path": "Extension.extension",
"sliceName": "UPRN",
"max": "1"
},
{
"id": "Extension.extension:UPRN.url",
"path": "Extension.extension.url",
"fixedUri": "UPRN"
},
{
"id": "Extension.extension:UPRN.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:PAF",
"path": "Extension.extension",
"sliceName": "PAF",
"max": "1"
},
{
"id": "Extension.extension:PAF.url",
"path": "Extension.extension.url",
"fixedUri": "PAF"
},
{
"id": "Extension.extension:PAF.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:eastings",
"path": "Extension.extension",
"sliceName": "eastings",
"max": "1"
},
{
"id": "Extension.extension:eastings.url",
"path": "Extension.extension.url",
"fixedUri": "eastings"
},
{
"id": "Extension.extension:eastings.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:northings",
"path": "Extension.extension",
"sliceName": "northings",
"max": "1"
},
{
"id": "Extension.extension:northings.url",
"path": "Extension.extension.url",
"fixedUri": "northings"
},
{
"id": "Extension.extension:northings.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:what3words",
"path": "Extension.extension",
"sliceName": "what3words",
"max": "1"
},
{
"id": "Extension.extension:what3words.url",
"path": "Extension.extension.url",
"fixedUri": "what3words"
},
{
"id": "Extension.extension:what3words.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:accuracy",
"path": "Extension.extension",
"sliceName": "accuracy",
"max": "1"
},
{
"id": "Extension.extension:accuracy.url",
"path": "Extension.extension.url",
"fixedUri": "accuracy"
},
{
"id": "Extension.extension:accuracy.value[x]",
"path": "Extension.extension.value[x]",
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-LocationExtension"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}
}


Extension-England-OrganizationEndpointOrder

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrderdraft0.1.02025-07-21

The Organization Endpoint Order extension is used to provide a priority ranking for endpoints associated with an Organization resource, allowing systems to determine the preferred order of endpoint usage.

This extension is a Directory of Service (DoS) use case, Enables prioritization of multiple endpoints for an Organization, supporting scenarios where organizations have multiple communication channels or services that need to be accessed in a specific order of preference.


Tree View

id0..1string
extensionC0..0Extension
url1..1uriFixed Value
valueIntegerinteger

Detailed Descriptions

Extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

Cardinality0..1
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.

Cardinality0..0
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.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.

Fixed Value
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder
Mappings
  • rim: N/A
Extension.value[x]
ShortPriority order for the endpoint
Definition

An integer value representing the priority order of this endpoint relative to other endpoints for the same organization. Lower numbers indicate higher priority (e.g., 1 = highest priority, 2 = second priority, etc.).

Cardinality1..1
Typeinteger
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • nhse-endp-001: Endpoint order must be a positive integer
    value.integer > 0
Mappings
  • rim: N/A

Table View

Extension..1
Extension.extension..0
Extension.url..
Extension.value[x]integer1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-England-OrganizationEndpointOrder" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder" />
<version value="0.1.0" />
<name value="ExtensionEnglandOrganizationEndpointOrder" />
<title value="Extension England Organization Endpoint Order" />
<status value="draft" />
<date value="2025-07-21" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="The Organization Endpoint Order extension is used to provide a priority ranking for endpoints associated with an Organization resource, allowing systems to determine the preferred order of endpoint usage." />
<purpose value="This extension is a Directory of Service (DoS) use case, Enables prioritization of multiple endpoints for an Organization, supporting scenarios where organizations have multiple communication channels or services that need to be accessed in a specific order of preference." />
<copyright value="Copyright © 2025+ 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" />
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="Endpoint" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<max value="1" />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="Priority order for the endpoint" />
<definition value="An integer value representing the priority order of this endpoint relative to other endpoints for the same organization. Lower numbers indicate higher priority (e.g., 1 = highest priority, 2 = second priority, etc.)." />
<min value="1" />
<code value="integer" />
</type>
<key value="nhse-endp-001" />
<severity value="error" />
<human value="Endpoint order must be a positive integer" />
<expression value="value.integer > 0" />
</constraint>
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-England-OrganizationEndpointOrder",
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder",
"version": "0.1.0",
"name": "ExtensionEnglandOrganizationEndpointOrder",
"title": "Extension England Organization Endpoint Order",
"status": "draft",
"date": "2025-07-21",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "The Organization Endpoint Order extension is used to provide a priority ranking for endpoints associated with an Organization resource, allowing systems to determine the preferred order of endpoint usage.",
"purpose": "This extension is a Directory of Service (DoS) use case, Enables prioritization of multiple endpoints for an Organization, supporting scenarios where organizations have multiple communication channels or services that need to be accessed in a specific order of preference.",
"copyright": "Copyright © 2025+ 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",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Endpoint"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Priority order for the endpoint",
"definition": "An integer value representing the priority order of this endpoint relative to other endpoints for the same organization. Lower numbers indicate higher priority (e.g., 1 = highest priority, 2 = second priority, etc.).",
"min": 1,
"type": [
{
"code": "integer"
}
],
{
"key": "nhse-endp-001",
"severity": "error",
"human": "Endpoint order must be a positive integer",
"expression": "value.integer > 0"
}
]
}
]
}
}