Australian Base Implementation Guide (AU Base 2)
This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Base Practitioner Profile [FMM Level 3]
This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.
These definitions represent common data held in the Practitioner.identifier element:
These definitions represent common data held in the Practitioner.qualification element:
Where a sending system includes a practitioner’s qualification using their AHPRA Registration Number, this should be done using Practitioner.qualification(ahpraRegistration). A practitioner’s AHPRA Registration Number may also be included as an identifier, using Practitioner.identifier(ahpraRegistration).
Examples
Practitioner with HPI-I, Prescriber Number and AHPRA Registration Number
AHPRA qualified General Practitioner
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-practitioner
This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.
This profile builds on Practitioner.
This profile was published on Fri Jul 26 00:00:00 AEST 2019 as a draft by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | Practitioner | A practitioner in an Australian healthcare context | |
  identifier | 0..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system | |
   identifier:hpii | I | 0..1 | Identifier | 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 |
   type | 0..1 | CodeableConcept | Coded identifier type for HPI-I Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| 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 HPI-I number: 8003619900015717 Max Length: 16 | |
| identifier:medicarePrescriberNumber | 0..* | Identifier | Medicare Prescriber Number | |
| type | 0..1 | CodeableConcept | Coded identifier type for prescriber number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| 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 prescriber number: 453221 | |
| identifier: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 |
| type | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) | |
| 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 CAE identifier: 9003600003999997 | |
 identifier: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 |
 type | 1..1 | CodeableConcept | Description of identifier Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| 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 AHPRA registration number: MED0000932846 | |
| qualification | 0..* | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system | |
| qualification:ahpraRegistration | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details | |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits |
| type | 1..1 | CodeableConcept | Coded identifier type for AHPRA registration number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| 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 AHPRA registration number: MED0000932846 | |
| code | 1..1 | CodeableConcept | AHPRA codings | |
| text | 1..1 | string | AHPRA Registration Role | |
| issuer | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | Practitioner | A practitioner in an Australian healthcare context |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system |
| identifier:hpii | ΣI | 0..1 | Identifier | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-I |
| system | ΣI | 1..1 | uri | Namespace for HPI-I Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0 |
| value | ΣI | 1..1 | string | HPI-I number Example General: 123456 Example HPI-I number: 8003619900015717 Max Length: 16 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:medicarePrescriberNumber | ΣI | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Prescriber Number |
| system | ΣI | 1..1 | uri | Namespace for prescriber number Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number |
| value | ΣI | 1..1 | string | Medicare Prescriber number Example General: 123456 Example prescriber number: 453221 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier: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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | ΣI | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | ΣI | 1..1 | string | CAE identifier number Example General: 123456 Example CAE identifier: 9003600003999997 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier: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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: AHPRA Registration Number |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | ΣI | 1..1 | string | The value that is unique Example General: 123456 Example AHPRA registration number: MED0000932846 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ΣI | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | ΣI | 0..* | HumanName | The name(s) associated with the practitioner |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | ΣI | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ΣI | 0..1 | date | The date on which the practitioner was born |
| photo | I | 0..* | Attachment | Image of the person |
| qualification | I | 0..* | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system |
| qualification:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | I | 0..* | Identifier | An identifier for this qualification for the practitioner |
| code | I | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example) |
| period | I | 0..1 | Period | Period during which the qualification is valid |
| issuer | I | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| qualification:ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: AHPRA Registration Number |
| system | ΣI | 1..1 | uri | Namespace for AHPRA registration number Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | ΣI | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| code | I | 1..1 | CodeableConcept | AHPRA codings Binding: v2 table 0360, Version 2.7 (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | AHPRA Registration Role |
| period | I | 0..1 | Period | Period during which the qualification is valid |
| issuer | I | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 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 | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 1..1 | string | Text alternative for the resource Fixed Value: AHPRA |
| communication | I | 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..* | Practitioner | A practitioner in an Australian healthcare context | |
| identifier | 0..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system | |
| identifier:hpii | I | 0..1 | Identifier | 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 |
| type | 0..1 | CodeableConcept | Coded identifier type for HPI-I Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| 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 HPI-I number: 8003619900015717 Max Length: 16 | |
| identifier:medicarePrescriberNumber | 0..* | Identifier | Medicare Prescriber Number | |
| type | 0..1 | CodeableConcept | Coded identifier type for prescriber number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| 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 prescriber number: 453221 | |
| identifier: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 |
| type | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) | |
| 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 CAE identifier: 9003600003999997 | |
| identifier: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 |
| type | 1..1 | CodeableConcept | Description of identifier Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| 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 AHPRA registration number: MED0000932846 | |
| qualification | 0..* | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system | |
| qualification:ahpraRegistration | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details | |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-1: AHPRA registration value shall be 3 uppercase letters, followed by 10 digits |
| type | 1..1 | CodeableConcept | Coded identifier type for AHPRA registration number Binding: V2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| 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 AHPRA registration number: MED0000932846 | |
| code | 1..1 | CodeableConcept | AHPRA codings | |
| text | 1..1 | string | AHPRA Registration Role | |
| issuer | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | Practitioner | A practitioner in an Australian healthcare context |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:type, value:system |
| identifier:hpii | ΣI | 0..1 | Identifier | 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 |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-I |
| system | ΣI | 1..1 | uri | Namespace for HPI-I Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0 |
| value | ΣI | 1..1 | string | HPI-I number Example General: 123456 Example HPI-I number: 8003619900015717 Max Length: 16 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:medicarePrescriberNumber | ΣI | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Prescriber Number |
| system | ΣI | 1..1 | uri | Namespace for prescriber number Fixed Value: http://ns.electronichealth.net.au/id/medicare-prescriber-number |
| value | ΣI | 1..1 | string | Medicare Prescriber number Example General: 123456 Example prescriber number: 453221 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier: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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | ΣI | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | ΣI | 1..1 | string | CAE identifier number Example General: 123456 Example CAE identifier: 9003600003999997 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier: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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: AHPRA Registration Number |
| system | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | ΣI | 1..1 | string | The value that is unique Example General: 123456 Example AHPRA registration number: MED0000932846 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ΣI | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | ΣI | 0..* | HumanName | The name(s) associated with the practitioner |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | ΣI | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | ΣI | 0..1 | date | The date on which the practitioner was born |
| photo | I | 0..* | Attachment | Image of the person |
| qualification | I | 0..* | (Slice Definition) | Certification, licenses, or training pertaining to the provision of care Slice: Unordered, Open by value:identifier.system |
| qualification:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | I | 0..* | Identifier | An identifier for this qualification for the practitioner |
| code | I | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example) |
| period | I | 0..1 | Period | Period during which the qualification is valid |
| issuer | I | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| qualification:ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | Plain text representation of the concept Fixed Value: AHPRA Registration Number |
| system | ΣI | 1..1 | uri | Namespace for AHPRA registration number Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | ΣI | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| code | I | 1..1 | CodeableConcept | AHPRA codings Binding: v2 table 0360, Version 2.7 (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 1..1 | string | AHPRA Registration Role |
| period | I | 0..1 | Period | Period during which the qualification is valid |
| issuer | I | 1..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 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 | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 1..1 | string | Text alternative for the resource Fixed Value: AHPRA |
| communication | I | 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 required search and read operations.
Summary of Search Criteria for StructureDefinition-au-practitioner
none defined
© AU Base 2 on FHIR R4 (IG Publisher v4.0.1-a53ec6ee1b) generated on Thu, Jul 30, 2020 13:57+1000. |
