AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCorePractitionerRole | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a PractitionerRole resource to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Base Practitioner Role profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.
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 | 0..* | AUBasePractitionerRole | A person with formal responsibility in a role providing one or more services | |
  Slices for identifier | S | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type |
   identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number |
  practitioner | SC | 1..1 | Reference(AU Core Practitioner) | Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present |
| organization | S | 0..1 | Reference(AU 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 | S | 0..* | Reference(AU Core Location) | The location(s) at which this practitioner provides care |
 telecom | S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present : reference.exists() or identifier.exists() or display.exists() |
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| identifier | SHALL | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using HPI-I and Medicare Provider Number identifiers as defined in the profile. The server SHOULD support search using the using HPI-I and Medicare Provider Number identifiers as defined in the profile. |
| practitioner | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| _id | SHOULD | token |
|
| practitioner.identifier | SHOULD | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using a HPI-I identifier as defined in the profile. The server SHOULD support search using the using a HPI-I identifier as defined in the profile. |
| specialty | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| organization | MAY | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
The following search parameters SHALL be supported:
identifier search parameter:
_include parameters: PractitionerRole:practitioner_revinclude parameters: Provenance:targetGET [base]/PractitionerRole?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any PractitionerRole resources matching the identifier (how to search by token)
practitioner search parameters:
practitioner.identifier (e.g. practitioner.identifier=[system|][code])_include parameters: PractitionerRole:practitioner_revinclude parameters: Provenance:targetGET [base]/PractitionerRole?practitioner={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources matching the specified practitioner (how to search by reference)
The following search parameters and search parameter combinations SHOULD be supported:
_id search parameter:
_include parameters: PractitionerRole:practitioner_revinclude parameters: Provenance:targetGET [base]/PractitionerRole/[id] or GET [base]/PractitionerRole?_id=[id]
Example:
Implementation Notes: Returns a single PractitionerRole resource. (how to search by the logical id of the resource)
specialty search parameter:
_include parameters: PractitionerRole:practitioner_revinclude parameters: Provenance:targetGET [base]/PractitionerRole?specialty={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified specialty (how to search by token)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change