Must support

The meaning of the presence or absence of the must support flag is described in Must support.

Extensions

No extensions have been introduced in this profile.

Usage notes

The coverage area that a service is intended for/available to can be represented as one or more instances of Location, where the address elements are populated depending on the type of coverage area to be defined.

To define an Australia-wide coverage area, only the following element shall be populated:

• address.country

To define a coverage area for a particular state, the following elements should be populated in addition to address.country:

• address.state

To define a coverage area for a particular suburb, the following elements should be populated in addition to address.country:

• address.city
• address.postalCode
• address.state

Supported interactions

The PCA API specification does not directly support operations on this profile. A PCA Service Coverage Area resource cannot be created, updated or retrieved independently from the PCA Healthcare Service that it is contained within.

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

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
city	S	0..1	string	Australian city, town or suburb
state	S	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	S	0..1	string	Postal code for area
country	S	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	AustralianStatesAndTerritories https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
city	SΣ	0..1	string	Australian city, town or suburb Example General: Erewhon
state	SΣ	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
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 https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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	Σ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!Σ	0..1	code	active | suspended | inactive 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 (extensible): Indicates the type of function performed at the location.
telecom		0..*	ContactPoint	Contact details of the location
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
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	SΣ	0..1	string	Australian city, town or suburb Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
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: LocationType (example): Physical form of the location.
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.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	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
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 https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
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
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
city	S	0..1	string	Australian city, town or suburb
state	S	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	S	0..1	string	Postal code for area
country	S	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	AustralianStatesAndTerritories https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
city	SΣ	0..1	string	Australian city, town or suburb Example General: Erewhon
state	SΣ	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
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 https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Australian geographic area in which a service is available.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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	Σ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!Σ	0..1	code	active | suspended | inactive 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 (extensible): Indicates the type of function performed at the location.
telecom		0..*	ContactPoint	Contact details of the location
address	SC	1..1	Address	Physical location inv-pca-1: if present, postalCode shall be 4 digits
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	SΣ	0..1	string	Australian city, town or suburb Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Australian state or territory Binding: Australian States and Territories (required)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Australia as a 2 digit ISO 3166 code Fixed Value: AU
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: LocationType (example): Physical form of the location.
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.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	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
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 https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 from https://tx.ontoserver.csiro.au/fhir
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
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
inv-pca-1	error	Location.address	if present, postalCode shall be 4 digits : postalCode.matches('^[0-9]{4,4}$')

This structure is derived from Location

Summary

Mandatory: 2 elements
Must-Support: 5 elements
Fixed: 1 element

No additional search parameters defined for this resource profile.