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" />
<contact>
<name value="NHS England" />
<telecom>
<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" />
<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="integer" />
</type>
<constraint>
<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",
"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": "integer"
}
],
"constraint": [
{
"key": "nhse-endp-001",
"severity": "error",
"human": "Endpoint order must be a positive integer",
"expression": "value.integer > 0"
}
]
}
]
}
}