Provider Connect Australia (PCA) - Local Development build (v25.2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PCA Partner Service

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service Version: 25.2.0.0
Active as of 2025-10-23 Computable Name: PcaPartnerService

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of HealthcareService defines a PCA Partner Service. A PCA Partner Service is a service offered by a PCA subscriber to which PCA publishers can publish their service offerings (i.e. Healthcare Service).

Must support

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

Extensions

Extensions introduced in this profile:

Supported interactions

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:pca-psi SOΣ 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this partner service is in active use
... providedBy SΣ 1..1 Reference(PCA Organization) Organization that provides this partner service
... category SΣ 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (extensible)
... name SOΣ 1..1 string Description of service as presented to a consumer while searching
... comment SΣ 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom SO 0..* ContactPoint Website for this service
.... Slices for extension Content/Rules for all slices
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
.... value Σ 1..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.
... coverageArea S 0..* Reference(Location) Location(s) service is intended for/available to
.... extension 0..0
.... display Σ 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG
HealthcareService.type Base extensible Service Type . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))

This structure is derived from AUCoreHealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... Slices for identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active S 1..1 boolean Whether this partner service is in active use
... category S 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... name S 1..1 string Description of service as presented to a consumer while searching
... comment S 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom S 0..* ContactPoint Website for this service
.... Slices for extension Content/Rules for all slices
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: url
.... value 1..1 string The actual contact point details
... coverageArea S 0..* Reference(Location) Location(s) service is intended for/available to
.... id 0..0
.... extension 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi SOΣ 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this partner service is in active use
... providedBy SΣ 1..1 Reference(PCA Organization) Organization that provides this partner service
... category SΣ 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (extensible)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Clinical Specialty . (preferred)
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name SOΣ 1..1 string Description of service as presented to a consumer while searching
... comment SΣ 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 SO 0..* ContactPoint Website for this 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
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
.... value Σ 1..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(Location) Location(s) service is intended for/available to
.... extension 0..0
.... display Σ 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... 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 Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: Common Languages in Australia . (extensible)
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availableTime 0..* BackboneElement Times the Service Site is available
.... 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 Always available? e.g. 24 hour service
.... availableStartTime 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
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
.... availableEndTime 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
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
... notAvailable 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 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📦4.0.1 FHIR Std.
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG
HealthcareService.type Base extensible Service Type . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.specialty Base preferred Clinical Specialty . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦6.0.0-ballot AU Base Implementation Guide v6.0
HealthcareService.eligibility.​code Base example Not Stated Unknown
HealthcareService.program Base example Program 📦4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not Stated Unknown
HealthcareService.communication Base extensible Common Languages in Australia . ⏿2.2.1 tx.ontoserver.csiro.au
HealthcareService.referralMethod Base example ReferralMethod 📦4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))

This structure is derived from AUCoreHealthcareService

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:pca-psi SOΣ 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this partner service is in active use
... providedBy SΣ 1..1 Reference(PCA Organization) Organization that provides this partner service
... category SΣ 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (extensible)
... name SOΣ 1..1 string Description of service as presented to a consumer while searching
... comment SΣ 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom SO 0..* ContactPoint Website for this service
.... Slices for extension Content/Rules for all slices
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
.... value Σ 1..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.
... coverageArea S 0..* Reference(Location) Location(s) service is intended for/available to
.... extension 0..0
.... display Σ 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG
HealthcareService.type Base extensible Service Type . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))

Differential View

This structure is derived from AUCoreHealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... Slices for identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active S 1..1 boolean Whether this partner service is in active use
... category S 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... name S 1..1 string Description of service as presented to a consumer while searching
... comment S 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom S 0..* ContactPoint Website for this service
.... Slices for extension Content/Rules for all slices
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: url
.... value 1..1 string The actual contact point details
... coverageArea S 0..* Reference(Location) Location(s) service is intended for/available to
.... id 0..0
.... extension 0..0
.... reference 0..0
.... type 0..0
.... identifier 0..0
.... display 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService C 0..* AUCoreHealthcareService A service offered by a subscriber to which a publisher can publish their own service offerings
Constraints: inv-pca-1, inv-pca-2
... 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:pca-current-information-use-statement S 1..1 Reference(PCA Information Use Statement) Reference to the current Information Use Statement of this Partner Service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi SOΣ 0..1 PcaPartnerServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this partner service is in active use
... providedBy SΣ 1..1 Reference(PCA Organization) Organization that provides this partner service
... category SΣ 1..1 CodeableConcept Broad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.
... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (extensible)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Clinical Specialty . (preferred)
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name SOΣ 1..1 string Description of service as presented to a consumer while searching
... comment SΣ 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 SO 0..* ContactPoint Website for this 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
..... extension:description S 0..1 string Description of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: url
.... value Σ 1..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(Location) Location(s) service is intended for/available to
.... extension 0..0
.... display Σ 1..1 string Text alternative for the resource
Example Brisbane area postcode: 40
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... 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 Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: Common Languages in Australia . (extensible)
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availableTime 0..* BackboneElement Times the Service Site is available
.... 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 Always available? e.g. 24 hour service
.... availableStartTime 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
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
.... availableEndTime 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
...... extension:timeZone 0..1 code IANA Timezone Code per BCP 175
URL: http://hl7.org/fhir/StructureDefinition/timezone
Binding: IANATimezones (required): IANA Timezones (BCP 175)
..... value 0..1 time Primitive value for time
... notAvailable 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 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📦4.0.1 FHIR Std.
HealthcareService.category Base required PCA Partner Service Category 📦25.2.0.0 This IG
HealthcareService.type Base extensible Service Type . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.specialty Base preferred Clinical Specialty . ⏿1.0.0 tx.ontoserver.csiro.au
HealthcareService.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦6.0.0-ballot AU Base Implementation Guide v6.0
HealthcareService.eligibility.​code Base example Not Stated Unknown
HealthcareService.program Base example Program 📦4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not Stated Unknown
HealthcareService.communication Base extensible Common Languages in Australia . ⏿2.2.1 tx.ontoserver.csiro.au
HealthcareService.referralMethod Base example ReferralMethod 📦4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-pca-1 error HealthcareService providedBy shall be a relative reference to an Organization providedBy.reference.startsWith('Organization/')
inv-pca-2 error HealthcareService coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$'))

This structure is derived from AUCoreHealthcareService

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Additional search parameters defined for this resource profile:

Name Type Description Expression In Common
coverage-area.location.address-postalcode string Postal code of location(s) that this service is intended for/available to HealthcareService.coverageArea.address.postalCode