Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-core-1 | Version: 1.0.1 | |||
| Active as of 2024-12-19 | Computable Name: ADHAPractitionerRoleCore | |||
Copyright/Legal: Copyright © 2022 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/. |
||||
The purpose of this profile is to define a core representation of a practitioner in a role, on behalf of an organisation, for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
In the context of an exchange of health information a practitioner role is part of the context established for a set of healthcare-related information.
This profile identifies the additional constraints, extensions, and value sets that build on and extend PractitionerRole that are supported.
A PractitionerRole resource is used within the context of a referencing resource.
This profile is designed to set a core PractitionerRole standard for:
This profile may be referred to by APIs, which will be listed here when available.
None.
These profiles build on this profile (ADHA Core PractitionerRole) to define specific roles:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display |
  Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
   identifier:hpii |
S | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) |
| identifier:caei |
S | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier |
 identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
  active |
0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true | |
 practitioner |
SC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present |
| organization |
SC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available |
| code |
S | 0..* | CodeableConcept | Roles which this practitioner may perform |
| specialty |
S | 0..* | CodeableConcept | Specific specialty of the practitioner |
| location |
SC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care |
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
 telecom |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) ele-1: All FHIR elements must have a @value or children inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check |
| identifier:caei |
SC | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier ele-1: All FHIR elements must have a @value or children inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
| identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number ele-1: All FHIR elements must have a @value or children |
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
| practitioner |
SΣC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children inv-dh-prarol-04: At least a reference, identifier or display shall be present |
| organization |
SΣC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children |
 code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role  (preferred)ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)ele-1: All FHIR elements must have a @value or children |
| location |
SΣC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type | ||||
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check | ||||
| identifier:caei |
SC | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check | ||||
| identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present | ||||
| organization |
SΣC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) | ||||
| location |
SΣC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value |
0..1 | time | Primitive value for time | |||||
 availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value |
0..1 | time | Primitive value for time | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 2 elements
Must-Support: 11 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBasePractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display |
| Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
| identifier:hpii |
S | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) |
| identifier:caei |
S | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier |
| identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
| active |
0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true | |
| practitioner |
SC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present |
| organization |
SC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available |
| code |
S | 0..* | CodeableConcept | Roles which this practitioner may perform |
| specialty |
S | 0..* | CodeableConcept | Specific specialty of the practitioner |
| location |
SC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care |
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) ele-1: All FHIR elements must have a @value or children inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check |
| identifier:caei |
SC | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier ele-1: All FHIR elements must have a @value or children inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
| identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number ele-1: All FHIR elements must have a @value or children |
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
| practitioner |
SΣC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children inv-dh-prarol-04: At least a reference, identifier or display shall be present |
| organization |
SΣC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)ele-1: All FHIR elements must have a @value or children |
| location |
SΣC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) ele-1: All FHIR elements must have a @value or children |
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services inv-dh-prarol-01: If present, an organization shall at least have a reference, an identifier or a display inv-dh-prarol-02: If present, a location shall at least have a reference, an identifier or a display inv-dh-prarol-03: If present, a healthcare service shall at least have a reference, an identifier or a display | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type | ||||
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check | ||||
| identifier:caei |
SC | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check | ||||
| identifier:medicareProvider |
S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization inv-dh-prarol-04: At least a reference, identifier or display shall be present | ||||
| organization |
SΣC | 0..1 | Reference(ADHA Core Organization) | Organization where the roles are available | ||||
| code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred) | ||||
| location |
SΣC | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value |
0..1 | time | Primitive value for time | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value |
0..1 | time | Primitive value for time | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| PractitionerRole.code | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| PractitionerRole.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-prarol-01 | error | PractitionerRole | If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-02 | error | PractitionerRole | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-03 | error | PractitionerRole | If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
| inv-dh-prarol-04 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
This structure is derived from AUBasePractitionerRole
Summary
Mandatory: 2 elements
Must-Support: 11 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Core PractitionerRole profile.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
