Provider Connect Australia (PCA)
24.2.0.0 - active Australia flag

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

Resource Profile: PCA Practitioner Role

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role Version: 24.2.0.0
Active as of 2024-09-23 Computable Name: PcaPractitionerRole

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 PractitionerRole defines a PCA Practitioner Role. A PCA Practitioner Role is a PCA Practitioner in a role at a PCA Healthcare Service.

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 identifier:pca-pri element: publishing systems creating a new PCA Practitioner Role resource shall not provide this element. This identifier is generated by the PCA service.
  • For the active element: publishing systems creating or updating a PCA Practitioner Role resource shall not provide this element. This value is calculated by the PCA service at the time the PCA Practitioner Role resource is provided to a subscribing system. See the 'Period' section in the usage notes below for more information.
  • For the organization and location elements: where a publishing system provides values for these elements the values will be ignored. When a PCA Practitioner Role is provided to a subscribing system the values for these elements are populated as per the referenced healthcareService. Subscribing systems can ignore these values, but may find them useful to simplify queries.
  • For the code:practitionerRole element: please see the usage notes section below for how this element should be populated by publishing systems and what values will be provided to subscribing systems.
  • For the pca-bank-account extension: any values provided by publishing systems when adding or updating a PCA Practitioner Role 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 Practitioner Role resource to subscribing systems.

Extensions

Extensions introduced in this profile:

Usage notes

Identifiers

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

  • PCA Medicare Provider Number
  • AU Ahpra Registration Number
  • PCA Practitioner Role Identifier (PCA-PRI)

A PCA Practitioner Role 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 Practitioner Role.

Practitioner Role

To indicate the primary code of the practitioner role, use the iso21090-preferred extension on the code:PractitionerRole element.

For the code:practitionerRole element: a publishing system is required to provide a single code that represents the primary practitioner role type (by using the ‘iso21090-preferred’ extension). Any other values for the practitionerRole element will be ignored. When a PractitionerRole is provided to a subscribing system the values for the code:practitionerRole element are populated with the primary practitioner role type (through the presence of the of the ‘iso21090-preferred’ extension), as well as any parent terms of the primary practitioner role type term in the SNOMED hierarchy, up to but not including direct descendants of 223366009 - Healthcare Professional.

Period

The PCA calculates the active element based on the period element at the time the PCA Practitioner Role resource is provided to a subscribing system.

  • If period is not present, or if period is present with a start date in the past and/or an end date in the future, the PCA service sets the active element to 'true'.
  • If period is present with a a start date in the future or an end date in the past, the PCA service sets the active element to 'false'.
  • If the active element of the associated healthcareService is 'false', then the PCA service sets the active element to 'false' regardless of the period value.

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

  • If present, period.start SHALL be equal to, or later than, the pca-active-period.value[x].start value (if present) of the HealthcareService referenced by the healthcareService element.
  • If present, period.end SHALL be equal to, or earlier than, the pca-active-period.value[x].end value (if present) of the HealthcareService referenced by the healthcareService element.

Practitioner reference

The practitioner element must contain a relative reference to a PCA Practitioner. Publishing systems can search for practitioners using the PCA Publisher Agent API. After a practitioner role has been created, the practitioner element cannot be changed to reference a different practitioner.

Practitioner reference

The healthcareService element must contain a relative reference to an existing PCA Healthcare Service. Publishing systems can create new healthcare services or search for existing healthcare services using the PCA Publisher Agent API. After a practitioner role has been created, the healthcareService element cannot be changed to reference a different healthcare service.

Supported interactions

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

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... Slices for extension Content/Rules for all slices
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active S 0..1 boolean Whether this practitioner role record is in active use
... practitioner S 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code S 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:practitionerRole S 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (required)
..... Slices for extension Content/Rules for all slices
...... preferred S 0..1 boolean Whether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
.... code:hiServiceRole S 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
... location 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
... active SΣ 0..1 boolean Whether this practitioner role record is in active use
... period SΣC 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
inv-pca-5: If present, start shall be later than '1900-01-01'
inv-pca-6: If present, end shall be no more than 5 years from the current date
... practitioner SΣ 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization Σ 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: Practitioner Role . (preferred)
.... code:practitionerRole SΣ 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (required)
..... Slices for extension Content/Rules for all slices
...... preferred S 0..1 boolean Whether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... code:hiServiceRole SΣ 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
... location Σ 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
... active SΣ 0..1 boolean Whether this practitioner role record is in active use
... period SΣC 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
inv-pca-5: If present, start shall be later than '1900-01-01'
inv-pca-6: If present, end shall be no more than 5 years from the current date
... practitioner SΣ 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization Σ 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: Practitioner Role . (preferred)
.... code:practitionerRole SΣ 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (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 code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... code:hiServiceRole SΣ 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
... location Σ 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/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
...... timeZone 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 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 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 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 services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))

This structure is derived from AUBasePractitionerRole

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 15 elements
Fixed: 2 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 PractitionerRole.identifier
  • The element 1 is sliced based on the value of PractitionerRole.code

Differential View

This structure is derived from AUBasePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... Slices for extension Content/Rules for all slices
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active S 0..1 boolean Whether this practitioner role record is in active use
... practitioner S 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code S 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:practitionerRole S 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (required)
..... Slices for extension Content/Rules for all slices
...... preferred S 0..1 boolean Whether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
.... code:hiServiceRole S 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
... location 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
... active SΣ 0..1 boolean Whether this practitioner role record is in active use
... period SΣC 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
inv-pca-5: If present, start shall be later than '1900-01-01'
inv-pca-6: If present, end shall be no more than 5 years from the current date
... practitioner SΣ 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization Σ 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: Practitioner Role . (preferred)
.... code:practitionerRole SΣ 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (required)
..... Slices for extension Content/Rules for all slices
...... preferred S 0..1 boolean Whether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... code:hiServiceRole SΣ 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
... location Σ 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* AUBasePractitionerRole A role a practitioner performs at a service offered by a publisher
inv-pca-1: healthcareService shall be a relative reference to a HealthcareService
inv-pca-2: practitioner shall be a relative reference to a Practitioner
inv-pca-3: If a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... pca-preferred-name S 0..1 HumanName Practitioner's preferred name in this role at a specific location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-preferred-name
.... pca-practitioner-role-communication S 0..* CodeableConcept A language the practitioner can use in patient communication when acting in a role at a HealthcareService
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role-communication
Binding: PCA Common Languages in Australia (required)
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-service-provision-capacity S 0..1 string Days per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber Business Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S 0..1 PcaMedicareProviderNumber PCA Medicare Provider Number
.... identifier:pca-pri S 0..1 PcaPractitionerRoleIdentifier PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C 0..1 AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
... active SΣ 0..1 boolean Whether this practitioner role record is in active use
... period SΣC 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
inv-pca-5: If present, start shall be later than '1900-01-01'
inv-pca-6: If present, end shall be no more than 5 years from the current date
... practitioner SΣ 1..1 Reference(PCA Practitioner) Practitioner that is able to provide the defined services for the organization
... organization Σ 0..1 Reference(PCA Organization) Organization where the roles are available - see Must support section
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: Practitioner Role . (preferred)
.... code:practitionerRole SΣ 1..* CodeableConcept Practitioner Role (SNOMED CT)
Binding: Practitioner Role . (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 code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... code:hiServiceRole SΣ 0..1 CodeableConcept PCA HI Service Role
Binding: PCA HI Service Role (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Clinical Specialty . (preferred)
... location Σ 0..1 Reference(PCA Location) The location at which this practitioner provides care - see Must support section
... healthcareService S 1..1 Reference(PCA Healthcare Service) The service a practitioner provides when in this role
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/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
...... timeZone 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 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 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 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 services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:practitionerRolerequiredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.code:hiServiceRolerequiredPcaHiServiceRole (a valid code from PCA HI Service Role)
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role
from this IG
PractitionerRole.specialtypreferredClinicalSpecialty .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorPractitionerRolehealthcareService shall be a relative reference to a HealthcareService
: healthcareService.reference.startsWith('HealthcareService/')
inv-pca-2errorPractitionerRolepractitioner shall be a relative reference to a Practitioner
: practitioner.reference.startsWith('Practitioner/')
inv-pca-3errorPractitionerRoleIf a code of type practitionerRole is present, then exactly one code of type practitionerRole shall be preferred
: (code.coding.system.where(value='http://snomed.info/sct').exists()) implies ((code.where(coding.system.where(value='http://snomed.info/sct') and extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-preferred' and value=true))).count()=1)
inv-pca-5errorPractitionerRole.periodIf present, start shall be later than '1900-01-01'
: (start.exists()) implies (start > @1900-01-01)
inv-pca-6errorPractitionerRole.periodIf present, end shall be no more than 5 years from the current date
: (end.exists()) implies (end < (now() + 5 years))

This structure is derived from AUBasePractitionerRole

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 15 elements
Fixed: 2 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 PractitionerRole.identifier
  • The element 1 is sliced based on the value of PractitionerRole.code

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No additional search parameters defined for this resource profile.