Must support

The meaning of the presence or absence of the must support flag is described in Must support, except for the following element:

• For the identifier:pca-li element: publishing systems creating a new PCA Location resource shall not provide this element. This identifier is generated by the PCA service.

Extensions

Extensions introduced in this profile:

• Location: PCA Amenity
• Location: PCA Postal Address

Usage notes

Identifiers

The PCA Location profile explicitly supports the following identifier slice (as indicated by the must support flag):

• PCA Location Identifier (PCA-LI)

A PCA Location resource may also have additional identifiers specific to other PCA business partners, and their identifier systems may or may not match other identifier slices defined in AU Base Location.

Status

The status element can only be set to 'inactive' if all healthcare services linked to the location have an active value of 'false'.

Location address

A PCA Location without a type represents a physical location in PCA. A PCA Location without a type must include the physical address of the location in the address element.

Address lines

When a PCA Location is created or updated by a publishing system, or retrieved by a publishing or subscribing system, the line elements for pca-postal-address (if present) and address are processed/populated by PCA using the rules that are defined the usage notes of the PCA Postal Address extension.

Type

The usage notes of the AU Base Location profile provide guidance for Locations that may form part of defining a mobile or remotely delivered service. The PCA Location profile formalises this guidance as mandatory requirements (via invariants). The requirements are summarised below:

A PCA Location for a mobile service shall have:

• mode=’kind’
• type=’MOBL’ plus at least one of the following codes: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB', to further qualify where the mobile service is offered

A PCA Location for a remotely delivered service shall have:

• mode=’kind’
• type=’VI’
• physicalType=’vi’ (Note: the 'vi' code with code system http://terminology.hl7.org.au/CodeSystem/location-physical-type has been deprecated as it has been replaced by an equivalent term provided by HL7 international. The 'vi' code with code system http://terminology.hl7.org/CodeSystem/location-physical-type should be used instead.)

Organisation reference

The managingOrganization element must contain a relative reference to an existing PCA Organization. Publishing systems can search for organisations using the PCA Publisher Agent API. After a location has been created, the managingOrganization element cannot be changed to reference a different organisation - this functionality will be supported in a future release of PCA.

Supported interactions

Supported service interactions for this profile are defined in the following capability statements:

• For publishing systems: PCA Publisher Agent
• For subscribing systems: PCA Subscriber Agent

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

This structure is derived from AUBaseLocation

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
Slices for extension				Content/Rules for all slices
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	SC	1..1	code	active | inactive inv-pca-8: status shall be either 'active' or 'inactive'
name	S	1..1	string	Name of the location as used by humans
mode	S	0..1	code	instance | kind
type	S	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	S	0..1	CodeableConcept	Physical form of the location
managingOrganization	S	1..1	Reference(PCA Organization)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	?!SΣC	1..1	code	active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. inv-pca-8: status shall be either 'active' or 'inactive'
name	SΣ	1..1	string	Name of the location as used by humans
mode	SΣ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
managingOrganization	SΣ	1..1	Reference(PCA Organization)	Organization responsible for provisioning and upkeep
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.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type from this IG
Location.physicalType	preferred	LocationPhysicalTypeAUExtended http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	?!SΣC	1..1	code	active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. inv-pca-8: status shall be either 'active' or 'inactive'
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	SΣ	1..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	SΣ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	SΣ	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	SΣ	1..1	Reference(PCA 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	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type 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
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

Differential View

This structure is derived from AUBaseLocation

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
Slices for extension				Content/Rules for all slices
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	SC	1..1	code	active | inactive inv-pca-8: status shall be either 'active' or 'inactive'
name	S	1..1	string	Name of the location as used by humans
mode	S	0..1	code	instance | kind
type	S	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	S	0..1	CodeableConcept	Physical form of the location
managingOrganization	S	1..1	Reference(PCA Organization)	Organization responsible for provisioning and upkeep
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	?!SΣC	1..1	code	active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. inv-pca-8: status shall be either 'active' or 'inactive'
name	SΣ	1..1	string	Name of the location as used by humans
mode	SΣ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
managingOrganization	SΣ	1..1	Reference(PCA Organization)	Organization responsible for provisioning and upkeep
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.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard
Location.type	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type from this IG
Location.physicalType	preferred	LocationPhysicalTypeAUExtended http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location	C	0..*	AUBaseLocation	A location at which services are offered by a publisher inv-pca-1: managingOrganization shall be a relative reference to an Organization inv-pca-2: If present, the type must include either 'MOBL' or 'VI' inv-pca-3: If type contains 'VI', no other type must be present inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' inv-pca-5: If type contains 'MOBL', then mode shall be 'kind' inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' inv-pca-7: Either type or address shall be present
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
pca-amenity	S	0..*	CodeableConcept	Physical features within or in close proximity of the location URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity Binding: PCA Amenity (required)
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber	Unique code or number identifying the location to its users Slice: Unordered, Open by value:system
identifier:pca-li	S	0..1	PcaLocationIdentifier	PCA Location Identifier (PCA-LI) issued by the PCA service
status	?!SΣC	1..1	code	active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. inv-pca-8: status shall be either 'active' or 'inactive'
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	SΣ	1..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	SΣ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: PCA Service Delivery Location Role Type (required)
telecom	S	0..*	ContactPoint	Contact details of the location
address	SC	0..1	AustralianAddress	Address at which services are offered by a publisher inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' inv-pca-9: At most, one DPID address identifier shall be present inv-pca-10: At most, one G-NAF address identifier shall be present inv-pca-11: address shall contain a maximum of 3 line elements
physicalType	SΣ	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	SΣ	1..1	Reference(PCA 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	required	PcaServiceDeliveryLocationRoleType http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type 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
inv-pca-1	error	Location	managingOrganization shall be a relative reference to an Organization : managingOrganization.reference.startsWith('Organization/')
inv-pca-2	error	Location	If present, the type must include either 'MOBL' or 'VI' : type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3	error	Location	If type contains 'VI', no other type must be present : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4	error	Location	If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5	error	Location	If type contains 'MOBL', then mode shall be 'kind' : type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6	error	Location	If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi' : type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7	error	Location	Either type or address shall be present : (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8	error	Location.status	status shall be either 'active' or 'inactive' : (value = 'active') or (value = 'inactive')
inv-pca-9	error	Location.address	At most, one DPID address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10	error	Location.address	At most, one G-NAF address identifier shall be present : extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11	error	Location.address	address shall contain a maximum of 3 line elements : line.count() < 4

This structure is derived from AUBaseLocation

Summary

Mandatory: 4 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

• PCA Location Identifier (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-location-identifier)
• Australian Address (http://hl7.org.au/fhir/StructureDefinition/au-address)
• PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)

Extensions

This structure refers to these extensions:

• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Location.identifier

No additional search parameters defined for this resource profile.