nhsd-booking-provider - NHSD Implementation Guide

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 2026-10-26				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
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:provider		1..1	Extension	Describes the booking provider or booking vendor
Extension.Slices for extension.extension:provider.url		1..1	uri	"provider"
Extension.Slices for extension.extension:provider.Slices for valueCoding				Content/Rules for all slices
Extension.Slices for extension.extension:provider.Slices for valueCoding.valueCoding:valueCoding		0..1	Coding	Value of extension
Extension.Slices for extension.extension:provider-uri		0..1	Extension	The web accessible URL
Extension.Slices for extension.extension:provider-uri.url		1..1	uri	"provider-uri"
Extension.Slices for extension.extension:provider-uri.Slices for valueUri				Content/Rules for all slices
Extension.Slices for extension.extension:provider-uri.Slices for valueUri.valueUri:valueUri		0..1	uri	Value of extension
Extension.Slices for extension.extension:provider-identifier		0..1	Extension	The booking provider integration identifier.
Extension.Slices for extension.extension:provider-identifier.url		1..1	uri	"provider-identifier"
Extension.Slices for extension.extension:provider-identifier.Slices for valueString				Content/Rules for all slices
Extension.Slices for extension.extension:provider-identifier.Slices for valueString.valueString:valueString		0..1	string	Value of extension
Extension.url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
Extension.value[x]		0..0		Value of extension
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	Extension Constraints: booking-provider
Extension.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:provider		1..1	Extension	Describes the booking provider or booking vendor
Extension.Slices for extension.extension:provider.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider.url		1..1	uri	"provider"
Extension.Slices for extension.extension:provider.Slices for value[x]		0..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider.Slices for value[x].value[x]:valueCoding		0..1	Coding	Value of extension
Extension.Slices for extension.extension:provider-uri		0..1	Extension	The web accessible URL
Extension.Slices for extension.extension:provider-uri.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider-uri.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider-uri.url		1..1	uri	"provider-uri"
Extension.Slices for extension.extension:provider-uri.Slices for value[x]		0..1	uri	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider-uri.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider-uri.Slices for value[x].value[x]:valueUri		0..1	uri	Value of extension
Extension.Slices for extension.extension:provider-identifier		0..1	Extension	The booking provider integration identifier.
Extension.Slices for extension.extension:provider-identifier.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider-identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider-identifier.url		1..1	uri	"provider-identifier"
Extension.Slices for extension.extension:provider-identifier.Slices for value[x]		0..1	string	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider-identifier.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider-identifier.Slices for value[x].value[x]:valueString		0..1	string	Value of extension
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
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:provider		1..1	Extension	Describes the booking provider or booking vendor
Extension.Slices for extension.extension:provider.url		1..1	uri	"provider"
Extension.Slices for extension.extension:provider.Slices for valueCoding				Content/Rules for all slices
Extension.Slices for extension.extension:provider.Slices for valueCoding.valueCoding:valueCoding		0..1	Coding	Value of extension
Extension.Slices for extension.extension:provider-uri		0..1	Extension	The web accessible URL
Extension.Slices for extension.extension:provider-uri.url		1..1	uri	"provider-uri"
Extension.Slices for extension.extension:provider-uri.Slices for valueUri				Content/Rules for all slices
Extension.Slices for extension.extension:provider-uri.Slices for valueUri.valueUri:valueUri		0..1	uri	Value of extension
Extension.Slices for extension.extension:provider-identifier		0..1	Extension	The booking provider integration identifier.
Extension.Slices for extension.extension:provider-identifier.url		1..1	uri	"provider-identifier"
Extension.Slices for extension.extension:provider-identifier.Slices for valueString				Content/Rules for all slices
Extension.Slices for extension.extension:provider-identifier.Slices for valueString.valueString:valueString		0..1	string	Value of extension
Extension.url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider"
Extension.value[x]		0..0		Value of extension
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	C	0..*	Extension	Extension Constraints: booking-provider
Extension.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:provider		1..1	Extension	Describes the booking provider or booking vendor
Extension.Slices for extension.extension:provider.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider.url		1..1	uri	"provider"
Extension.Slices for extension.extension:provider.Slices for value[x]		0..1	Coding	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider.Slices for value[x].value[x]:valueCoding		0..1	Coding	Value of extension
Extension.Slices for extension.extension:provider-uri		0..1	Extension	The web accessible URL
Extension.Slices for extension.extension:provider-uri.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider-uri.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider-uri.url		1..1	uri	"provider-uri"
Extension.Slices for extension.extension:provider-uri.Slices for value[x]		0..1	uri	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider-uri.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider-uri.Slices for value[x].value[x]:valueUri		0..1	uri	Value of extension
Extension.Slices for extension.extension:provider-identifier		0..1	Extension	The booking provider integration identifier.
Extension.Slices for extension.extension:provider-identifier.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:provider-identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:provider-identifier.url		1..1	uri	"provider-identifier"
Extension.Slices for extension.extension:provider-identifier.Slices for value[x]		0..1	string	Value of extension Slice: Unordered, Closed by type:$this
Extension.Slices for extension.extension:provider-identifier.Slices for value[x]				Content/Rules for all slices
Extension.Slices for extension.extension:provider-identifier.Slices for value[x].value[x]:valueString		0..1	string	Value of extension
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)	Description	Expression
booking-provider	error	Extension	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.

IG © 2022+ Healthdirect Australia. Package nhsd.org.au.r4#4.0.1 based on FHIR 4.0.1. Generated 2026-10-26
Links: Table of Contents | QA Report | Version History |