Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. 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:
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 Sat Mar 11 17:30:54 AEDT 2017 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) | Slice: Unordered, Open by pattern:type, value:system | |
   identifier:hpii | I | 0..1 | Identifier | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-value-0: HPI-I shall be an exactly 16 digit number inv-hpii-value-1: HPI-I prefix is 800361 inv-hpii-value-2: The identifier 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://hl7.org/fhir/v2/0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| text | 0..1 | string | 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| text | 0..1 | string | 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-value-0: CAE identifier shall be an exactly 16 digit number inv-caei-value-1: CAE identifier shall contain a prefix of 900360 inv-caei-value-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 | 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 | |
 identifier:ahpraRegistration | I | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-value-id-0: The AHPRA identifier value shall start with 3 uppercase letters, followed by 10 digits. |
 type | 1..1 | CodeableConcept | 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| text | 1..1 | string | Fixed Value: AHPRA Registration Number | |
| system | 1..1 | uri | Fixed Value: http://hl7.org.au/id/ahpra-registration-number | |
| value | 1..1 | string | Example AHPRA registration number: ANZ1234567890 | |
| qualification | 0..* | (Slice Definition) | 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-qual-value-0: The AHPRA registration value shall start with 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| text | 1..1 | string | 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: ANZ1234567890 | |
| code | 1..1 | CodeableConcept | AHPRA codings | |
| text | 1..1 | string | AHPRA Registration Role | |
| issuer | 1..1 | Reference(Organization) | ||
| display | 1..1 | string | Fixed Value: AHPRA | |
| communication | 0..* | CodeableConcept | 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 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 | Σ | 0..* | (Slice Definition) | A 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-value-0: HPI-I shall be an exactly 16 digit number inv-hpii-value-1: HPI-I prefix is 800361 inv-hpii-value-2: The identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:medicarePrescriberNumber | Σ | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:careAgencyEmployeeIdentifier | ΣI | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-value-0: CAE identifier shall be an exactly 16 digit number inv-caei-value-1: CAE identifier shall contain a prefix of 900360 inv-caei-value-2: CAE identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:ahpraRegistration | ΣI | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-value-id-0: The AHPRA identifier value shall start with 3 uppercase letters, followed by 10 digits. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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 | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | Σ | 0..* | HumanName | The name(s) associated with the practitioner |
| 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 | 0..* | (Slice Definition) | Qualifications obtained by training and certification Slice: Unordered, Open by value:identifier.system |
| qualification:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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 | |
| qualification:ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-qual-value-0: The AHPRA registration value shall start with 3 uppercase letters, followed by 10 digits. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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 |
| 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 is able to 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) | Slice: Unordered, Open by pattern:type, value:system | |
| identifier:hpii | I | 0..1 | Identifier | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-value-0: HPI-I shall be an exactly 16 digit number inv-hpii-value-1: HPI-I prefix is 800361 inv-hpii-value-2: The identifier 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://hl7.org/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI | |
| text | 0..1 | string | 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRES | |
| text | 0..1 | string | 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-value-0: CAE identifier shall be an exactly 16 digit number inv-caei-value-1: CAE identifier shall contain a prefix of 900360 inv-caei-value-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 | 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 | |
| identifier:ahpraRegistration | I | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-value-id-0: The AHPRA identifier value shall start with 3 uppercase letters, followed by 10 digits. |
| type | 1..1 | CodeableConcept | 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| text | 1..1 | string | Fixed Value: AHPRA Registration Number | |
| system | 1..1 | uri | Fixed Value: http://hl7.org.au/id/ahpra-registration-number | |
| value | 1..1 | string | Example AHPRA registration number: ANZ1234567890 | |
| qualification | 0..* | (Slice Definition) | 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-qual-value-0: The AHPRA registration value shall start with 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://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AHPRA | |
| text | 1..1 | string | 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: ANZ1234567890 | |
| code | 1..1 | CodeableConcept | AHPRA codings | |
| text | 1..1 | string | AHPRA Registration Role | |
| issuer | 1..1 | Reference(Organization) | ||
| display | 1..1 | string | Fixed Value: AHPRA | |
| communication | 0..* | CodeableConcept | 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 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 | Σ | 0..* | (Slice Definition) | A 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-value-0: HPI-I shall be an exactly 16 digit number inv-hpii-value-1: HPI-I prefix is 800361 inv-hpii-value-2: The identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:medicarePrescriberNumber | Σ | 0..* | Identifier | Medicare Prescriber Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:careAgencyEmployeeIdentifier | ΣI | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-value-0: CAE identifier shall be an exactly 16 digit number inv-caei-value-1: CAE identifier shall contain a prefix of 900360 inv-caei-value-2: CAE identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| 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) |
| identifier:ahpraRegistration | ΣI | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier inv-ahpra-value-id-0: The AHPRA identifier value shall start with 3 uppercase letters, followed by 10 digits. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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 | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | Σ | 0..* | HumanName | The name(s) associated with the practitioner |
| 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 | 0..* | (Slice Definition) | Qualifications obtained by training and certification Slice: Unordered, Open by value:identifier.system |
| qualification:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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 | |
| qualification:ahpraRegistration | I | 0..* | BackboneElement | Australian Health Practitioner Regulation Agency (AHPRA) qualification details |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 1..1 | Identifier | AHPRA Registration Number inv-ahpra-qual-value-0: The AHPRA registration value shall start with 3 uppercase letters, followed by 10 digits. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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 | xml:id (or equivalent in JSON) | |
| 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 |
| 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 is able to 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 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
