Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build
Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build
Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-copyto-practitioner | Version: 1.2.60 | |||
| Active as of 2026-04-05 | Computable Name: EOrdersCopyToPractitioner | |||
A profile for representing practitioner details in the context of a 'copy-to' recipient for diagnostic results. This profile supports the fields captured by Australian clinical systems including Genie and Gentu for address book entries.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type |
   identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2 |
| identifier:localPractitionerIdentifier |
S | 0..1 | GSPractitionerLocalIdentifier | An identifier intended for computation |
 identifier:ahpra |
S | 0..1 | AUAhpraRegistrationNumber | An identifier intended for computation |
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use |
| Slices for name |
SΣC | 1..* | HumanName | Practitioner name including title Slice: Unordered, Closed by value:use Constraints: au-core-prac-01 |
 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 |
SΣ | 1..1 | string | Surname/Last name |
| given |
SΣ | 0..* | string | First name and/or initial This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix |
SΣ | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) This repeating element order: Prefixes appear in the correct order for presenting the name |
| name:official |
SΣC | 1..1 | HumanName | Provider's official name Constraints: au-core-prac-01 |
  use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 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 |
SΣ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name |
 telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address |
S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| qualification |
SC | 0..* | BackboneElement | Practitioner qualifications and specialty Constraints: inv-pra-0, inv-pra-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ahpraProfession-details |
C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details |
| extension:ahpraRegistration-details |
C | 0..1 | (Complex) | Ahpra Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation |
| code |
SC | 1..1 | CodeableConcept | Specialty or category of clinician Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) |
| period |
S | 0..1 | Period | Period during which the qualification is valid |
  issuer |
S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| communication |
S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia  (extensible) |
| 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. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prac-01 | error | Practitioner.name, Practitioner.name:official | At least text or family name shall be present |
text.exists() or family.exists()
|
| 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-hpii-0 | error | Practitioner.identifier:hpii | HPI-I shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpii-1 | error | Practitioner.identifier:hpii | HPI-I prefix shall be 800361 |
value.startsWith('800361')
|
| inv-hpii-2 | error | Practitioner.identifier:hpii | HPI-I shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
| inv-pra-0 | error | Practitioner.qualification | A qualification shall only have Ahpra Profession details if the code is Ahpra Profession |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
|
| inv-pra-1 | error | Practitioner.qualification | A qualification shall only have Ahpra Registration details if the code is Ahpra Registration |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
|
This structure is derived from GSPractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |
| name |
1..* | HumanName | Practitioner name including title | |
| family |
S | 1..1 | string | Surname/Last name |
| given |
S | 0..* | string | First name and/or initial |
| prefix |
S | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) |
| Slices for name |
Content/Rules for all slices | |||
| name:official |
1..1 | HumanName | Provider's official name | |
| family |
S | 1..1 | string | Family name (often called 'Surname') |
| given |
S | 1..* | string | Given names (not always 'first'). Includes middle names |
| prefix |
S | 0..1 | string | Title |
| qualification |
0..* | BackboneElement | Practitioner qualifications and specialty | |
| code |
1..1 | CodeableConcept | Specialty or category of clinician | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type | ||||
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2 | ||||
| identifier:localPractitionerIdentifier |
S | 0..1 | GSPractitionerLocalIdentifier | An identifier intended for computation | ||||
| identifier:ahpra |
S | 0..1 | AUAhpraRegistrationNumber | An identifier intended for computation | ||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use | ||||
| Slices for name |
SΣC | 1..* | HumanName | Practitioner name including title Slice: Unordered, Closed by value:use Constraints: au-core-prac-01 | ||||
| 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 |
SΣ | 1..1 | string | Surname/Last name | ||||
| given |
SΣ | 0..* | string | First name and/or initial This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
SΣ | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) 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 |
SΣC | 1..1 | HumanName | Provider's official name Constraints: au-core-prac-01 | ||||
| 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 |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
SΣ | 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 |
SΣ | 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 |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address |
S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| 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 |
SC | 0..* | BackboneElement | Practitioner qualifications and specialty Constraints: inv-pra-0, inv-pra-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahpraProfession-details |
C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||
| extension:ahpraRegistration-details |
C | 0..1 | (Complex) | Ahpra Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation | ||||
| code |
SC | 1..1 | CodeableConcept | Specialty or category of clinician Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | ||||
| period |
S | 0..1 | Period | Period during which the qualification is valid | ||||
| issuer |
S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||
| communication |
S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (extensible) | ||||
| 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 | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prac-01 | error | Practitioner.name, Practitioner.name:official | At least text or family name shall be present |
text.exists() or family.exists()
|
| 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-hpii-0 | error | Practitioner.identifier:hpii | HPI-I shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpii-1 | error | Practitioner.identifier:hpii | HPI-I prefix shall be 800361 |
value.startsWith('800361')
|
| inv-hpii-2 | error | Practitioner.identifier:hpii | HPI-I shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
| inv-pra-0 | error | Practitioner.qualification | A qualification shall only have Ahpra Profession details if the code is Ahpra Profession |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
|
| inv-pra-1 | error | Practitioner.qualification | A qualification shall only have Ahpra Registration details if the code is Ahpra Registration |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
|
This structure is derived from GSPractitioner
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type |
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2 |
| identifier:localPractitionerIdentifier |
S | 0..1 | GSPractitionerLocalIdentifier | An identifier intended for computation |
| identifier:ahpra |
S | 0..1 | AUAhpraRegistrationNumber | An identifier intended for computation |
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use |
| Slices for name |
SΣC | 1..* | HumanName | Practitioner name including title Slice: Unordered, Closed by value:use Constraints: au-core-prac-01 |
| 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 |
SΣ | 1..1 | string | Surname/Last name |
| given |
SΣ | 0..* | string | First name and/or initial This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix |
SΣ | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) This repeating element order: Prefixes appear in the correct order for presenting the name |
| name:official |
SΣC | 1..1 | HumanName | Provider's official name Constraints: au-core-prac-01 |
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
| family |
SΣ | 1..1 | string | Family name (often called 'Surname') |
| given |
SΣ | 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 |
SΣ | 0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name |
| telecom |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address |
S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
| qualification |
SC | 0..* | BackboneElement | Practitioner qualifications and specialty Constraints: inv-pra-0, inv-pra-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ahpraProfession-details |
C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details |
| extension:ahpraRegistration-details |
C | 0..1 | (Complex) | Ahpra Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier |
S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation |
| code |
SC | 1..1 | CodeableConcept | Specialty or category of clinician Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) |
| period |
S | 0..1 | Period | Period during which the qualification is valid |
| issuer |
S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| communication |
S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (extensible) |
| 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. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prac-01 | error | Practitioner.name, Practitioner.name:official | At least text or family name shall be present |
text.exists() or family.exists()
|
| 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-hpii-0 | error | Practitioner.identifier:hpii | HPI-I shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpii-1 | error | Practitioner.identifier:hpii | HPI-I prefix shall be 800361 |
value.startsWith('800361')
|
| inv-hpii-2 | error | Practitioner.identifier:hpii | HPI-I shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
| inv-pra-0 | error | Practitioner.qualification | A qualification shall only have Ahpra Profession details if the code is Ahpra Profession |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
|
| inv-pra-1 | error | Practitioner.qualification | A qualification shall only have Ahpra Registration details if the code is Ahpra Registration |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
|
Differential View
This structure is derived from GSPractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |
| name |
1..* | HumanName | Practitioner name including title | |
| family |
S | 1..1 | string | Surname/Last name |
| given |
S | 0..* | string | First name and/or initial |
| prefix |
S | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) |
| Slices for name |
Content/Rules for all slices | |||
| name:official |
1..1 | HumanName | Provider's official name | |
| family |
S | 1..1 | string | Family name (often called 'Surname') |
| given |
S | 1..* | string | Given names (not always 'first'). Includes middle names |
| prefix |
S | 0..1 | string | Title |
| qualification |
0..* | BackboneElement | Practitioner qualifications and specialty | |
| code |
1..1 | CodeableConcept | Specialty or category of clinician | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | GSPractitioner | A person with a formal responsibility in the provisioning of services | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type | ||||
| identifier:hpii |
SC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2 | ||||
| identifier:localPractitionerIdentifier |
S | 0..1 | GSPractitionerLocalIdentifier | An identifier intended for computation | ||||
| identifier:ahpra |
S | 0..1 | AUAhpraRegistrationNumber | An identifier intended for computation | ||||
| active |
SΣ | 1..1 | boolean | Whether this practitioner's record is in active use | ||||
| Slices for name |
SΣC | 1..* | HumanName | Practitioner name including title Slice: Unordered, Closed by value:use Constraints: au-core-prac-01 | ||||
| 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 |
SΣ | 1..1 | string | Surname/Last name | ||||
| given |
SΣ | 0..* | string | First name and/or initial This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix |
SΣ | 0..* | string | Title (e.g., Dr, Prof, Mr, Ms) 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 |
SΣC | 1..1 | HumanName | Provider's official name Constraints: au-core-prac-01 | ||||
| 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 |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given |
SΣ | 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 |
SΣ | 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 |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address |
S | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
| 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 |
SC | 0..* | BackboneElement | Practitioner qualifications and specialty Constraints: inv-pra-0, inv-pra-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahpraProfession-details |
C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||
| extension:ahpraRegistration-details |
C | 0..1 | (Complex) | Ahpra Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation | ||||
| code |
SC | 1..1 | CodeableConcept | Specialty or category of clinician Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | ||||
| period |
S | 0..1 | Period | Period during which the qualification is valid | ||||
| issuer |
S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||
| communication |
S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: Common Languages in Australia (extensible) | ||||
| 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 | 📦4.1.2-preview | AU Base Implementation Guide v4.1 |
| Practitioner.communication | Base | extensible |
Common Languages in Australia
|
⏿2.2.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-prac-01 | error | Practitioner.name, Practitioner.name:official | At least text or family name shall be present |
text.exists() or family.exists()
|
| 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-hpii-0 | error | Practitioner.identifier:hpii | HPI-I shall be 16 digits |
value.matches('^([0-9]{16})$')
|
| inv-hpii-1 | error | Practitioner.identifier:hpii | HPI-I prefix shall be 800361 |
value.startsWith('800361')
|
| inv-hpii-2 | error | Practitioner.identifier:hpii | HPI-I shall pass the Luhn algorithm check |
(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
|
| inv-pra-0 | error | Practitioner.qualification | A qualification shall only have Ahpra Profession details if the code is Ahpra Profession |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
|
| inv-pra-1 | error | Practitioner.qualification | A qualification shall only have Ahpra Registration details if the code is Ahpra Registration |
extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
|
This structure is derived from GSPractitioner
Other representations of profile: CSV, Excel, Schematron