Australian Provider Directory Implementation Guide (PD 2)
This page is part of the Australian Provider Directory IG (v2.0.1: PD 2 on FHIR R4) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
Australian Practitioner Directory Entry Profile
Provider directory details of an individual person delivering health related services.
Practitioner Directory Entry Example
The official URL for this profile is:
http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitioner
Base profile for Australian context Practitioner for provider directory usage
This profile builds on AUBasePractitioner.
This profile was published on Tue May 14 00:00:00 AEST 2019 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | Australian Practitioner Directory Entry | ||
 meta | 0..1 | Meta | Metadata on Practitioner | |
  source | S | 0..1 | uri | |
| hpii | S | 0..1 | Identifier | HPI-I for Directory Entry Practitioner |
| active | S | 1..1 | boolean | Required status |
 name | (Slice Definition) | Slice: Unordered, Open At End by value:use | ||
  directory-practitioner-name | S | 1..* | HumanName | Usual practitioner name |
 use | 1..1 | code | Fixed Value: usual | |
| family | 1..1 | string | ||
 given | 1..* | string | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | Australian Practitioner Directory Entry | |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata on Practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | SΣ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| 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) Max Binding: AllLanguages | |
| 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 |
| identifier | Σ | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system | |
 hpii | SΣI | 0..1 | Identifier | HPI-I for Directory Entry Practitioner |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for HPI-I Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-I |
| system | Σ | 1..1 | uri | Namespace for HPI-I Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0 |
| value | Σ | 1..1 | string | HPI-I number Example General': 123456 Example HPI-I number': 8003619900015717 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| medicarePrescriberNumber | Σ | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for prescriber number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Prescriber Number |
| system | Σ | 1..1 | uri | Namespace for prescriber number Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number |
| value | Σ | 1..1 | string | Medicare Prescriber number Example General': 123456 Example prescriber number': 453221 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| careAgencyEmployeeIdentifier | ΣI | 0..* | Identifier | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | Σ | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | Σ | 1..1 | string | CAE identifier number Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| ahpraRegistration | ΣI | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 Fixed Value: AHPRA Registration Number |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | The value that is unique Example General': 123456 Example AHPRA registration number': ANZ1234567890 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | SΣ | 1..1 | boolean | Required status |
| name | Σ | (Slice Definition) | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use | |
| directory-practitioner-name | SΣ | 1..* | HumanName | Usual practitioner name |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Fixed Value: usual |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system | |
| (All Slices) | Content/Rules for all slices | |||
| 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 |
| identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example) | |
| period | 0..1 | Period | Period during which the qualification is valid | |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| 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 |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for AHPRA registration number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 Fixed Value: AHPRA Registration Number |
| system | Σ | 1..1 | uri | Namespace for AHPRA registration number Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General': 123456 Example AHPRA registration number': ANZ1234567890 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| code | 1..1 | CodeableConcept | AHPRA codings Binding: v2 table 0360, Version 2.7 (example) | |
| 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 | AHPRA Registration Role |
| period | 0..1 | Period | Period during which the qualification is valid | |
| issuer | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| 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 | ΣI | 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) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource Fixed Value: AHPRA |
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Australian Practitioner Directory Entry | ||
| meta | 0..1 | Meta | Metadata on Practitioner | |
| source | S | 0..1 | uri | |
| hpii | S | 0..1 | Identifier | HPI-I for Directory Entry Practitioner |
| active | S | 1..1 | boolean | Required status |
| name | (Slice Definition) | Slice: Unordered, Open At End by value:use | ||
| directory-practitioner-name | S | 1..* | HumanName | Usual practitioner name |
| use | 1..1 | code | Fixed Value: usual | |
| family | 1..1 | string | ||
| given | 1..* | string | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | Australian Practitioner Directory Entry | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata on Practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | SΣ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| 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) Max Binding: AllLanguages | |
| 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 |
| identifier | Σ | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system | |
| hpii | SΣI | 0..1 | Identifier | HPI-I for Directory Entry Practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for HPI-I Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-I |
| system | Σ | 1..1 | uri | Namespace for HPI-I Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0 |
| value | Σ | 1..1 | string | HPI-I number Example General': 123456 Example HPI-I number': 8003619900015717 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| medicarePrescriberNumber | Σ | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for prescriber number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Prescriber Number |
| system | Σ | 1..1 | uri | Namespace for prescriber number Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number |
| value | Σ | 1..1 | string | Medicare Prescriber number Example General': 123456 Example prescriber number': 453221 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| careAgencyEmployeeIdentifier | ΣI | 0..* | Identifier | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) |
| 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 | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | Σ | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | Σ | 1..1 | string | CAE identifier number Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| ahpraRegistration | ΣI | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 Fixed Value: AHPRA Registration Number |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | The value that is unique Example General': 123456 Example AHPRA registration number': ANZ1234567890 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | SΣ | 1..1 | boolean | Required status |
| name | Σ | (Slice Definition) | The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use | |
| directory-practitioner-name | SΣ | 1..* | HumanName | Usual practitioner name |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) Fixed Value: usual |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system | |
| (All Slices) | Content/Rules for all slices | |||
| 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 |
| identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example) | |
| period | 0..1 | Period | Period during which the qualification is valid | |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| 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 |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for AHPRA registration number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| 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 Fixed Value: AHPRA Registration Number |
| system | Σ | 1..1 | uri | Namespace for AHPRA registration number Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General': 123456 Example AHPRA registration number': ANZ1234567890 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| code | 1..1 | CodeableConcept | AHPRA codings Binding: v2 table 0360, Version 2.7 (example) | |
| 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 | AHPRA Registration Role |
| period | 0..1 | Period | Period during which the qualification is valid | |
| issuer | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| 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 | ΣI | 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) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource Fixed Value: AHPRA |
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the requirements for search and read operations.
Read: Practitioner
Read identified practitioner resource content.
GET [base]/Practitioner/[id]
Example: GET [base]/Practitioner/1234
Support: MUST support read Practitioner
Implementation Notes: (how to read resource)
Search: Active Status
Search based on active status of the practitioner record.
GET [base]/Practitioner?active=[status]
Example: GET [base]/Practitioner?active=true
Support: MUST support search Practitioner by active status (true | false).
Implementation Notes: (how to search by token)
Search: Practitioner Name
Search based on family, given and/or any name.
GET [base]/Practitioner?family=[string]
GET [base]/Practitioner?family=[string]&given=[string]
GET [base]/Practitioner?name=[string]
Example:
GET [base]/Practitioner?family=Smith
GET [base]/Practitioner?family=Smith&practitioner.given=John
GET [base]/Practitioner?name=Smith
Support: SHOULD support search by family, given and name.
Implementation Notes: (how to search by string)
Search: HPI-I
Search based on identifier token.
GET [base]/Practitioner?identifier=[system]|[value]
Example: GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003610833334085
Support: SHOULD support search by HPI-I.
Implementation Notes: (how to search by token)
© PD 2 on FHIR R4 (IG Publisher v4.0.0-a53ec6ee1b) generated on Thu, Aug 15, 2019 21:28+1000. |
