Extensions
Extension-England-EndpointBusinessScenario
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointBusinessScenario | draft | 0.1.0 | 2025-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
Detailed Descriptions
Extension | |
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 |
|
Mappings |
|
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 |
|
Extension.extension | |
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 |
Constraints |
|
Mappings |
|
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-EndpointBusinessScenario |
Mappings |
|
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). |
Cardinality | 1..1 |
Type | code |
Binding | |
Constraints |
|
Mappings |
|
XML View
JSON View
Extension-England-EndpointCompression
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-EndpointCompression | draft | 0.1.0 | 2025-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
Detailed Descriptions
Extension | |
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 |
|
Mappings |
|
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 |
|
Extension.extension | |
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 |
Constraints |
|
Mappings |
|
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-EndpointCompression |
Mappings |
|
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. |
Cardinality | 1..1 |
Type | boolean |
Constraints |
|
Mappings |
|
XML View
JSON View
Extension-England-LocationExtension
Tree View
ExtensionEnglandLocationExtension (Extension) | C | Extension | |
id | 0..1 | string | |
extension | C | 0..* | Extension |
UPRN | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
PAF | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
eastings | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
northings | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
what3words | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
accuracy | C | 0..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueString | string | ||
url | 1..1 | uriFixed Value | |
value[x] | 0..0 |
Detailed Descriptions
Extension | |
Short | Optional Extensions Element |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0..* |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Constraints |
|
Mappings |
|
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 |
|
Extension.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:UPRN | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:UPRN.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 |
|
Extension.extension:UPRN.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:UPRN.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 | UPRN |
Mappings |
|
Extension.extension:UPRN.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
Extension.extension:PAF | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:PAF.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 |
|
Extension.extension:PAF.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:PAF.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 | PAF |
Mappings |
|
Extension.extension:PAF.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
Extension.extension:eastings | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:eastings.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 |
|
Extension.extension:eastings.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:eastings.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 | eastings |
Mappings |
|
Extension.extension:eastings.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
Extension.extension:northings | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:northings.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 |
|
Extension.extension:northings.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:northings.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 | northings |
Mappings |
|
Extension.extension:northings.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
Extension.extension:what3words | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:what3words.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 |
|
Extension.extension:what3words.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:what3words.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 | what3words |
Mappings |
|
Extension.extension:what3words.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
Extension.extension:accuracy | |
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..1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Constraints |
|
Mappings |
|
Extension.extension:accuracy.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 |
|
Extension.extension:accuracy.extension | |
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..* |
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 |
Constraints |
|
Mappings |
|
Extension.extension:accuracy.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 | accuracy |
Mappings |
|
Extension.extension:accuracy.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..1 |
Type | string |
Constraints |
|
Mappings |
|
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-LocationExtension |
Mappings |
|
Extension.value[x] | |
Short | Value of extension |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Cardinality | 0..0 |
Type | base64Binary, 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 |
|
Mappings |
|
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
JSON View
Extension-England-OrganizationEndpointOrder
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganizationEndpointOrder | draft | 0.1.0 | 2025-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
Detailed Descriptions
Extension | |
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 |
|
Mappings |
|
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 |
|
Extension.extension | |
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 |
Constraints |
|
Mappings |
|
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 |
|
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 | integer |
Constraints |
|
Mappings |
|