Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> 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 S 0..1 id Logical id of this artifact meta S 0..1 Meta Metadata about the resource versionId S 0..1 id Version specific identifier lastUpdated S 0..1 instant When the resource version last changed 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: 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 pca-pbs-prescriber-number S 0..1 AUPBSPrescriberNumber PBS 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 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 period SC 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 code:practitionerRole S 1..* CodeableConcept Practitioner Role (SNOMED CT) Binding: Practitioner Role (required) 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 <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
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.
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/.
A role a practitioner performs at a service offered by a publisher
A role a practitioner performs at a service offered by a publisher.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
healthcareService shall be a relative reference to a HealthcareService
practitioner shall be a relative reference to a Practitioner
If 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)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Practitioner's preferred name in this role at a specific location
Name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
A language the practitioner can use in patient communication when acting in a role at a HealthcareService
A language the practitioner can use in patient communication when acting in a role at a HealthcareService.
Bank account details for the healthcare servcie or practitioner role record.
Days per week that the practitioner provides the healthcare service
Number of days per week that the practitioner provides the healthcare service.
PBS Prescriber Number relevant to when the practitioner provides the healthcare service
PBS Prescriber Number relevant to when the practitioner provides the healthcare service.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business Identifiers that are specific to a role/location
Business Identifiers that are specific to a role/location.
Often, specific identities are assigned for the agent.
CX / EI (occasionally, more often EI maps to a resource id or a URL)
II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
Medicare provider number assigned by Services Australia to practitioners who provide services covered by Medicare Benefits Schedule (MBS) at a specific location.
PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
The PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service to each PCA Practitioner Role.
Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
Australian Health Practitioner Regulation Authority (Ahpra) registration number assigned to a practitioner.
Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
Whether this practitioner role record is in active use
Whether this practitioner role record is in active use.
If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
This resource is generally assumed to be active if no value is provided for the active element
The period during which the practitioner is authorized to perform in these role(s)
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Even after the agencies is revoked, the fact that it existed must still be recorded.
If present, start shall be later than '1900-01-01'
(start.exists()) implies (start > @1900-01-01)
If present, end shall be no more than 5 years from the current date
(end.exists()) implies (end < (now() + 5 years))
.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
Practitioner that is able to provide the defined services for the organization
Practitioner that is able to provide the defined services for the organization.
Organization where the roles are available - see Must support section
The organization where the Practitioner performs the roles associated.
Roles which this practitioner may perform
Roles which this practitioner is authorized to perform for the organization.
Need to know what authority the practitioner has - what can they do?
Whether this is the primary code for this PractitionerRole
Whether this is the primary code for this PractitionerRole.
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
.player.HealthCareProvider[@classCode = 'PROV'].code
The location at which this practitioner provides care - see Must support section
The location(s) at which this practitioner provides care.
.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
(ServD maps Practitioners and Organizations via another entity, so this concept is not available) However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
The service a practitioner provides when in this role
The list of healthcare services that this worker provides for this role's Organization/Location(s).
.player.QualifiedEntity[@classCode = 'QUAL'].code
Contact details that are specific to the role/location/service
Contact details that are specific to the role/location/service.
Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
More detailed availability information may be provided in associated Schedule/Slot resources.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Indicates which days of the week are available between the start and end Times.
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Opening time of day (ignored if allDay = true)
The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
The timezone is expected to be for where this HealthcareService is provided at.
unique id for the element within a resource (for internal references)
Closing time of day (ignored if allDay = true)
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Not available during this time due to provided reason
The practitioner is not available or performing this role during this period of time due to the provided reason.
Reason presented to the user explaining why time not available
The reason that can be presented to the user as to why this time is not available.
Service is not available (seasonally or for a public holiday) from this date.
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Technical endpoints providing access to services operated for the practitioner with this role
Technical endpoints providing access to services operated for the practitioner with this role.
Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.