Aged Care Clinical Note - Local Development build (v0.1.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/cn/StructureDefinition/au-aged-care-clin-note-practitionerrole | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUAgedCareClinNotePractitionerRole | ||
Usage:Jurisdiction: Australia |
||||
Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
This profile of PractitionerRole defines a Aged Care Health Note Practitioner Role.
The following are supported usage scenarios for this profile:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.0.0 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCorePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCorePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | |
![]() ![]() |
0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Healthcare provider's identifier | |
![]() ![]() |
1..1 | Reference(AU Aged Care Clinical Note - Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
1..1 | Reference(AU Aged Care Clinical Note - Organization) | Organization where the roles are available | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUCorePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | ||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Healthcare provider's identifier Slice: Unordered, Open by pattern:type
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| |||||||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | |||||||||
![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||||||
![]() ![]() |
SOΣC | 1..1 | Reference(AU Aged Care Clinical Note - Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| |||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Aged Care Clinical Note - Organization) | Organization where the roles are available
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| |||||||||
![]() ![]() |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |||||||||
![]() ![]() |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||||||||
![]() ![]() |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||||||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | ||||||||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | time | Primitive value for time | ||||||||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | time | Primitive value for time | ||||||||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | ||||||||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | ||||||||||
![]() ![]() |
0..1 | string | Description of availability exceptions | ||||||||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||||||||
Documentation for this format | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.0.0 | tx.ontoserver.csiro.au |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCorePractitionerRole
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUCorePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | ||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Healthcare provider's identifier Slice: Unordered, Open by pattern:type
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| |||||||||
![]() ![]() |
SOΣC | 1..1 | Reference(AU Aged Care Clinical Note - Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| |||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Aged Care Clinical Note - Organization) | Organization where the roles are available
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| |||||||||
![]() ![]() |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
Documentation for this format | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.0.0 | tx.ontoserver.csiro.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AUCorePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCorePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | |
![]() ![]() |
0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Healthcare provider's identifier | |
![]() ![]() |
1..1 | Reference(AU Aged Care Clinical Note - Practitioner) | Practitioner that is able to provide the defined services for the organization | |
![]() ![]() |
1..1 | Reference(AU Aged Care Clinical Note - Organization) | Organization where the roles are available | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUCorePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | ||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Healthcare provider's identifier Slice: Unordered, Open by pattern:type
| |||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| |||||||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | |||||||||
![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||||||
![]() ![]() |
SOΣC | 1..1 | Reference(AU Aged Care Clinical Note - Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| |||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Aged Care Clinical Note - Organization) | Organization where the roles are available
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
| |||||||||
![]() ![]() |
SOΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
| |||||||||
![]() ![]() |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | |||||||||
![]() ![]() |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||||||||
![]() ![]() |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| |||||||||
![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||||||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | ||||||||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | time | Primitive value for time | ||||||||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | ||||||||||
![]() ![]() ![]() ![]() |
0..1 | time | Primitive value for time | ||||||||||
![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | ||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | ||||||||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | ||||||||||
![]() ![]() |
0..1 | string | Description of availability exceptions | ||||||||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||||||||
Documentation for this format | |||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.0.0 | tx.ontoserver.csiro.au |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present |
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCorePractitionerRole
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron