Directory of Service (Interoperability Standard)

Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Extension-England-OrganizationEndpointOrder

Canonical_URL	Status	Current_Version	Last_Updated	Description	Profile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder	draft	0.2.0	2026-05-14	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

ExtensionEnglandOrganizationEndpointOrder (Extension)	C		Extension	There are no (further) constraints on this element Element id Extension Short description Optional Extensions Element Definition Optional Extension Element - found in all resources. Data type Extension Conditions The 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
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique 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. Data type string Mappings rim: n/a
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Conditions The 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
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data type uri Fixed value https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder Mappings rim: N/A
value[x]		1..1		Element id Extension.value[x] Short description 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.). Conditions The 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())` Mappings rim: n/a rim: N/A
valuePositiveInt			positiveInt	Data type positiveInt

Detailed Descriptions

Extension		C
Short	Optional Extensions Element
Definition	Optional Extension Element - found in all resources.
Cardinality	0..1
Conditions	The 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
Short	Unique 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.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension		C
Short	Additional 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.
Cardinality	0..0
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Conditions	The 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.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder
Mappings	rim: N/A
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.).
Cardinality	1..1
Type	positiveInt
Conditions	The 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())`
Mappings	rim: n/a rim: N/A

Table View

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

XML View

<id value="Extension-England-OrganizationEndpointOrder" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder" />
<version value="0.2.0" />
<name value="ExtensionEnglandOrganizationEndpointOrder" />
<title value="Extension England Organization Endpoint Order" />
<status value="draft" />
<date value="2026-05-14" />
<publisher value="NHS England" />
<contact>
<name value="NHS England" />
<telecom>
<system value="email" />
<value value="england.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 © 2026+ 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" />
<context>
<type value="element" />
<expression value="Endpoint" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<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" />
<type>
<code value="positiveInt" />
</type>
</element>
</differential>

</StructureDefinition>

JSON View

{

"resourceType": "StructureDefinition",
"id": "Extension-England-OrganizationEndpointOrder",
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder",
"version": "0.2.0",
"name": "ExtensionEnglandOrganizationEndpointOrder",
"title": "Extension England Organization Endpoint Order",
"status": "draft",
"date": "2026-05-14",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "england.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 © 2026+ 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": "Endpoint"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"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": "positiveInt"
}
]
}
]
}

}

Extension-England-OrganizationEndpointOrder

Tree View

Detailed Descriptions

Table View

XML View

JSON View

Propose a change to Extension-England-OrganizationEndpointOrder