Provider Connect Australia (PCA) FHIR Implementation Guide 2.4.0

This is release 2.4.0 of Provider Connect Australia (PCA) FHIR Implementation Guide. It is based on FHIR version 4.0.1. See the Directory of published versions.

SD.14 StructureDefinition-pca-partner-service [Draft]

PCA Partner Service

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.

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:


SD.14.1 Formal views of profile content

The official URL for this profile is: 

http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service

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).

This profile builds on HealthcareService.

This profile was published on 2023-09-15 10:45:26+1000 as a draft by Australian Digital Health Agency.

Description of profiles, differentials, snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*HealthcareServiceA service offered by a subscriber to which a publisher can publish their own service offerings
inv-pca-1: providedBy shall be a relative reference to an Organization
inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-current-information-use-statement S1..1Reference(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 S0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S0..1PcaPartnerServiceIdentifierPCA Partner Service Identifier (PCA-PSI)
... active S1..1booleanWhether this partner service is in active use
... providedBy S1..1Reference(PCA Organization)Organization that provides this partner service
... category S1..1CodeableConceptBroad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.

... name S1..1stringDescription of service as presented to a consumer while searching
... comment S0..1stringAdditional description and/or any specific issues not covered elsewhere
... telecom S0..*ContactPointWebsite for this service
.... description S0..1stringDescription of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: url
.... value 1..1stringThe actual contact point details
... coverageArea S0..*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..1stringText alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*HealthcareServiceA service offered by a subscriber to which a publisher can publish their own service offerings
inv-pca-1: providedBy shall be a relative reference to an Organization
inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-current-information-use-statement S1..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S0..1PcaPartnerServiceIdentifierPCA Partner Service Identifier (PCA-PSI)
... active ?!SΣ1..1booleanWhether this partner service is in active use
... providedBy SΣ1..1Reference(PCA Organization)Organization that provides this partner service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointWebsite for this service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... description S0..1stringDescription of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Location)Location(s) service is intended for/available to
.... extension 0..0
.... display Σ1..1stringText alternative for the resource
Example Brisbane area postcode: 40
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*HealthcareServiceA service offered by a subscriber to which a publisher can publish their own service offerings
inv-pca-1: providedBy shall be a relative reference to an Organization
inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-current-information-use-statement S1..1Reference(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 S0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S0..1PcaPartnerServiceIdentifierPCA Partner Service Identifier (PCA-PSI)
... active S1..1booleanWhether this partner service is in active use
... providedBy S1..1Reference(PCA Organization)Organization that provides this partner service
... category S1..1CodeableConceptBroad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.

... name S1..1stringDescription of service as presented to a consumer while searching
... comment S0..1stringAdditional description and/or any specific issues not covered elsewhere
... telecom S0..*ContactPointWebsite for this service
.... description S0..1stringDescription of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: url
.... value 1..1stringThe actual contact point details
... coverageArea S0..*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..1stringText alternative for the resource
Example Brisbane area postcode: 40

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*HealthcareServiceA service offered by a subscriber to which a publisher can publish their own service offerings
inv-pca-1: providedBy shall be a relative reference to an Organization
inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-current-information-use-statement S1..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-psi S0..1PcaPartnerServiceIdentifierPCA Partner Service Identifier (PCA-PSI)
... active ?!SΣ1..1booleanWhether this partner service is in active use
... providedBy SΣ1..1Reference(PCA Organization)Organization that provides this partner service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: PCA Partner Service Category (required): The type of the partner service.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment SΣ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointWebsite for this service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... description S0..1stringDescription of element or resource
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
.... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
.... value Σ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(Location)Location(s) service is intended for/available to
.... extension 0..0
.... display Σ1..1stringText alternative for the resource
Example Brisbane area postcode: 40
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

 

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.14.2 - Search parameters

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

 

SD.14.3 - Known issues

No known issues.