NHSD HealthcareService - NHSD Implementation Guide

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

Resource Profile: NHSD HealthcareService

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-healthcareservice				Version: 4.0.1
Draft as of 2023-11-21				Computable Name: NHSDHealthcareService
Copyright/Legal: Copyright © 2022 Healthdirect Australia - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

A National Health Services Directory (NHSD) Service

An extended resource providing additional information on the HealthcareService not offered by the AU-BASE.

NHSD Provider directory entry for a healthcare service or category of services delivered at a location by an organisation. In a provider directory this allows the association of endpoints with the healthcare service and thus a channel for delivery to that service.

NHSD HealthcareService Resource

Eligibility pairs. (as AU-BASE Extension)
identifier included and sliced for various vendor identifiers (VDI), which currently includes secure messaging vendor endpoint identifiers.
telecom, includes an optional contact purpose - noting purpose specific contact information. (as NHSD Extension - au-contact-purpose)
availableTime, includes either
- “daysOfWeek” or
- “availability-reason” as NHSD extension (with holiday code) or
- “availability-specificDate” as NHSD extension with a single date or
- "availableTimeApplicability" as NHSD extension with a date range
- availability-specificDate or availableTimeApplicability must not contain a recognised public date in a given year
- For public holidays "availability-reason" extension must be used.
availableTime, includes timezone information in which the service operates (as NHSD Extension - timezone)
notAvailable, includes timezone information in which the service operates (as NHSD Extension - timezone)
coverageArea, supported through CONTAINED resources and searchable via either postcode alone or postcode and suburb combination.
bookingProvider, supported through as extension, offering URLs to support online bookings.
Transient Information - Operational status information - noting if the service is currently open, or will be open soon. (as NHSD Extension - operationalStatus)
Transient Information - Proximity information included within response (as NHSD Extension - proximity-distance)
Not supported: specialty (refer to type)
Not supported: category (refer to type) - category shall be added in due course
Not supported: photo
Not supported: eligibility & eligibilityNote (see Extension healthcareservice-eligibility-detail)
Not supported: availabilityExceptions

Examples

Healthcare Service Directory Entry Example

Usages:

Refer to this Profile: NHSD Practitioner Role

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id	Σ	1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta	Σ	1..1	Meta	Metadata about Healthcare Service resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
lastUpdated	Σ	1..1	instant	The timestamp when the resource was last updated
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
Slices for identifier	SΣ	0..*	Identifier	Healthcare service identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:rid	SΣ	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active	?!SΣ	1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy	SΣ	1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
coding	Σ	1..*	Coding	Code defined by a terminology system
Slices for specialty				Content/Rules for all slices
location	SΣ	1..1	Reference(NHSD Location)	Reference to the Location resource.
name	SΣ	0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment	Σ	0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
telecom	S	0..*	ContactPoint	Contact information related to the Healthcare Service
Slices for extension				Content/Rules for all slices
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system	ΣC	1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: facilities
coding	Σ	0..*	Coding	-
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding	Σ	0..*	Coding	-
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding	Σ	0..*	Coding	-
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding	Σ	0..*	Coding	-
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: offerings
coding	Σ	0..*	Coding	-
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:nhsd-availability-specificDate	Σ	0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason	Σ	0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
Slices for extension				Content/Rules for all slices
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
endpoint	S	0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HealthcareService.identifier:hpio.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:hpio.type	required	Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:pdvendor.type	required	http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic	example
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.div.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()

This structure is derived from AUPDHealthcareService

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id		1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta		1..1	Meta	Metadata about Healthcare Service resource
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
versionId		0..0
lastUpdated		1..1	instant	The timestamp when the resource was last updated
source		0..0
profile		0..0
security		0..0
tag		0..0
implicitRules		0..0
language		0..0
text		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
modifierExtension		0..0
identifier		0..*	Identifier	Healthcare service identifiers
Slices for identifier				Content/Rules for all slices
identifier:hpio		0..0
identifier:pdvendor		0..0
identifier:rid	S	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active		1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy		1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
category		0..0
type		1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
id		0..0
coding		1..*	Coding	Code defined by a terminology system
Slices for specialty				Content/Rules for all slices
specialty:snomedRole		0..0
location		1..1	Reference(NHSD Location)	Reference to the Location resource.
name		0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment		0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
extraDetails		0..0
photo		0..0
telecom		0..*	ContactPoint	Contact information related to the Healthcare Service
id		0..0
Slices for extension				Content/Rules for all slices
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system		1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value		1..1	string	The actual contact point details
use		0..0
rank		0..0
period		0..0
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: facilities
coding		0..*	Coding	-
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding		0..*	Coding	-
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding		0..*	Coding	-
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding		0..*	Coding	-
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: offerings
coding		0..*	Coding	-
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod		0..0
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension				Content/Rules for all slices
modifierExtension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
availableStartTime
id		0..0
extension		0..0
value		0..0
availableEndTime
id		0..0
extension		0..0
value		0..0
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..0
Slices for extension				Content/Rules for all slices
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
availabilityExceptions		0..0
endpoint		0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id	Σ	1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta	Σ	1..1	Meta	Metadata about Healthcare Service resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
lastUpdated	Σ	1..1	instant	The timestamp when the resource was last updated
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
Slices for identifier	SΣ	0..*	Identifier	Healthcare service identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:rid	SΣ	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active	?!SΣ	1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy	SΣ	1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
Slices for specialty				Content/Rules for all slices
location	SΣ	1..1	Reference(NHSD Location)	Reference to the Location resource.
name	SΣ	0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment	Σ	0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
telecom	S	0..*	ContactPoint	Contact information related to the Healthcare Service
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system	ΣC	1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: facilities
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: offerings
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:nhsd-availability-specificDate	Σ	0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason	Σ	0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
daysOfWeek		0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
endpoint	S	0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HealthcareService.identifier:hpio.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:hpio.type	required	Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:pdvendor.type	required	http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.assigner.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic	example
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week\|4.0.0` From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.div.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()

This structure is derived from AUPDHealthcareService

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 3 elements
Fixed: 5 elements
Prohibited: 31 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of HealthcareService.characteristic

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id	Σ	1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta	Σ	1..1	Meta	Metadata about Healthcare Service resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
lastUpdated	Σ	1..1	instant	The timestamp when the resource was last updated
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
Slices for identifier	SΣ	0..*	Identifier	Healthcare service identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:rid	SΣ	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active	?!SΣ	1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy	SΣ	1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
coding	Σ	1..*	Coding	Code defined by a terminology system
Slices for specialty				Content/Rules for all slices
location	SΣ	1..1	Reference(NHSD Location)	Reference to the Location resource.
name	SΣ	0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment	Σ	0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
telecom	S	0..*	ContactPoint	Contact information related to the Healthcare Service
Slices for extension				Content/Rules for all slices
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system	ΣC	1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: facilities
coding	Σ	0..*	Coding	-
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding	Σ	0..*	Coding	-
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding	Σ	0..*	Coding	-
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding	Σ	0..*	Coding	-
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
url		1..1	uri	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: offerings
coding	Σ	0..*	Coding	-
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:nhsd-availability-specificDate	Σ	0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason	Σ	0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
Slices for extension				Content/Rules for all slices
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
endpoint	S	0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HealthcareService.identifier:hpio.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:hpio.type	required	Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:pdvendor.type	required	http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic	example
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.div.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()

Differential View

This structure is derived from AUPDHealthcareService

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id		1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta		1..1	Meta	Metadata about Healthcare Service resource
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
versionId		0..0
lastUpdated		1..1	instant	The timestamp when the resource was last updated
source		0..0
profile		0..0
security		0..0
tag		0..0
implicitRules		0..0
language		0..0
text		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
modifierExtension		0..0
identifier		0..*	Identifier	Healthcare service identifiers
Slices for identifier				Content/Rules for all slices
identifier:hpio		0..0
identifier:pdvendor		0..0
identifier:rid	S	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active		1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy		1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
category		0..0
type		1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
id		0..0
coding		1..*	Coding	Code defined by a terminology system
Slices for specialty				Content/Rules for all slices
specialty:snomedRole		0..0
location		1..1	Reference(NHSD Location)	Reference to the Location resource.
name		0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment		0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
extraDetails		0..0
photo		0..0
telecom		0..*	ContactPoint	Contact information related to the Healthcare Service
id		0..0
Slices for extension				Content/Rules for all slices
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system		1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value		1..1	string	The actual contact point details
use		0..0
rank		0..0
period		0..0
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: facilities
coding		0..*	Coding	-
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding		0..*	Coding	-
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding		0..*	Coding	-
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding		0..*	Coding	-
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
Slices for valueString				Content/Rules for all slices
valueString:valueString		1..1	string	Value of extension Fixed Value: offerings
coding		0..*	Coding	-
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod		0..0
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
id		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension				Content/Rules for all slices
modifierExtension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
availableStartTime
id		0..0
extension		0..0
value		0..0
availableEndTime
id		0..0
extension		0..0
value		0..0
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..0
Slices for extension				Content/Rules for all slices
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
availabilityExceptions		0..0
endpoint		0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
HealthcareService		0..*	AUPDHealthcareService	A healthcare service in an Australian healthcare context e.g., a healthcare service provided at a site
id	Σ	1..1	id	Logical FHIR id for unique identification of the Healthcare Service resource within the FHIR bundle
meta	Σ	1..1	Meta	Metadata about Healthcare Service resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:proximityDistance		0..1	decimal	The distance in meters/kilometers of the service URL: http://fhir.nhsd.com.au/StructureDefinition/proximity-distance
extension:operationalStatus		0..1	(Complex)	Operational status of the service URL: http://fhir.nhsd.com.au/StructureDefinition/operationalStatus
lastUpdated	Σ	1..1	instant	The timestamp when the resource was last updated
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bookingProvider		0..*	(Complex)	Information about Booking Providers for a Healthcare Service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-booking-provider
Slices for identifier	SΣ	0..*	Identifier	Healthcare service identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:rid	SΣ	0..1	NHSDResourceIdentifier	Healthcare service identifiers
active	?!SΣ	1..1	boolean	Reflects the current status of the Healthcare Service resource
providedBy	SΣ	1..1	Reference(NHSD Organisation)	Reference to the Organization resource that provides the service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed. Each HealthcareService resource must have only 1 preferred service type Binding: Healthcare Service Types SNOMED-CT (preferred)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
Slices for specialty				Content/Rules for all slices
location	SΣ	1..1	Reference(NHSD Location)	Reference to the Location resource.
name	SΣ	0..1	string	Healthcare Service name, which may include department level information for Hospitals.
comment	Σ	0..1	string	A short description of the Healthcare Service, which may include additional information not covered elsewhere.
telecom	S	0..*	ContactPoint	Contact information related to the Healthcare Service
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactPurpose	S	0..*	CodeableConcept	The contact purpose for the resource URL: http://fhir.nhsd.com.au/StructureDefinition/au-contact-purpose Binding: Contact Purpose (required)
system	ΣC	1..1	code	phone \| fax \| email \| url Binding: Contact Point System (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
coverageArea		0..*	Reference(Location)	Reference to the list of 'contained' Location resources defining the coverage area of virtual/home visit type of Healthcare Services.
serviceProvisionCode		0..1	CodeableConcept	Reflects the billing option type the Healthcare Service supports Binding: Healthcare Service Provision Conditions (required)
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility criteria (required): Eligibility for service provided by Healthcare provider
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Name of program(s) that the Healthcare Service is a part of Binding: Healthcare Service Programs (Funded or Unfunded) (extensible): Name of program(s) that the Healthcare Service is a part of
Slices for characteristic		0..*	CodeableConcept	Various characteristics of the Healthcare Service like offering etc Slice: Unordered, Open by value:coding.system Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
characteristic:facility		0..*	CodeableConcept	Facilities available or provided at a Healthcare Service location Binding: Healthcare Service Facilities (required): Facilities available or provided at a Healthcare Service location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:facilities-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: facilities
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:fundingsource		0..*	CodeableConcept	Funding Sources which support this Healthcare Service. Binding: Healthcare Service Funding Sources (required): Funding Sources which support this Healthcare Service.
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:fundingsource-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: fundingSource
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:healthcareServiceCharacteristic		0..*	CodeableConcept	Miscellaneous characteristics of a Healthcare Service Binding: Healthcare Service miscellaneous characteristics (required): Miscellaneous characteristics of a Healthcare Service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:plsc-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: characteristics
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:referralInformation		0..*	CodeableConcept	Referral Instructions and Information Binding: Healthcare Service referral instructions and information (required): Referral Instructions and Information
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:referral-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: referralInformation
extension:referralInstruction		0..1	string	Referral Instructions and Information URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
characteristic:offering		0..*	CodeableConcept	This contains the list of various offerings that the Healthcare Service has Binding: Healthcare Service Offerings (required): Supporting services offered at a Healthcare Service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:offering-characteristic-group		1..1	(Complex)	- URL: http://fhir.nhsd.com.au/StructureDefinition/characteristic-group
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	"http://fhir.nhsd.com.au/StructureDefinition/characteristic-group"
Slices for value[x]		1..1	string	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		1..1	string	Value of extension Fixed Value: offerings
coding	Σ	0..*	Coding	-
text	Σ	0..1	string	Plain text representation of the concept
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
appointmentRequired		0..1	boolean	It indicates if an appointment is required for this Healthcare Service
availableTime		0..*	BackboneElement	Times the Healthcare Service is available
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:nhsd-availability-specificDate	Σ	0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
modifierExtension:nhsd-availability-reason	Σ	0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
daysOfWeek		0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nhsd-availability-specificDate		0..1	string	The specific date at which a service is available or not available URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-specificDate
extension:nhsd-availability-reason		0..1	CodeableConcept	Australian Public Holidays URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-availability-reason Binding: Australian Public Holidays 2025 (required)
extension:nhsd-timezone		0..1	CodeableConcept	Information about time zone for a Healthcare Service. NHSD supports ONLY ONE time zone per service URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-timezone Binding: Australian States and Territories timezones (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
endpoint	S	0..*	Reference(NHSD Secure Messaging Endpoint)	NHSD supports Healthcare Service to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HealthcareService.identifier:hpio.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:hpio.type	required	Pattern Value: NOI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.0` From the FHIR Standard
HealthcareService.identifier:pdvendor.type	required	http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
HealthcareService.identifier:pdvendor.assigner.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
HealthcareService.type	preferred	Healthcare Service Types SNOMED-CT(a valid code from Standard list of Healthcare Service Types SNOMED-CT) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareservice-serviceType` From this IG
HealthcareService.telecom.system	required	Contact Point System(a valid code from Standard List of Telecommunications form for contact point) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-contact-point-system` From this IG
HealthcareService.serviceProvisionCode	required	Healthcare Service Provision Conditions `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-service-provision-conditions` From this IG
HealthcareService.eligibility.code	required	Healthcare Service Eligibility criteria(a valid code from Standard list of Healthcare Service Eligibility criteria) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-eligibility` From this IG
HealthcareService.program	extensible	Healthcare Service Programs (Funded or Unfunded)(a valid code from Standard list of Healthcare Service Programs (Funded or Unfunded)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-program` From this IG
HealthcareService.characteristic	example
HealthcareService.characteristic:facility	required	Healthcare Service Facilities(a valid code from Standard List of Facilities available at Healthcare Services) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-facility` From this IG
HealthcareService.characteristic:fundingsource	required	Healthcare Service Funding Sources(a valid code from `http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource`) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-fundingSource` From this IG
HealthcareService.characteristic:healthcareServiceCharacteristic	required	Healthcare Service miscellaneous characteristics(a valid code from Standard list of Healthcare Service miscellaneous characteristics) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-healthcareServiceCharacteristic` From this IG
HealthcareService.characteristic:referralInformation	required	Healthcare Service referral instructions and information(a valid code from Standard list of Healthcare Service Referral Information and Instruction categories) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-referralInformation` From this IG
HealthcareService.characteristic:offering	required	Healthcare Service Offerings(a valid code from Standard list of supporting services offered at a Healthcare Service) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-offering` From this IG
HealthcareService.communication	required	CommonLanguagesInAustralia `https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2` From https://tx.ontoserver.csiro.au/fhir
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week\|4.0.0` From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.div.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()

This structure is derived from AUPDHealthcareService

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 3 elements
Fixed: 5 elements
Prohibited: 31 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of HealthcareService.characteristic

Other representations of profile: CSV, Excel, Schematron

Notes:

Operation	Format	Example
Read	GET [base]/HealthcareService/[id]	GET [base]/HealthcareService/9680fa57-554e-68a1-839a-63d44e501802
search	POST [base]/HealthcareService/_search

Operation

Format

Example

Read

GET [base]/HealthcareService/[id]

GET [base]/HealthcareService/9680fa57-554e-68a1-839a-63d44e501802

search

POST [base]/HealthcareService/_search

IMPORTANT NOTES ON SEARCH BEHAVIOUR

NHSD recommends search using POST with for complex search scenarios.

For further information and examples, refer to the capability statement

Extended Characteristic Value Sample

For some of the characteristics within a Healthcare Service there are additional information that pertains to the coding. These may be notes or values (noted as a characteristic-value OR a characteristic-extendedValues) Please note that these extensions shall be incorporated into AU-BASE profile(s) - this the Extension URI will change (this not was added on 3 october 2018)

The extensions define information as follows:

http://fhir.nhsd.com.au/StructureDefinition/characteristic-group - a grouping to support User Interfaces or other program logic.
http://fhir.nhsd.com.au/StructureDefinition/characteristic-value - a simplistic value that determines if/whether the characteristic applies or not (eg. Bulk Billing = no, or Free Parking = yes)

http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues - a complex extension that provides additional information, which at this time only supports a "note"

{
  "characteristic": [{
      "extension": [{
          "url": "http://fhir.nhsd.com.au/StructureDefinition/characteristic-group",
          "valueString": "referralInformation"
      },
      {
          "url": "http://fhir.nhsd.com.au/StructureDefinition/characteristic-value",
          "valueString": "yes"
      },
      {
          "url": "http://fhir.nhsd.com.au/StructureDefinition/characteristic-extendedValues",
          "extension": [{
              "url": "note",
              "valueString": "Service accepts self referral"
          }]
      }],
      "coding": [{
          "system": "http://fhir.nhsd.com.au/CodeSystem/rc-referralInformation",
          "code": "forPublicUse",
          "display": "For Public Use"
      }]
  }
}

Healthcare Service and Location Types:

The NHSD FHIR Server contains three distinct types of Healthcare Services, relating to both the Location and the Healthcare Service delivery type.

Location Delivery Type	Code	Description	Parameter
Physical Service	si	A Physical location, where the patient is able to visit a room or building	location.physicalType=si
Home Visit	home	A Home Visit based location grouping, where all the Healthcare Services linked to this Location are considered HOME VISIT services. These are predominantly services such as Home Meal Services, Home Doctor Services, but not strictly limited thereto. Distance based search behaviours are not compatible with this Location Delivery Type	location.physicalType=home
Virtual	virtual	A Virtual or Online based location grouping, where all the Healthcare Services linked to this Location are considered VIRTUAL services. These may include, but not limited to websites, online help lines, emergency services, etc. Distance based search behaviours are not compatible with this Location Delivery Type	location.physicalType=virtual

Location Delivery Type

Code

Description

Parameter

Physical Service

A Physical location, where the patient is able to visit a room or building

location.physicalType=si

Home Visit

home

A Home Visit based location grouping, where all the Healthcare Services linked to this Location are considered HOME VISIT services. These are predominantly services such as Home Meal Services, Home Doctor Services, but not strictly limited thereto. Distance based search behaviours are not compatible with this Location Delivery Type

location.physicalType=home

Virtual

virtual

A Virtual or Online based location grouping, where all the Healthcare Services linked to this Location are considered VIRTUAL services. These may include, but not limited to websites, online help lines, emergency services, etc. Distance based search behaviours are not compatible with this Location Delivery Type

location.physicalType=virtual

Read: HealthcareService

Read by Resource Id Read identified healthcare service resource content.

GET [base]/HealthcareService/[id]
Example: GET [base]/HealthcareService/9680fa57-554e-68a1-839a-63d44e501802

Read resource using resource Id and Include references

GET [base]/HealthcareService?_id=[id]&_include=HealthcareService:location&_include=HealthcareService:organization
Example: GET [base]/HealthcareService?_id=9680fa57-554e-68a1-839a-63d44e501802&_include=HealthcareService:location&_include=HealthcareService:organization

Support:

NHSD support read a Healthcare service by id

Implementation Notes:

Search: Healthcare Services

Search by Location Delivery Method Search for a healthcare service by Location Delivery Method.

- SITE VISIT    => [base]/HealthcareService?location.physicalType=si
- PHONE/VIRTUAL => [base]/HealthcareService?location.physicalType=virtual
- HOME          => [base]/HealthcareService?location.physicalType=home

Search by Name Search for a healthcare service by name.

GET [base]/HealthcareService?name=[string]

Example: 
GET [base]/HealthcareService?name=bishops%20bridge%20Community%20Health
GET [base]/HealthcareService?name=Lismore Base Hospital clinic

Support:

Search by HealthcareService name.

Implementation Notes:

Search by Identifiers Search for a healthcare service by an identifier.

GET [base]/HealthcareService?name=[string]&identifier=[system]|[code]

Example:

GET [base]/HealthcareService?identifier=http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#ssid|169459
GET [base]/HealthcareService?identifier=http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers%23ssid|169459

Support: NHSD FHIR Server support search Healthcare Service by identifier. With the primary identifiers being:

Electronic ID's

Implementation Notes:

Search by Healthcare Service Type Search for a Healthcare Service based on the TYPE of service it provides or offers. A "General Practitioner Service" or "Dentist Service".

GET [base]/HealthcareService?service-type=[system]|[code]

Example:
GET [base]/HealthcareService?service-type=nhsd:/reference/taxonomies/snomed-servicetype|1223091000168105

Support:

Supports search HealthcareService by type classification.
Single Token and Multi-Token (OR) is supported
- Multi-Token is to be implemented in September 2018
- GET GET [base]/HealthcareService?service-type=nhsd:/reference/taxonomies/snomed-servicetype|1223091000168105,nhsd:/reference/taxonomies/snomed-servicetype|1255941000168103

Not Supported

NHSD does not support TEXT based search on the codesystem labels
NHSD does not support HealthcareService.specialty search

Implementation Notes:

Search by Service Provision Code Search based on service provision code token.

GET [base]/HealthcareService?serviceProvisionCode=[system]|[value]

Example: GET [base]/HealthcareService/?serviceProvisionCode=http://hl7.org/fhir/service-provision-conditions|free

Support:

Support search by serviceProvisionCode.

Implementation Notes:

Search by Location Address Parts Chained search (via Location) based on address parts for postcode, suburb, and state.

GET [base]/HealthcareService?location.address-postalcode=[postcode]
GET [base]/HealthcareService?location.address-city=[suburb]
GET [base]/HealthcareService?location.address-state=[state]

Example: 
GET [base]/HealthcareService?location.address-postalcode=2328
GET [base]/HealthcareService?location.address-city=Denman
GET [base]/HealthcareService?location.address-state=NSW

Support:

NHSD support search by multiple postcode, suburb and state but it will return results matching all the postcode, suburb and state. The results are not filtered with the relationship across the parameters.
Support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value. Please refer to the example below for multiple param search.

Example:
GET [base]/HealthcareService?_format=json&location.address-city=Denman,NORTH%20SYDNEY&_include=HealthcareService:location
GET [base]/HealthcareService?_format=json&_include=HealthcareService:organization

Search by Location Distance Chained search (via Location) for a location within a nominated distance.

GET [base]/HealthcareService?location.near=[latitude]:[longitude]&location.near-distance=[prefix][value]|[units-system]|[units]

Example:
GET [base]/HealthcareService?location.near=-32.81:151.43&location.near-distance=le4000|http://unitsofmeasure.org|km

Support:

[prefix] fixed 'le' is less than or equal to distance
[value] is a decimal quantity number
[units-system] fixed 'http://unitsofmeasure.org' identifies standard distance units are used
[units] distance units must support 'km' or 'm'

Implementation Notes:

Search by Coverage Provides the ability to search Healthcare Services which operate or provide care in a limited area (the coverage area).

The coverage area is normally associated with Phone Line services (Virtual) or Home treatment services (Home Visit).

Example:
GET [base]/HealthcareService?coverageArea.address-postalcode=2000&location.physicalType=home
GET [base]/HealthcareService?coverageArea.address-postalcode=2000&location.physicalType=virtual
GET [base]/HealthcareService?location.physicalType=virtual,home&coverageArea.address-postalcode=6042&coverageArea.address-city=SEABIRD

Support:

Coverage Area search is currently only supported with the following attributes:

address-postalcode only
combination of address-postalcode and address-city

Search By calendar Search based on Calendar for service open now and open at a specific date an time.

GET [base]/HealthcareService?openNow=[true/false]
GET [base]/HealthcareService?openAt=[Date (yyyy-MM-dd'T'HH:mm:ssXXX)]
GET [base]/HealthcareService?openIn=[Number in minutes]

Example:
GET [base]/HealthcareService?openNow=true
GET [base]/HealthcareService?openAt=2017-09-16T14:30:00+10:00
GET [base]/HealthcareService?openIn=30

Support:

Support search for a health care service with the other search criteria along withe below calendar criteria.
openNow - List of services that are open now
openAt - List of services that are open at a specific date
openIn - List of servcies that are open in minutes.

Example:
GET [base]/HealthcareService?_format=json&service-type=nhsd:/reference/taxonomies/snomed-servicetype|1223091000168105&openNow=true

Search By characteristic

GET [base]/HealthcareService?characteristic=[system]|[code]

NHSD supports search based on Healthcare Service characteristics. For example:

find a Healthcare Service which operates under the nPeP Program
find a Healthcare Service which offers wheelchair access.

Multiple characteristics search patterns are also supported. In multiple characteristics scenario called composite search parameters.

AND Search Param

For example, the result of the search operation is the intersection of the resources that match the criteria specified by each individual search parameter. If a parameter repeats, such as

/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-facility|wheelchairAccess&characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-facility|hearingInductionLoop

then this matches healthcare services which has both Wheelchair Access and Hearing Induction Loop as location facilities. This is known as an AND search parameter, since the server is expected to respond only with results which match both values.

OR Search Param

If, instead, the search is to find Healthcare Service that has either facility type, then this is a single parameter with multiple values, separated by a ,.

For example,

/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-facility|wheelchairAccess,http://fhir.nhsd.com.au/CodeSystem/rc-facility|hearingInductionLoop

This is known as an OR search parameter, since the server is expected to respond with results which match either value.

Example: Search By characteristic

Single Characteristic search

GET [base]/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-program|npepProgram
GET [base]/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-program|npepProgram&service-type=nhsd:/reference/taxonomies/snomed-servicetype|1223091000168105
GET [base]/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-appointment|yes
GET [base]/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-eligibility|age-olderAdults65

OR Characteristic search

 GET [base]/HealthcareService?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-program|npepProgram,http://fhir.nhsd.com.au/CodeSystem/rc-program|dayProgram

AND Characteristic search:

This query is recommended to be performed as a POST-method call, depending on the expected size of the query. Refer to the capability statement for more details.

POST /v4/HealthcareService/_search HTTP/1.1
Host: api.fhir.nhsd.healthdirect.org.au
x-api-key: {API KEY AS PROVIDED BY NHSD}
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
_count=5&characteristic=http%3A%2F%2Ffhir.nhsd.com.au%2FCodeSystem%2Frc-program%7CnpepProgram&characteristic=http%3A%2F%2Ffhir.nhsd.com.au%2FCodeSystem%2Frc-providerLocationServiceCharacteristic%7CmyHealthRecord

Implementation Notes:

Service Providing Organization Service Providing Organization represents the organisation directly linked to location and provides the actual healthcare service.

Related Organization In hierarchical multi level organization setup, the Related Organization represents the organization above the service providing organization with part_of relationship.

NHSD supports the healthcare service search based on attributes of service providing organizatins and related organization identifiers

Search Healthcare Service based on the name of the Organization (Service providing Organization)

Chained search (via Organisation) based on text name.

GET [base]/HealthcareService?organization.name=[string]

Example: GET [base]/HealthcareService?organization.name=GP%20SURGERY

Support:

Refer to NHSD Organization.

Refer to the capability statement for additional detail on chained search support.

Search Healthcare Service based on an identifier of the Organization (Service providing Organization)

Chained search (via Organisation) based on identifier token.

GET [base]/HealthcareService?organization.identifier=[system]|[code]

Example:

ABN search

 GET [base]/HealthcareService/?organization.identifier=http://hl7.org.au/id/abn|67164776714

NHSD SITE-ID search

 GET [base]/HealthcareService?organization.identifier=http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#siteId|202029

Support:

Refer to NHSD Organization for details on identifier support for an Organization.

Refer to the capability statement for additional detail on chained search support.

Search Healthcare Service based on an identifier of the related Organization

Chained search (via related Organisation) based on identifier token.

GET [base]/HealthcareService?relatedOrganization.identifier=[system]|[code]

2 levels of organization (a related organization and a service providing organization)

 GET [base]/HealthcareService/_search?relatedOrganization.identifier=nhsd:/reference/common/organisationIdentifierType/heroEstablishmentId|12341243

3 levels of organization (2 levels of related organization and a service providing organization)

 GET [base]/HealthcareService/_search?relatedOrganization.identifier=nhsd:/reference/common/organisationIdentifierType/heroEstablishmentId|12341243&relatedOrganization.identifier=nhsd:/reference/common/organisationIdentifierType/heroEstablishmentId|219033

Combination of related organizations and service providing organizations

 GET [base]/HealthcareService/_search?relatedOrganization.identifier=nhsd:/reference/common/organisationIdentifierType/heroEstablishmentId|12341243&relatedOrganization.identifier=nhsd:/reference/common/organisationIdentifierType/heroEstablishmentId|219033&organization.identifier=nhsd:/reference/common/organisatio nIdentifierType/heroEstablishmentId|21800034

Search By Reference

A reference parameter refers to references between resources. For example, find all HealthcareServices where the subject reference is a particular Location, where the location is selected by resource id.

GET [base]/HealthcareService?location=54c462a-ce75-11e7-abc4-cec278b6b50a
GET [base]/HealthcareService?organization=54c462a-ce75-11e7-abc4-cec278b6b50a

Implementation Notes:

Search: Include References

The _include argument allows the automatic inclusion of referenced resources in the response for a search; based on search parameters defined for this resource type.

 Example:
 GET [base]/HealthcareService?name=St%20Johns&_include=HealthcareService:location
 GET [base]/HealthcareService?name=St%20Johns&_include=HealthcareService:organization
 GET [base]/HealthcareService?name=St%20Johns&_include=HealthcareService:endpoint 
 GET [base]/HealthcareService?name=St%20Johns&_include=HealthcareService:organization&_include=HealthcareService:location&_include=HealthcareService:endpoint

Search: Combination

Searches with a single request using logical AND for criteria. e.g specialty cardiologist in post code 4846.
Please refer to the capability statement for additional detail on chained search support.

Locate a Healthcare Service (a Pharmacy) as a physical service (si) within a 5Km radius from a known GEO-point (and postcode 3000) that is open now.

[base]/HealthcareService?_count=20&location.near=-37.81:144.96&location.address-postalcode=3000&location.near-distance=5000.0|http://unitsofmeasure.org|m&location.physicalType=si&service-type=nhsd:/reference/taxonomies/snomed-servicetype|1223091000168105&openNow=true

Pagination

NHSD supports paging using page and _count param to fetch Healthcare Service resources. By default the count is 10.
```
GET [base]/HealthcareService?_format=json&page=1&_count=10
```

Refer to the capability statement for further details on paging support through Bundle.Links