Must support

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

• For the id and identifier:pca-hsi elements: publishing systems creating a new PCA Healthcare Service resource shall not provide these elements. These identifiers are generated by the PCA service.
• For the meta.versionId and meta.lastUpdated elements: publishing systems creating or updating a PCA Healthcare Service resource shall not provide these elements. These values are generated by the PCA service.
• For the type element: a publishing system is required to provide a single code that represents the primary service type (by using the ‘iso21090-preferred’ extension). Any other values for the type element will be ignored.
• For the active element: publishing systems creating or updating a PCA Healthcare Service resource shall not provide this element. This value is calculated by the PCA service at the time the PCA Healthcare Service resource is provided to a subscribing system, using the period defined in the pca-active-period extension. See the ‘PCA Active Period’ section in the usage notes below for more information.
• For the pca-bank-account extension: any values provided by publishing systems when adding or updating a PCA Healthcare Service will be ignored by the PCA service. Bank account details must be managed by a healthcare provider organisation via the PCA Portal. The PCA service will populate the extension when providing the PCA Healthcare Service resource to subscribing systems.

Extensions

Extensions introduced in this profile:

• HealthcareService: PCA Active Period
• HealthcareService.availableTime: PCA Available Time Applicability
• HealthcareService: PCA Bank Account
• HealthcareService: PCA New Patient Availability
• HealthcareService: PCA Postal Address
• HealthcareService: PCA Referral Information For Consumer
• HealthcareService: PCA Referral Information For Provider
• HealthcareService.telecom: Contact Purpose
• HealthcareService.type: preferred

Usage notes

Identifiers

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

• PCA Healthcare Service Identifier (PCA-HSI)

A PCA Healthcare Service 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 Healthcare Service.

Active and PCA Active Period

The pca-active-period extension is used to indicate the period when the healthcare service is active. It is used by the PCA service to set the value of the active element:

• If the pca-active-period extension is present, the PCA service will set the active value based on the extension’s start and/or end elements.
• If the pca-active-period extension is not present, the PCA service will set the active value to ‘true’.

The active element is used by the PCA service to set the active element of practitoner roles that reference the healthcare service:

• If the PCA service sets the active element to ‘false’, then the active element of all practitoner roles that reference the healthcare service will also be set to ‘false’ by the PCA service, regardless of the value of the practitoner role’s period element.
• If the PCA service sets the active element to ‘true’, then the active element of all practitoner roles that reference the healthcare service will be calculated based on their period value. See the Usage notes of the PCA Practitioner Role profile for more information.

In addition to the invariants defined in this profile, the PCA service applies the following additional validation rules for pca-active-period:

• If present, pca-active-period.value[x].start SHALL be equal to, or earlier than, the period.start or period.end values of any PractitionerRole resources that reference this HealthcareService.
• If present, pca-active-period.value[x].end SHALL be equal to, or later than, the period.start or period.end values of any PractitionerRole resources that reference this HealthcareService.

Organisation reference

The providedBy 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 healthcare service has been created, the providedBy element cannot be changed to reference a different organisation.

Service type

To indicate the primary service type of the healthcare service, use the iso21090-preferred extension on the type element.

When a healthcare service is provided to a subscribing system the values for the type element are populated with the primary service type (through the presence of the ‘iso21090-preferred’ extension), as well as any parent terms of the primary service type in the SNOMED hierarchy, up to but not including direct descendants of 224930009 (Services).

Location reference

The location element must contain a relative reference to an existing PCA Location whose managingOrganization references the same PCA Organization as is referenced by the providedBy element. Publishing systems can create new locations or search for existing locations using the PCA Publisher Agent API. After a healthcare service has been created, the location element cannot be changed to reference a different location.

Availability

To indicate a change in the pattern of availability of the healthcare service during a particular period, use availableTime with the availableTimeApplicability extension.

To indicate the healthcare service is not available during a period of time, use notAvailable.

An availableTime using the availableTimeApplicability modifierExtension overrides any other availableTime that contains the same day(s), for the period defined in the during element.

Coverage area

The coverage area that a service is intended for/available to should be defined using one or more instances of the coverageArea element, with the address elements of the contained Location populated depending on the type of coverage area to be defined. PCA currently supports coverage areas to be defined as Australia-wide (in which case only one coverageArea element should be present), or as a combination of individual states and/or suburbs (with separate coverageArea elements for each). See the PCA Service Coverage Area profile for more information.

The coverageArea element shall only be present when eligibility contains ‘coverage-restrictedResidents’, and/or the type of the referenced location is ‘MOB’ (mobile) or ‘VI’ (virtual).

Referral information

Some subscribing systems may render markdown contained in the PCA Referral Information For Provider and PCA Referral Information For Consumer elements; however this is not guaranteed, so publishing systems should limit markdown syntax in these elements to that which still renders well as plain text (such as bullets, numbered lists, or bold/italic text).

Address lines

When a PCA Healthcare Service 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) are processed/populated by PCA using the rules that are defined in the usage notes of the PCA Postal Address extension.

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 AUBaseHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	S	0..1	id	Logical id of this artifact
meta	S	0..1	Meta	Metadata about the resource
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	When the resource version last changed
contained	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	S	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	S	1..1	Reference(PCA Organization)	Organization that provides this service
type	S	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
location	S	1..1	Reference(PCA Location)	Location where service is provided
name	S	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
code	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
modifierExtension:availableTimeApplicability	S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
extension:timeZone	S	0..1	AustralianTimeZone	AU time zone
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
extension:timeZone	S	0..1	AustralianTimeZone	AU time zone
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility 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.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	SΣ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(PCA Organization)	Organization that provides this service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
location	SΣ	1..1	Reference(PCA Location)	Location where service is provided
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:availableTimeApplicability	?!S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility 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.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG
HealthcareService.availableTime.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	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	SΣ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
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	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	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	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(PCA Organization)	Organization that provides this service
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred)
location	SΣ	1..1	Reference(PCA Location)	Location where service is provided
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	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	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:availableTimeApplicability	?!S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
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
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility from this IG
HealthcareService.program	example	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	required	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG
HealthcareService.availableTime.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	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

Differential View

This structure is derived from AUBaseHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	S	0..1	id	Logical id of this artifact
meta	S	0..1	Meta	Metadata about the resource
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	When the resource version last changed
contained	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	S	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	S	1..1	Reference(PCA Organization)	Organization that provides this service
type	S	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
location	S	1..1	Reference(PCA Location)	Location where service is provided
name	S	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
code	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
modifierExtension:availableTimeApplicability	S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
extension:timeZone	S	0..1	AustralianTimeZone	AU time zone
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
extension:timeZone	S	0..1	AustralianTimeZone	AU time zone
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility 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.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-pca-1	error	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	SΣ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(PCA Organization)	Organization that provides this service
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
location	SΣ	1..1	Reference(PCA Location)	Location where service is provided
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:availableTimeApplicability	?!S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility 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.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG
HealthcareService.availableTime.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	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService	C	0..*	AUBaseHealthcareService	A service offered by a publisher inv-pca-1: telecom use shall not be 'home' inv-pca-2: providedBy shall be a relative reference to an Organization inv-pca-3: location shall be a relative reference to a Location inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present inv-pca-5: exactly one type shall be preferred inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
id	SΣ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
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	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	When the resource version last changed
source	Σ	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	S	0..*	PcaServiceCoverageArea	Contained inline pca-service-coverage-area resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
pca-postal-address	S	0..1	AustralianAddress	Postal address URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
pca-referral-information-for-consumer	S	0..1	markdown	Referral instructions and information for consumers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
pca-referral-information-for-provider	S	0..1	markdown	Referral instructions and information for providers URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
pca-new-patient-availability	S	1..1	CodeableConcept	Whether the service is accepting new patients URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability Binding: PCA New Patient Availability (required)
pca-active-period	S	0..1	Period	Period when the healthcare service is active URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier	External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-hsi	S	0..1	PcaHealthcareServiceIdentifier	PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use
providedBy	SΣ	1..1	Reference(PCA Organization)	Organization that provides this service
category	Σ	0..*	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Service Type (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
preferred	S	0..1	boolean	Whether this is the primary service type for this HealthcareService URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred)
location	SΣ	1..1	Reference(PCA Location)	Location where service is provided
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactPurpose	S	0..*	CodeableConcept	Contact purpose URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose Binding: Contact Purpose (extensible)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
coverageArea	S	0..*	Reference(PCA Service Coverage Area) {c}	Location(s) service is intended for/available to
serviceProvisionCode	S	1..1	CodeableConcept	Condition under which this service is available/offered Binding: PCA Service Provision Code (required)
eligibility	S	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	S	1..1	CodeableConcept	Coded value for the eligibility Binding: PCA Eligibility (required)
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication	S	0..*	CodeableConcept	The language that this service is offered in Binding: Common Languages in Australia (required)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals Binding: PCA Referral Method (required)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	SC	0..*	BackboneElement	Times the Service Site is available inv-pca-8: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present inv-pca-9: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
Slices for modifierExtension	?!Σ	0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension:availableTimeApplicability	?!S	0..1	PcaAvailableTimeApplicability	Indicates the period and reason that this instance of availableTime applies
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone	S	0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
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
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Date range that the service is not available - can be open-ended if service is closing
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.type	required	ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	required	PcaServiceProvisionCode http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-provision-code from this IG
HealthcareService.eligibility.code	required	PcaEligibility (a valid code from PCA Eligibility) http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-eligibility from this IG
HealthcareService.program	example	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	required	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir
HealthcareService.referralMethod	required	PcaReferralMethod http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-referral-method from this IG
HealthcareService.availableTime.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	HealthcareService	telecom use shall not be 'home' : telecom.where(use = 'home').empty()
inv-pca-2	error	HealthcareService	providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/')
inv-pca-3	error	HealthcareService	location shall be a relative reference to a Location : location.reference.startsWith('Location/')
inv-pca-4	error	HealthcareService	If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present : eligibility.where(code.coding.code='coverage-restrictedResidents').exists() implies coverageArea.exists()
inv-pca-5	error	HealthcareService	exactly one type shall be preferred : type.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true).count()=1
inv-pca-6	error	HealthcareService	If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements : (availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists() or availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone').exists()) implies (((availableTime.availableStartTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone')) | (availableTime.availableEndTime.extension.where(url='http://hl7.org.au/fhir/StructureDefinition/au-timezone'))).distinct().count() = 1)
inv-pca-7	error	HealthcareService	If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present : (availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (availableTime.count() > availableTime.modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').count())
inv-pca-8	error	HealthcareService.availableTime	If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists()) implies (daysOfWeek.exists().not())
inv-pca-9	error	HealthcareService.availableTime	If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present : (modifierExtension.where(url='http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability').exists().not()) implies (daysOfWeek.exists())

This structure is derived from AUBaseHealthcareService

Summary

Mandatory: 8 elements (1 nested mandatory element)
Must-Support: 39 elements

Structures

This structure refers to these other structures:

• PCA Service Coverage Area (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-coverage-area)
• PCA Healthcare Service Identifier (PCA-HSI) (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-healthcare-service-identifier)
• PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)
• PCA Location (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-location)

Extensions

This structure refers to these extensions:

• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-new-patient-availability
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
• http://hl7.org/fhir/StructureDefinition/iso21090-preferred
• http://hl7.org.au/fhir/StructureDefinition/contact-purpose
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-available-time-applicability (Modifier)

Slices

This structure defines the following Slices:

• The element HealthcareService.identifier is sliced based on the value of value:system

No additional search parameters defined for this resource profile.