NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Extension: nhsd-booking-provider

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider | Version: 4.0.1
Draft as of 2025-09-04 | Computable Name: nhsd-booking-provider
Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved.

Indicates the details of a Booking Provider offering a url or id to support intergation or click-throughs for Booking Pages

Supports Booking Provider links and other integration attributes

Context of Use

This extension may be used on the following element(s)

- Extension: HealthcareService

Extension: nhsd-booking-provider

Usage info

Usages:

- Use this Extension: NHSD HealthcareService

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension | C | 0..* | Extension | Extension Constraints: booking-provider
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Describes the booking provider or booking vendor
url |  | 1..1 | uri | "provider"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 0..1 | Coding | Value of extension
extension:provider-uri |  | 0..1 | Extension | The web accessible URL
url |  | 1..1 | uri | "provider-uri"
Slices for valueUri |  |  |  | Content/Rules for all slices
valueUri:valueUri |  | 0..1 | uri | Value of extension
extension:provider-identifier |  | 0..1 | Extension | The booking provider integration identifier.
url |  | 1..1 | uri | "provider-identifier"
Slices for valueString |  |  |  | Content/Rules for all slices
valueString:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
value[x] |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension | C | 0..* | Extension | Extension Constraints: booking-provider
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Describes the booking provider or booking vendor
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider"
Slices for value[x] |  | 0..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding |  | 0..1 | Coding | Value of extension
extension:provider-uri |  | 0..1 | Extension | The web accessible URL
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider-uri"
Slices for value[x] |  | 0..1 | uri | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUri |  | 0..1 | uri | Value of extension
extension:provider-identifier |  | 0..1 | Extension | The booking provider integration identifier.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider-identifier"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Indicates the details of a Booking Provider offering a url or id to support intergation or click-throughs for Booking Pages

- provider: Coding: The booking provider offering this URL or integration option.
- provider-uri: uri: The url offered within this attribute is web accessible and is to be clicked through.
- provider-identifier: string: Some providers offer realtime integration capabilities in order to obtain booking availability. This services may be made available as a single integration endpoint by the NHSD, however this may be dependant on license agreements. In the event where direct integration is required, this identifier shall offer the unique lookup option.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension | C | 0..* | Extension | Extension Constraints: booking-provider
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Describes the booking provider or booking vendor
url |  | 1..1 | uri | "provider"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 0..1 | Coding | Value of extension
extension:provider-uri |  | 0..1 | Extension | The web accessible URL
url |  | 1..1 | uri | "provider-uri"
Slices for valueUri |  |  |  | Content/Rules for all slices
valueUri:valueUri |  | 0..1 | uri | Value of extension
extension:provider-identifier |  | 0..1 | Extension | The booking provider integration identifier.
url |  | 1..1 | uri | "provider-identifier"
Slices for valueString |  |  |  | Content/Rules for all slices
valueString:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
value[x] |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension | C | 0..* | Extension | Extension Constraints: booking-provider
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Describes the booking provider or booking vendor
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider"
Slices for value[x] |  | 0..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding |  | 0..1 | Coding | Value of extension
extension:provider-uri |  | 0..1 | Extension | The web accessible URL
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider-uri"
Slices for value[x] |  | 0..1 | uri | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueUri |  | 0..1 | uri | Value of extension
extension:provider-identifier |  | 0..1 | Extension | The booking provider integration identifier.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider-identifier"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Indicates the details of a Booking Provider offering a url or id to support intergation or click-throughs for Booking Pages

- provider: Coding: The booking provider offering this URL or integration option.
- provider-uri: uri: The url offered within this attribute is web accessible and is to be clicked through.
- provider-identifier: string: Some providers offer realtime integration capabilities in order to obtain booking availability. This services may be made available as a single integration endpoint by the NHSD, however this may be dependant on license agreements. In the event where direct integration is required, this identifier shall offer the unique lookup option.

Other representations of profile: CSV, Excel, Schematron

#### Constraints

Id | Grade | Path(s) | Details | Requirements
booking-provider | error | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

### Notes:

Please refer to NHSD HealthcareSerOvice for implementation examples on booking provider usage.