Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
Magentus Practice Management FHIR® Implementation Guide - Downloaded Version 1.3.2 See the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-practitionerrole | Version: 1.3.2 | ||||
| Active as of 2026-10-02 | Computable Name: GSPractitionerRole | ||||
A clinician acting in a particular role at a particular organisation. This is the form in which practitioners are referenced in workflows that need the practice context, such as eOrders, because a request is placed by a clinician at a practice rather than by a clinician alone. Some profiles reference GSPractitioner directly instead, for example EBookingsServiceRequest.requester and .performer. Derived from AU eRequesting PractitionerRole. Requires a display name on practitioner, and on organization when it is present, so a recipient can render the requester without resolving the references. organization itself is optional.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
  PractitionerRole |
||||||
  Slices for identifier |
|
|
|
| ||
   identifier:medicareProvider |
|
|
|
| ||
 identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
 practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
 code |
|
|
|
| ||
| specialty |
|
|
|
| ||
 telecom |
|
|
|
| ||
  system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.1.0 | tx.hl7.org.au |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
| PractitionerRole |
AUeRequestingPractitionerRole | |||
 id |
S | 0..1 | id | Logical id of this artifact |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:localPractitionerRoleIdentifier |
0..1 | GSPractitionerRoleLocalIdentifier | Business Identifiers that are specific to a role/location | |
| active |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
| practitioner |
1..1 | Reference(Genie Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| display |
1..1 | string | Provider name | |
| organization |
0..1 | Reference(Genie Organization) | Organization where the roles are available | |
| display |
1..1 | string | Practice name | |
| code |
0..1 | CodeableConcept | Provider Type | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| text |
1..1 | string | Plain text representation of the concept | |
| specialty |
0..1 | CodeableConcept | Provider Specialty | |
| text |
1..1 | string | Plain text representation of the concept | |
| location |
S | 0..1 | Reference(Genie Location) | Provider Site |
| display |
1..1 | string | Site name | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||||||||||||||||||
| id |
SΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||||||||
| 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 |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:medicareProvider |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| identifier:localPractitionerRoleIdentifier |
SOΣ | 0..1 | GSPractitionerRoleLocalIdentifier | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||||||||||||||||||||||
| practitioner |
SOΣC | 1..1 | Reference(Genie Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Provider name | ||||||||||||||||||||||||
| organization |
SOΣ | 0..1 | Reference(Genie Organization) | Organization where the roles are available
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Practice name | ||||||||||||||||||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Provider Type Binding: Practitioner Role (preferred)
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| specialty |
SOΣ | 0..1 | CodeableConcept | Provider Specialty Binding: Clinical Specialty (preferred)
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| location |
SΣ | 0..1 | Reference(Genie Location) | Provider Site | ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Site name | ||||||||||||||||||||||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||||||||||||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||
| extension:timeZone |
0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||
| extension:timeZone |
0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| PractitionerRole |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:medicareProvider |
|
|
|
| ||
| identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
| practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
| code |
|
|
|
| ||
| specialty |
|
|
|
| ||
| telecom |
|
|
|
| ||
| system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.practitioner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.organization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.1.0 | tx.hl7.org.au |
| PractitionerRole.location.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| PractitionerRole |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:medicareProvider |
|
|
|
| ||
| identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
| practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
| code |
|
|
|
| ||
| specialty |
|
|
|
| ||
| telecom |
|
|
|
| ||
| system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
Summary
Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||||||||||||||||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||
| Slices for identifier |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:medicareProvider |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| identifier:localPractitionerRoleIdentifier |
SOΣ | 0..1 | GSPractitionerRoleLocalIdentifier | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use | ||||||||||||||||||||||||
| practitioner |
SOΣC | 1..1 | Reference(Genie Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||||||||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Provider name | ||||||||||||||||||||||||
| organization |
SOΣ | 0..1 | Reference(Genie Organization) | Organization where the roles are available
| ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Practice name | ||||||||||||||||||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Provider Type Binding: Practitioner Role (preferred)
| ||||||||||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| specialty |
SOΣ | 0..1 | CodeableConcept | Provider Specialty Binding: Clinical Specialty (preferred)
| ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| location |
SΣ | 0..1 | Reference(Genie Location) | Provider Site | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Site name | ||||||||||||||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| PractitionerRole |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:medicareProvider |
|
|
|
| ||
| identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
| practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
| code |
|
|
|
| ||
| specialty |
|
|
|
| ||
| telecom |
|
|
|
| ||
| system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.1.0 | tx.hl7.org.au |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
AUeRequestingPractitionerRole | |||
| id |
S | 0..1 | id | Logical id of this artifact |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:localPractitionerRoleIdentifier |
0..1 | GSPractitionerRoleLocalIdentifier | Business Identifiers that are specific to a role/location | |
| active |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
| practitioner |
1..1 | Reference(Genie Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| display |
1..1 | string | Provider name | |
| organization |
0..1 | Reference(Genie Organization) | Organization where the roles are available | |
| display |
1..1 | string | Practice name | |
| code |
0..1 | CodeableConcept | Provider Type | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| text |
1..1 | string | Plain text representation of the concept | |
| specialty |
0..1 | CodeableConcept | Provider Specialty | |
| text |
1..1 | string | Plain text representation of the concept | |
| location |
S | 0..1 | Reference(Genie Location) | Provider Site |
| display |
1..1 | string | Site name | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | AUeRequestingPractitionerRole | A person with formal responsibility in a role providing one or more services | |||||||||||||||||||||||||
| id |
SΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||||||||
| 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 |
SOΣ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:medicareProvider |
SOΣ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| identifier:localPractitionerRoleIdentifier |
SOΣ | 0..1 | GSPractitionerRoleLocalIdentifier | Business Identifiers that are specific to a role/location
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||||||||||||||||||||||
| practitioner |
SOΣC | 1..1 | Reference(Genie Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Provider name | ||||||||||||||||||||||||
| organization |
SOΣ | 0..1 | Reference(Genie Organization) | Organization where the roles are available
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Practice name | ||||||||||||||||||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Provider Type Binding: Practitioner Role (preferred)
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| specialty |
SOΣ | 0..1 | CodeableConcept | Provider Specialty Binding: Clinical Specialty (preferred)
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||||||||||||||
| location |
SΣ | 0..1 | Reference(Genie Location) | Provider Site | ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||||||||||||||
| display |
Σ | 1..1 | string | Site name | ||||||||||||||||||||||||
| healthcareService |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||||||||||||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
| ||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| system |
SOΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
| ||||||||||||||||||||||||
| value |
SOΣ | 0..1 | string | The actual contact point details
| ||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||||||||||||||||||||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||||||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||
| extension:timeZone |
0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||||||||||||||||||
| 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 | |||||||||||||||||||||||||
| extension:timeZone |
0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| PractitionerRole |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:medicareProvider |
|
|
|
| ||
| identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
| practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
| code |
|
|
|
| ||
| specialty |
|
|
|
| ||
| telecom |
|
|
|
| ||
| system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PractitionerRole.practitioner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.organization.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred |
Practitioner Role
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.specialty | Base | preferred |
Clinical Specialty
|
⏿1.1.0 | tx.hl7.org.au |
| PractitionerRole.location.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| PractitionerRole |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:medicareProvider |
|
|
|
| ||
| identifier:localPractitionerRoleIdentifier |
|
|
|
| ||
| practitioner |
|
|
|
| ||
| organization |
|
|
|
| ||
| code |
|
|
|
| ||
| specialty |
|
|
|
| ||
| telecom |
|
|
|
| ||
| system |
|
|
|
| ||
| value |
|
|
|
| ||
| Documentation for this format | ||||||
Summary
Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron