This profile defines the service delivery location by address at a minimum.

Usage Notes

Profile specific implementation guidance:

One of the following defined identifier types, known to this profile, SHOULD be supplied:

• AU Location Specific Practice Number
• AU NATA Site Number

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AUBaseLocation

Name	Flags	Card.	Type	Description & Constraints
Location	CTU	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
meta		0..1	Meta	Metadata on Location
source	S	0..1	uri	Identifies where the resource comes from
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	S	1..1	code	Required status
address	S	1..1	Address, AustralianAddress	Australian location
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
meta	Σ	0..1	Meta	Metadata on Location
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	Required status Binding: LocationStatus (required): Indicates whether the location is still in use.
address	S	1..1	Address, AustralianAddress	Australian location
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata on Location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	Required status Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus	Σ	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name	Σ	0..1	string	Name of the location as used by humans
alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	Σ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	Σ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	Σ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
telecom		0..*	ContactPoint	Contact details of the location
address	S	1..1	Address, AustralianAddress	Australian location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
physicalType	Σ	0..1	CodeableConcept	Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
position		0..1	BackboneElement	The absolute geographic location
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
longitude		1..1	decimal	Longitude with WGS84 datum
latitude		1..1	decimal	Latitude with WGS84 datum
altitude		0..1	decimal	Altitude with WGS84 datum
managingOrganization	Σ	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(Location)	Another Location this one is physically a part of
hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	The Location is open all day
openingTime		0..1	time	Time that the Location opens
closingTime		0..1	time	Time that the Location closes
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleTypeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG
Location.physicalType	preferred	LocationPhysicalTypeAUExtended http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

Differential View

This structure is derived from AUBaseLocation

Name	Flags	Card.	Type	Description & Constraints
Location	CTU	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
meta		0..1	Meta	Metadata on Location
source	S	0..1	uri	Identifies where the resource comes from
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	S	1..1	code	Required status
address	S	1..1	Address, AustralianAddress	Australian location
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
meta	Σ	0..1	Meta	Metadata on Location
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	Required status Binding: LocationStatus (required): Indicates whether the location is still in use.
address	S	1..1	Address, AustralianAddress	Australian location
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	Australian Location Directory Entry au-pd-loc-01: At least one defined identifier, known to this AU PD Location profile, should be present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata on Location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users
status	?!SΣ	1..1	code	Required status Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus	Σ	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name	Σ	0..1	string	Name of the location as used by humans
alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	Σ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	Σ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	Σ	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
telecom		0..*	ContactPoint	Contact details of the location
address	S	1..1	Address, AustralianAddress	Australian location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required): well known state representation
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
physicalType	Σ	0..1	CodeableConcept	Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
position		0..1	BackboneElement	The absolute geographic location
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
longitude		1..1	decimal	Longitude with WGS84 datum
latitude		1..1	decimal	Latitude with WGS84 datum
altitude		0..1	decimal	Altitude with WGS84 datum
managingOrganization	Σ	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(Location)	Another Location this one is physically a part of
hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	The Location is open all day
openingTime		0..1	time	Time that the Location opens
closingTime		0..1	time	Time that the Location closes
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Location.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleTypeAUExtended http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	required	AustralianStatesandTerritories http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories from this IG
Location.physicalType	preferred	LocationPhysicalTypeAUExtended http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-loc-01	warning	Location	At least one defined identifier, known to this AU PD Location profile, should be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()

This structure is derived from AUBaseLocation

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Maturity: 0

Read: Location

Read identified location resource content.

GET [base]/Location/[id]

Example: GET [base]/Location/1234

Support:

• MUST support read Location

Implementation Notes: (how to read resource)

Search: Active Status

Search based on active status of the endpoint record.

GET [base]/Endpoint?status=[code]

Example: GET [base]/Endpoint?status=active

Support: MUST support search Organization by active status code (active | suspended | inactive)

Implementation Notes: (how to search by token)

Search: Location Address Parts

Search based on address parts for postcode, suburb, and state.

GET [base]/Location?address-postalcode=[postcode]

GET [base]/Location?address-city=[suburb]

GET [base]/Location?address-state=[state]

Example:

GET [base]/Location?address-postalcode=3101

GET [base]/Location?address-city=Bundaberg

GET [base]/Location?address-state=VIC

Support:

• SHOULD support search Location by address parts address-postalcode, address-city, address-state.
• SHOULD support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by string)

Search: Location Distance

Search based on address within a nominated distance.

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

Example: GET [base]/Location?near=-83.694810:42.256500&near-distance=le10.0|http://unitsofmeasure.org|km

Support:

• SHOULD support search Location within a distance.
• SHOULD 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: (how to search by token) and (how to search by quantity)

Search: Combination

• The following searches MUST be able to be perfomed together in a single request using logical AND for criteria. e.g in postcode within 2km