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-practitioner | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCorePractitioner | ||
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 Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the AU Base Practitioner profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Practitioner 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.
CareTeam.member instead of the Practitioner resource. If a system only supports Practitioner, the system SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |
  Slices for identifier | S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type |
   identifier:hpii | S | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) |
  name | SC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present |
| telecom | S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
| identifier | S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation |
| code | S | 1..1 | CodeableConcept | Coded representation of the qualification |
| period | S | 0..1 | Period | Period during which the qualification is valid |
 issuer | S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.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 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. |
| _id | SHOULD | token |
|
| name | SHOULD | string |
The following search parameters SHALL be supported:
identifier search parameter:
_revinclude parameters: Provenance:targetGET [base]/Practitioner?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)
The following search parameters SHOULD be supported:
_id search parameter:
_revinclude parameters: Provenance:targetGET [base]/Practitioner/[id] or GET [base]/Practitioner?_id=[id]
Example:
Implementation Notes: Returns a single Practitioner resource (how to search by the logical id of the resource)
name search parameter:
_revinclude parameters: Provenance:targetGET [base]/Practitioner?name=[string]
Example:
Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)
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