# Provider Connect Australia (PCA)

25.1.0.0 - active

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

## Resource Profile: PcaPractitionerRole - Detailed Descriptions

Active as of 2025-05-14

Definitions for the pca-practitioner-role resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. PractitionerRole
Definition | A role a practitioner performs at a service offered by a publisher. A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Short | A role a practitioner performs at a service offered by a publisherRoles/organizations the practitioner is associated with
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) inv-pca-1: healthcareService shall be a relative reference to a HealthcareService (`healthcareService.reference.startsWith('HealthcareService/')`) inv-pca-2: practitioner shall be a relative reference to a Practitioner (`practitioner.reference.startsWith('Practitioner/')`) inv-pca-3: 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)`)
2. PractitionerRole.implicitRules
Definition | 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.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PractitionerRole.extension:pca-preferred-name
Slice Name | pca-preferred-name
Definition | Name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
Short | Practitioner's preferred name in this role at a specific location
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Preferred Name) (Extension Type: HumanName)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. PractitionerRole.extension:pca-practitioner-role-communication
Slice Name | pca-practitioner-role-communication
Definition | A language the practitioner can use in patient communication when acting in a role at a HealthcareService.
Short | A language the practitioner can use in patient communication when acting in a role at a HealthcareService
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Practitioner Role Communication) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. PractitionerRole.extension:pca-bank-account
Slice Name | pca-bank-account
Definition | Bank account details for the healthcare service, practitioner or practitioner role record.
Short | Bank account details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Bank Account) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. PractitionerRole.extension:pca-service-provision-capacity
Slice Name | pca-service-provision-capacity
Definition | Number of days per week that the practitioner provides the healthcare service.
Short | Days per week that the practitioner provides the healthcare service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Service Provision Capacity) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PractitionerRole.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | 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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. PractitionerRole.identifier
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..* This element is affected by the following invariants: ele-1
Type | Identifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
16. PractitionerRole.identifier:pca-medicareprovidernumber
Slice Name | pca-medicareprovidernumber
Definition | Business Identifiers that are specific to a role/location.
Short | PCA Medicare Provider NumberBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(PCA Medicare Provider Number)
Is Modifier | false
Must Support | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. PractitionerRole.identifier:pca-pri
Slice Name | pca-pri
Definition | Business Identifiers that are specific to a role/location.
Short | PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA serviceBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(PCA Practitioner Role Identifier (PCA-PRI))
Is Modifier | false
Must Support | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. PractitionerRole.identifier:ahpraRegistrationNumber
Slice Name | ahpraRegistrationNumber
Definition | Business Identifiers that are specific to a role/location.
Short | Australian Health Practitioner Regulation Agency (Ahpra) Registration NumberBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1* This element is affected by the following invariants: ele-1
Type | Identifier(AU Ahpra Registration Number)
Is Modifier | false
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Short | Whether this practitioner role record is in active use
Comments | 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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. PractitionerRole.period
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Short | The period during which the practitioner is authorized to perform in these role(s)
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | true
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-pca-5: If present, start shall be later than '1900-01-01' (`(start.exists()) implies (start > @1900-01-01)`) inv-pca-6: If present, end shall be no more than 5 years from the current date (`(end.exists()) implies (end < (now() + 5 years))`)
26. PractitionerRole.practitioner
Definition | Practitioner that is able to provide the defined services for the organization.
Short | Practitioner that is able to provide the defined services for the organization
Control | 10..1
Type | Reference(PCA Practitioner, Practitioner)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PractitionerRole.organization
Definition | The organization where the Practitioner performs the roles associated.
Short | Organization where the roles are available - see Must support section
Control | 0..1
Type | Reference(PCA Organization, Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PractitionerRole.code
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Roles which this practitioner may perform
Comments | A person may have more than one role.
Control | 10..*
Binding | The codes SHOULD be taken from For example codes, see Practitioner Role http://hl7.org/fhir/ValueSet/practitioner-role (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.code`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
32. PractitionerRole.code:practitionerRole
Slice Name | practitionerRole
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Practitioner Role (SNOMED CT)Roles which this practitioner may perform
Comments | A person may have more than one role.
Control | 10..*
Binding | The codes SHALL be taken from For example codes, see Practitioner Role http://hl7.org/fhir/ValueSet/practitioner-role (required to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. PractitionerRole.code:practitionerRole.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary code for this PractitionerRole.
Short | Whether this is the primary code for this PractitionerRole
Control | 0..1
Type | Extension(preferred) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. PractitionerRole.code:hiServiceRole
Slice Name | hiServiceRole
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | PCA HI Service RoleRoles which this practitioner may perform
Comments | A person may have more than one role.
Control | 0..1*
Binding | The codes SHALL be taken from For example codes, see PCA HI Service Role http://hl7.org/fhir/ValueSet/practitioner-role (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PractitionerRole.location
Definition | The location(s) at which this practitioner provides care.
Short | The location at which this practitioner provides care - see Must support sectionThe location(s) at which this practitioner provides care
Control | 0..1*
Type | Reference(PCA Location, Location)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Short | The service a practitioner provides when in this roleThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Control | 10..1*
Type | Reference(PCA Healthcare Service, HealthcareService)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. PractitionerRole
Definition | A role a practitioner performs at a service offered by a publisher.
Short | A role a practitioner performs at a service offered by a publisher
Invariants | inv-pca-1: healthcareService shall be a relative reference to a HealthcareService (`healthcareService.reference.startsWith('HealthcareService/')`) inv-pca-2: practitioner shall be a relative reference to a Practitioner (`practitioner.reference.startsWith('Practitioner/')`) inv-pca-3: 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)`)
2. PractitionerRole.extension:pca-preferred-name
Slice Name | pca-preferred-name
Short | Practitioner's preferred name in this role at a specific location
Control | 0..1
Type | Extension(PCA Preferred Name) (Extension Type: HumanName)
Must Support | true
4. PractitionerRole.extension:pca-practitioner-role-communication
Slice Name | pca-practitioner-role-communication
Type | Extension(PCA Practitioner Role Communication) (Extension Type: CodeableConcept)
Must Support | true
6. PractitionerRole.extension:pca-bank-account
Slice Name | pca-bank-account
Control | 0..*
Type | Extension(PCA Bank Account) (Complex Extension)
Must Support | true
8. PractitionerRole.extension:pca-service-provision-capacity
Slice Name | pca-service-provision-capacity
Control | 0..1
Type | Extension(PCA Service Provision Capacity) (Extension Type: string)
Must Support | true
10. PractitionerRole.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Must Support | true
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
12. PractitionerRole.identifier:pca-medicareprovidernumber
Slice Name | pca-medicareprovidernumber
Short | PCA Medicare Provider Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(PCA Medicare Provider Number)
Must Support | true
14. PractitionerRole.identifier:pca-pri
Slice Name | pca-pri
Short | PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(PCA Practitioner Role Identifier (PCA-PRI))
Must Support | true
16. PractitionerRole.identifier:ahpraRegistrationNumber
Slice Name | ahpraRegistrationNumber
Short | Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(AU Ahpra Registration Number)
18. PractitionerRole.active
Must Support | true
20. PractitionerRole.period
Must Support | true
Invariants | inv-pca-5: If present, start shall be later than '1900-01-01' (`(start.exists()) implies (start > @1900-01-01)`) inv-pca-6: If present, end shall be no more than 5 years from the current date (`(end.exists()) implies (end < (now() + 5 years))`)
22. PractitionerRole.practitioner
Control | 1..?
Type | Reference(PCA Practitioner)
Must Support | true
24. PractitionerRole.organization
Short | Organization where the roles are available - see Must support section
Type | Reference(PCA Organization)
26. PractitionerRole.code
Control | 1..?
Must Support | true
Slicing | This element introduces a set of slices on `PractitionerRole.code`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
28. PractitionerRole.code:practitionerRole
Slice Name | practitionerRole
Short | Practitioner Role (SNOMED CT)
Control | 1..?
Binding | The codes SHALL be taken from Practitioner Role (required to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Must Support | true
30. PractitionerRole.code:practitionerRole.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary code for this PractitionerRole.
Short | Whether this is the primary code for this PractitionerRole
Control | 0..1
Type | Extension(preferred) (Extension Type: boolean)
Must Support | true
32. PractitionerRole.code:practitionerRole.coding
34. PractitionerRole.code:practitionerRole.coding.system
Control | 1..?
Fixed Value | `http://snomed.info/sct`
36. PractitionerRole.code:hiServiceRole
Slice Name | hiServiceRole
Short | PCA HI Service Role
Control | 0..1
Binding | The codes SHALL be taken from PCA HI Service Role (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role` )
Must Support | true
38. PractitionerRole.code:hiServiceRole.coding
40. PractitionerRole.code:hiServiceRole.coding.system
Control | 1..?
Fixed Value | `http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role`
42. PractitionerRole.location
Short | The location at which this practitioner provides care - see Must support section
Control | 0..1
Type | Reference(PCA Location)
44. PractitionerRole.healthcareService
Short | The service a practitioner provides when in this role
Control | 1..1
Type | Reference(PCA Healthcare Service)
Must Support | true

Guidance on how to interpret the contents of this table can be found here

0. PractitionerRole
Definition | A role a practitioner performs at a service offered by a publisher.
Short | A role a practitioner performs at a service offered by a publisher
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) inv-pca-1: healthcareService shall be a relative reference to a HealthcareService (`healthcareService.reference.startsWith('HealthcareService/')`) inv-pca-2: practitioner shall be a relative reference to a Practitioner (`practitioner.reference.startsWith('Practitioner/')`) inv-pca-3: 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)`)
2. PractitionerRole.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. PractitionerRole.meta
Definition | 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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PractitionerRole.implicitRules
Definition | 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.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because 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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. PractitionerRole.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | 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).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. PractitionerRole.text
Definition | 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.
Short | Text summary of the resource, for human interpretation
Comments | 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.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. PractitionerRole.contained
Definition | 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.
Short | Contained, inline Resources
Comments | 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.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. PractitionerRole.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. PractitionerRole.extension:pca-preferred-name
Slice Name | pca-preferred-name
Definition | Name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
Short | Practitioner's preferred name in this role at a specific location
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Preferred Name) (Extension Type: HumanName)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. PractitionerRole.extension:pca-practitioner-role-communication
Slice Name | pca-practitioner-role-communication
Definition | A language the practitioner can use in patient communication when acting in a role at a HealthcareService.
Short | A language the practitioner can use in patient communication when acting in a role at a HealthcareService
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Practitioner Role Communication) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. PractitionerRole.extension:pca-bank-account
Slice Name | pca-bank-account
Definition | Bank account details for the healthcare service, practitioner or practitioner role record.
Short | Bank account details
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(PCA Bank Account) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. PractitionerRole.extension:pca-service-provision-capacity
Slice Name | pca-service-provision-capacity
Definition | Number of days per week that the practitioner provides the healthcare service.
Short | Days per week that the practitioner provides the healthcare service
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PCA Service Provision Capacity) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. PractitionerRole.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | 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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. PractitionerRole.identifier
Definition | Business Identifiers that are specific to a role/location.
Short | Business Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..* This element is affected by the following invariants: ele-1
Type | Identifier(Identifier, AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
28. PractitionerRole.identifier:pca-medicareprovidernumber
Slice Name | pca-medicareprovidernumber
Definition | Business Identifiers that are specific to a role/location.
Short | PCA Medicare Provider Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(PCA Medicare Provider Number)
Is Modifier | false
Must Support | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. PractitionerRole.identifier:pca-pri
Slice Name | pca-pri
Definition | Business Identifiers that are specific to a role/location.
Short | PCA Practitioner Role Identifier (PCA-PRI) issued by the PCA service
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(PCA Practitioner Role Identifier (PCA-PRI))
Is Modifier | false
Must Support | true
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. PractitionerRole.identifier:ahpraRegistrationNumber
Slice Name | ahpraRegistrationNumber
Definition | Business Identifiers that are specific to a role/location.
Short | Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Identifier(AU Ahpra Registration Number)
Is Modifier | false
Requirements | Often, specific identities are assigned for the agent.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Short | Whether this practitioner role record is in active use
Comments | 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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | 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.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. PractitionerRole.period
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Short | The period during which the practitioner is authorized to perform in these role(s)
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | true
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) inv-pca-5: If present, start shall be later than '1900-01-01' (`(start.exists()) implies (start > @1900-01-01)`) inv-pca-6: If present, end shall be no more than 5 years from the current date (`(end.exists()) implies (end < (now() + 5 years))`)
38. PractitionerRole.practitioner
Definition | Practitioner that is able to provide the defined services for the organization.
Short | Practitioner that is able to provide the defined services for the organization
Control | 1..1
Type | Reference(PCA Practitioner)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. PractitionerRole.organization
Definition | The organization where the Practitioner performs the roles associated.
Short | Organization where the roles are available - see Must support section
Control | 0..1
Type | Reference(PCA Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. PractitionerRole.code
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Roles which this practitioner may perform
Comments | A person may have more than one role.
Control | 1..*
Binding | The codes SHOULD be taken from Practitioner Role (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PractitionerRole.code`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ coding.system
44. PractitionerRole.code:practitionerRole
Slice Name | practitionerRole
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | Practitioner Role (SNOMED CT)
Comments | A person may have more than one role.
Control | 1..*
Binding | The codes SHALL be taken from Practitioner Role (required to `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. PractitionerRole.code:practitionerRole.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
48. PractitionerRole.code:practitionerRole.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. PractitionerRole.code:practitionerRole.extension:preferred
Slice Name | preferred
Definition | Whether this is the primary code for this PractitionerRole.
Short | Whether this is the primary code for this PractitionerRole
Control | 0..1
Type | Extension(preferred) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
52. PractitionerRole.code:practitionerRole.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. PractitionerRole.code:practitionerRole.coding.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
56. PractitionerRole.code:practitionerRole.coding.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
58. PractitionerRole.code:practitionerRole.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://snomed.info/sct`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. PractitionerRole.code:practitionerRole.coding.version
Definition | 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. PractitionerRole.code:practitionerRole.coding.code
Definition | 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PractitionerRole.code:practitionerRole.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. PractitionerRole.code:practitionerRole.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. PractitionerRole.code:practitionerRole.text
Definition | 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. PractitionerRole.code:hiServiceRole
Slice Name | hiServiceRole
Definition | Roles which this practitioner is authorized to perform for the organization.
Short | PCA HI Service Role
Comments | A person may have more than one role.
Control | 0..1
Binding | The codes SHALL be taken from PCA HI Service Role (required to `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-hi-service-role` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. PractitionerRole.code:hiServiceRole.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
74. PractitionerRole.code:hiServiceRole.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
76. PractitionerRole.code:hiServiceRole.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | 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.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. PractitionerRole.code:hiServiceRole.coding.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. PractitionerRole.code:hiServiceRole.coding.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
82. PractitionerRole.code:hiServiceRole.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | 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.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://pca.digitalhealth.gov.au/fhir/4.0/CodeSystem/pca-hi-service-role`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. PractitionerRole.code:hiServiceRole.coding.version
Definition | 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.
Short | Version of the system - if relevant
Comments | 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.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. PractitionerRole.code:hiServiceRole.coding.code
Definition | 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).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PractitionerRole.code:hiServiceRole.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. PractitionerRole.code:hiServiceRole.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | 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.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. PractitionerRole.code:hiServiceRole.text
Definition | 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. PractitionerRole.specialty
Definition | Specific specialty of the practitioner.
Short | Specific specialty of the practitioner
Control | 0..*
Binding | The codes SHOULD be taken from Clinical Specialty (preferred to `https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. PractitionerRole.location
Definition | The location(s) at which this practitioner provides care.
Short | The location at which this practitioner provides care - see Must support section
Control | 0..1
Type | Reference(PCA Location)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Short | The service a practitioner provides when in this role
Control | 1..1
Type | Reference(PCA Healthcare Service)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. PractitionerRole.telecom
Definition | Contact details that are specific to the role/location/service.
Short | Contact details that are specific to the role/location/service
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | true
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. PractitionerRole.availableTime
Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Short | Times the Service Site is available
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. PractitionerRole.availableTime.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
106. PractitionerRole.availableTime.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
108. PractitionerRole.availableTime.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
110. PractitionerRole.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Short | mon | tue | wed | thu | fri | sat | sun
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` ) The days of the week.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. PractitionerRole.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Short | Always available? e.g. 24 hour service
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. PractitionerRole.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Opening time of day (ignored if allDay = true)
Comments | The timezone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. PractitionerRole.availableTime.availableStartTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
118. PractitionerRole.availableTime.availableStartTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.availableTime.availableStartTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
120. PractitionerRole.availableTime.availableStartTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
122. PractitionerRole.availableTime.availableStartTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
124. PractitionerRole.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Short | Closing time of day (ignored if allDay = true)
Comments | The timezone is expected to be for where this HealthcareService is provided at.
Control | 0..1
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. PractitionerRole.availableTime.availableEndTime.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
128. PractitionerRole.availableTime.availableEndTime.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PractitionerRole.availableTime.availableEndTime.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
130. PractitionerRole.availableTime.availableEndTime.extension:timeZone
Slice Name | timeZone
Definition | Australian time zone.
Short | AU time zone
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Australian Time Zone) (Extension Type: CodeableConcept)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
132. PractitionerRole.availableTime.availableEndTime.value
Definition | The actual value
Short | Primitive value for time
Control | 0..1
Type | time
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
134. PractitionerRole.notAvailable
Definition | The practitioner is not available or performing this role during this period of time due to the provided reason.
Short | Not available during this time due to provided reason
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. PractitionerRole.notAvailable.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
138. PractitionerRole.notAvailable.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
140. PractitionerRole.notAvailable.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
142. PractitionerRole.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Short | Reason presented to the user explaining why time not available
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. PractitionerRole.notAvailable.during
Definition | Service is not available (seasonally or for a public holiday) from this date.
Short | Service not available from this date
Control | 0..1
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. PractitionerRole.availabilityExceptions
Definition | 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.
Short | Description of availability exceptions
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. PractitionerRole.endpoint
Definition | Technical endpoints providing access to services operated for the practitioner with this role.
Short | Technical endpoints providing access to services operated for the practitioner with this role
Control | 0..*
Type | Reference(Endpoint)
Is Modifier | false
Summary | false
Requirements | 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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)