Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
Magentus Practice Management FHIR® Implementation Guide
1.3.2 - Release
Australia
This page is part of the Magentus Practice Management FHIR Implementation Guide (v1.3.2: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-practitioner | Version: 1.3.2 | ||||
| Active as of 2026-10-02 | Computable Name: GSPractitioner | ||||
A clinician taking part in a Magentus workflow. Derived from AU eRequesting Practitioner. Adds an AHPRA registration number and a Magentus-local practitioner identifier, and requires an official name with at least one given name.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
  Practitioner |
||||||
  Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
   identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
 identifier:ahpra |
|
|
|
| ||
 Slices for name |
|
|
|
| ||
  name:All Slices |
||||||
  family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
 family |
|
|
|
| ||
 given |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:official.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-pra-0 | warning | Practitioner | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
|
| inv-pra-1 | warning | Practitioner | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
|
| inv-pra-2 | warning | Practitioner | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
|
| inv-pra-3 | warning | Practitioner | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
|
| inv-pra-4 | warning | Practitioner | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
|
| inv-pra-5 | warning | Practitioner | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
|
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
| Practitioner |
AUeRequestingPractitioner | |||
| id |
S | 0..1 | id | Logical id of this artifact |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:localPractitionerIdentifier |
0..1 | GSPractitionerLocalIdentifier | An identifier for the person as this agent | |
| identifier:ahpra |
0..1 | AUAhpraRegistrationNumber | An identifier for the person as this agent | |
| active |
S | 1..1 | boolean | Whether this practitioner's record is in active use |
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use | |
| name:official |
S | 1..1 | HumanName | Provider's official name |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
| given |
1..* | string | Given names (not always 'first'). Includes middle names | |
| prefix |
0..1 | string | Title | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||||||||||||||
| id |
SΣ | 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: CommonLanguages (preferred): A human language.
| |||||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity | ||||||||||||||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns | |||||||||||||||||||||||||
| extension:recordedSexOrGender |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||
| Slices for identifier |
SOΣ | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier for the person as this agent Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:hpii |
SOΣ | 0..1 | AUHPII | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:localPractitionerIdentifier |
SOΣ | 0..1 | GSPractitionerLocalIdentifier | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:ahpra |
SOΣ | 0..1 | AUAhpraRegistrationNumber | An identifier for the person as this agent
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use | ||||||||||||||||||||||||
| Slices for name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use
| ||||||||||||||||||||||||
| name: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 Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||||||||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 0..* | 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 | ||||||||||||||||||||||||
| name:official |
SOΣ | 1..1 | HumanName | Provider's official 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): The use of a human name. Fixed Value: official | ||||||||||||||||||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 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..1 | string | Title 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, AustralianAddress | Address(es) of the practitioner that are not role specific (typically home address) | ||||||||||||||||||||||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||||||||||||||||||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||||||||||||||||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||||||||||||||||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||||||||||||||||||||||
| 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: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |||||||||||||||||||||||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||||||||||||||||||||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||||||||||||||||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia  (extensible) | |||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| Practitioner |
||||||
| Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
| identifier:ahpra |
|
|
|
| ||
| Slices for name |
|
|
|
| ||
| name:All Slices |
||||||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:official.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📦6.0.0 | AU Base Implementation Guide v6.0 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-pra-0 | warning | Practitioner | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
|
| inv-pra-1 | warning | Practitioner | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
|
| inv-pra-2 | warning | Practitioner | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
|
| inv-pra-3 | warning | Practitioner | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
|
| inv-pra-4 | warning | Practitioner | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
|
| inv-pra-5 | warning | Practitioner | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
|
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| Practitioner |
||||||
| Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
| identifier:ahpra |
|
|
|
| ||
| Slices for name |
|
|
|
| ||
| name:All Slices |
||||||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| Documentation for this format | ||||||
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||||||||||||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity | ||||||||||||||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns | |||||||||||||||||||||||||
| extension:recordedSexOrGender |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||
| Slices for identifier |
SOΣ | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier for the person as this agent Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:hpii |
SOΣ | 0..1 | AUHPII | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:localPractitionerIdentifier |
SOΣ | 0..1 | GSPractitionerLocalIdentifier | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:ahpra |
SOΣ | 0..1 | AUAhpraRegistrationNumber | An identifier for the person as this agent
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use | ||||||||||||||||||||||||
| Slices for name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use
| ||||||||||||||||||||||||
| name:All Slices |
Content/Rules for all slices | |||||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
| ||||||||||||||||||||||||
| name:official |
SOΣ | 1..1 | HumanName | Provider's official name
| ||||||||||||||||||||||||
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 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..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| Practitioner |
||||||
| Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
| identifier:ahpra |
|
|
|
| ||
| Slices for name |
|
|
|
| ||
| name:All Slices |
||||||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:official.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-pra-0 | warning | Practitioner | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
|
| inv-pra-1 | warning | Practitioner | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
|
| inv-pra-2 | warning | Practitioner | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
|
| inv-pra-3 | warning | Practitioner | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
|
| inv-pra-4 | warning | Practitioner | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
|
| inv-pra-5 | warning | Practitioner | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
AUeRequestingPractitioner | |||
| id |
S | 0..1 | id | Logical id of this artifact |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:localPractitionerIdentifier |
0..1 | GSPractitionerLocalIdentifier | An identifier for the person as this agent | |
| identifier:ahpra |
0..1 | AUAhpraRegistrationNumber | An identifier for the person as this agent | |
| active |
S | 1..1 | boolean | Whether this practitioner's record is in active use |
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use | |
| name:official |
S | 1..1 | HumanName | Provider's official name |
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
| given |
1..* | string | Given names (not always 'first'). Includes middle names | |
| prefix |
0..1 | string | Title | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUeRequestingPractitioner | A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||||||||||||||
| id |
SΣ | 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: CommonLanguages (preferred): A human language.
| |||||||||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity | ||||||||||||||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns | |||||||||||||||||||||||||
| extension:recordedSexOrGender |
C | 0..* | (Complex) | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | ||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||||||||
| Slices for identifier |
SOΣ | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier for the person as this agent Slice: Unordered, Open by pattern:type
| ||||||||||||||||||||||||
| identifier:hpii |
SOΣ | 0..1 | AUHPII | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:localPractitionerIdentifier |
SOΣ | 0..1 | GSPractitionerLocalIdentifier | An identifier for the person as this agent
| ||||||||||||||||||||||||
| identifier:ahpra |
SOΣ | 0..1 | AUAhpraRegistrationNumber | An identifier for the person as this agent
| ||||||||||||||||||||||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use | ||||||||||||||||||||||||
| Slices for name |
SOΣ | 1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Closed by value:use
| ||||||||||||||||||||||||
| name: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 Slice: Unordered, Open by value:url | |||||||||||||||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||||||||||||||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 0..* | 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 | ||||||||||||||||||||||||
| name:official |
SOΣ | 1..1 | HumanName | Provider's official 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): The use of a human name. Fixed Value: official | ||||||||||||||||||||||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||||||||||||||||||||||
| family |
SOΣ | 1..1 | string | Family name (often called 'Surname')
| ||||||||||||||||||||||||
| given |
SOΣ | 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..1 | string | Title 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, AustralianAddress | Address(es) of the practitioner that are not role specific (typically home address) | ||||||||||||||||||||||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||||||||||||||||||||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||||||||||||||||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||||||||||||||||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||||||||||||||||||||||
| 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: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |||||||||||||||||||||||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||||||||||||||||||||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||||||||||||||||||
| communication |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (extensible) | |||||||||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||||||||
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| Practitioner |
||||||
| Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
| identifier:ahpra |
|
|
|
| ||
| Slices for name |
|
|
|
| ||
| name:All Slices |
||||||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| Documentation for this format | ||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:official.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📦6.0.0 | AU Base Implementation Guide v6.0 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-pra-0 | warning | Practitioner | Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
|
| inv-pra-1 | warning | Practitioner | Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').extension('value').value.all(memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
|
| inv-pra-2 | warning | Practitioner | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
|
| inv-pra-3 | warning | Practitioner | Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))
|
| inv-pra-4 | warning | Practitioner | Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
|
| inv-pra-5 | warning | Practitioner | Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply |
extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))
|
| Name | AU Core Responder | AU eRequesting Server | AU Core Requester | AU eRequesting Patient | AU eRequesting Filler | AU eRequesting Placer |
|---|---|---|---|---|---|---|
| Practitioner |
||||||
| Slices for extension |
||||||
| Slices for identifier |
|
|
|
| ||
| identifier:hpii |
|
|
|
| ||
| identifier:localPractitionerIdentifier |
|
|
|
| ||
| identifier:ahpra |
|
|
|
| ||
| Slices for name |
|
|
|
| ||
| name:All Slices |
||||||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| name:official |
|
|
|
| ||
| family |
|
|
|
| ||
| given |
|
|
|
| ||
| Documentation for this format | ||||||
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron