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.21 StructureDefinition-pca-practitioner-role [Draft]

PCA Practitioner Role

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 id and identifier:pca-pri elements: publishing systems creating a new PCA Practitioner Role resource shall not provide these elements. These identifiers are generated by the PCA service.
  • For the meta.versionId and meta.lastUpdated elements: publishing systems creating or updating a PCA Practitioner Role resource shall not provide these elements. These values are 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:


SD.21.1 Formal views of profile content

The official URL for this profile is: 

http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-role

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.

This profile builds on AUBasePractitionerRole.

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
.. PractitionerRole C0..*AUBasePractitionerRoleA 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 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
... pca-preferred-name S0..1HumanNamePractitioner'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 S0..*CodeableConceptA 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... pca-service-provision-capacity S0..1stringDays per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... pca-pbs-prescriber-number S0..1AUPBSPrescriberNumberPBS Prescriber Number relevant to when the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-pbs-prescriber-number
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S0..1PcaMedicareProviderNumberPCA Medicare Provider Number
.... identifier:pca-pri S0..1PcaPractitionerRoleIdentifierPCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber 0..1AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active S0..1booleanWhether this practitioner role record is in active use
... period SC0..1PeriodThe 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 S1..1Reference(PCA Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 0..1Reference(PCA Organization)Organization where the roles are available - see Must support section
... Slices for code S0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:practitionerRole S1..*CodeableConceptPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... preferred S0..1booleanWhether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
.... code:hiServiceRole S0..1CodeableConceptPCA HI Service Role
Binding: PCA HI Service Role (required)
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
... location 0..1Reference(PCA Location)The location at which this practitioner provides care - see Must support section
... healthcareService S1..1Reference(PCA Healthcare Service)The service a practitioner provides when in this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*AUBasePractitionerRoleA 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 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-preferred-name S0..1HumanNamePractitioner'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 S0..*CodeableConceptA 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... pca-service-provision-capacity S0..1stringDays per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... pca-pbs-prescriber-number S0..1AUPBSPrescriberNumberPBS Prescriber Number relevant to when the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-pbs-prescriber-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S0..1PcaMedicareProviderNumberPCA Medicare Provider Number
.... identifier:pca-pri S0..1PcaPractitionerRoleIdentifierPCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C0..1AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active SΣ0..1booleanWhether this practitioner role record is in active use
... period SΣC0..1PeriodThe 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..1Reference(PCA Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(PCA Organization)Organization where the roles are available - see Must support section
... Slices for code SΣ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
.... code:practitionerRole SΣ1..*CodeableConceptPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... preferred S0..1booleanWhether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... code:hiServiceRole SΣ0..1CodeableConceptPCA HI Service Role
Binding: PCA HI Service Role (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location Σ0..1Reference(PCA Location)The location at which this practitioner provides care - see Must support section
... healthcareService S1..1Reference(PCA Healthcare Service)The service a practitioner provides when in this role
... telecom Σ0..*ContactPointContact details that are specific to the role/location/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)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... 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 services operated for the practitioner with this role

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*AUBasePractitionerRoleA 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 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
... pca-preferred-name S0..1HumanNamePractitioner'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 S0..*CodeableConceptA 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... pca-service-provision-capacity S0..1stringDays per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... pca-pbs-prescriber-number S0..1AUPBSPrescriberNumberPBS Prescriber Number relevant to when the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-pbs-prescriber-number
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S0..1PcaMedicareProviderNumberPCA Medicare Provider Number
.... identifier:pca-pri S0..1PcaPractitionerRoleIdentifierPCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber 0..1AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active S0..1booleanWhether this practitioner role record is in active use
... period SC0..1PeriodThe 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 S1..1Reference(PCA Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 0..1Reference(PCA Organization)Organization where the roles are available - see Must support section
... Slices for code S0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
.... code:practitionerRole S1..*CodeableConceptPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... preferred S0..1booleanWhether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
.... code:hiServiceRole S0..1CodeableConceptPCA HI Service Role
Binding: PCA HI Service Role (required)
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
... location 0..1Reference(PCA Location)The location at which this practitioner provides care - see Must support section
... healthcareService S1..1Reference(PCA Healthcare Service)The service a practitioner provides when in this role

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*AUBasePractitionerRoleA 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 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-preferred-name S0..1HumanNamePractitioner'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 S0..*CodeableConceptA 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... pca-service-provision-capacity S0..1stringDays per week that the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-provision-capacity
... pca-pbs-prescriber-number S0..1AUPBSPrescriberNumberPBS Prescriber Number relevant to when the practitioner provides the healthcare service
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-pbs-prescriber-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumberBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open by value:system
.... identifier:pca-medicareprovidernumber S0..1PcaMedicareProviderNumberPCA Medicare Provider Number
.... identifier:pca-pri S0..1PcaPractitionerRoleIdentifierPCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
.... identifier:ahpraRegistrationNumber C0..1AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
... active SΣ0..1booleanWhether this practitioner role record is in active use
... period SΣC0..1PeriodThe 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..1Reference(PCA Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(PCA Organization)Organization where the roles are available - see Must support section
... Slices for code SΣ0..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
.... code:practitionerRole SΣ1..*CodeableConceptPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... preferred S0..1booleanWhether this is the primary code for this PractitionerRole
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... code:hiServiceRole SΣ0..1CodeableConceptPCA HI Service Role
Binding: PCA HI Service Role (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location Σ0..1Reference(PCA Location)The location at which this practitioner provides care - see Must support section
... healthcareService S1..1Reference(PCA Healthcare Service)The service a practitioner provides when in this role
... telecom Σ0..*ContactPointContact details that are specific to the role/location/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)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... 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 services operated for the practitioner with this role

doco Documentation for this format

 

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

 

SD.21.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.21.3 - Known issues

No known issues.