Australian Digital Health Agency FHIR
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitioner-core-1 | Version: 1.0.3 | |||
Active as of 2024-09-16 | Computable Name: ADHAPractitionerCore | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to define a core representation of a practitioner for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Practitioner that are supported.
A Practitioner resource is used within the context of a referencing resource (most commonly a PractitionerRole resource).
This profile is designed to set a core Practitioner standard for:
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCorePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services | |
active | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | |
qualification | SC | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display |
issuer | SC | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Practitioner | C | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pra-4: 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 inv-pra-5: 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 inv-pra-6: 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 | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
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 | ||||||
individualPronouns | C | 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 | ||||||
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 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 intended for computation Slice: Unordered, Open by pattern:type
| ||||||
identifier:hpii | SOC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
| ||||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||||
name | SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||
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
| ||||||
address | C | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||||
qualification | SC | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
ahpraProfession-details | C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||||
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 | ||||||
code | C | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | ||||||
issuer | SC | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Practitioner | C | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pra-4: 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 inv-pra-5: 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 inv-pra-6: 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 | ||||||
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: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
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 | ||||||
individualPronouns | C | 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 | ||||||
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 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 intended for computation Slice: Unordered, Open by pattern:type
| ||||||
identifier:hpii | SOC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
| ||||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||||
name | SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | 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 | ||||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||||
address | C | 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 | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
ahpraProfession-details | C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||||
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 | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation | |||||||
code | C | 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 | SC | 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 |
Path | Conformance | ValueSet | URI | |||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended | ||||
Practitioner.communication | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUCorePractitioner
Differential View
This structure is derived from AUCorePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services | |
active | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | |
qualification | SC | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display |
issuer | SC | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Practitioner | C | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pra-4: 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 inv-pra-5: 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 inv-pra-6: 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 | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
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 | ||||||
individualPronouns | C | 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 | ||||||
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 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 intended for computation Slice: Unordered, Open by pattern:type
| ||||||
identifier:hpii | SOC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
| ||||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||||
name | SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||
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
| ||||||
address | C | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||||
qualification | SC | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
ahpraProfession-details | C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||||
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 | ||||||
code | C | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | ||||||
issuer | SC | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Practitioner | C | 0..* | AUCorePractitioner | A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply inv-pra-4: 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 inv-pra-5: 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 inv-pra-6: 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 | ||||||
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: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
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 | ||||||
individualPronouns | C | 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 | ||||||
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 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 intended for computation Slice: Unordered, Open by pattern:type
| ||||||
identifier:hpii | SOC | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) inv-hpii-0: HPI-I shall be 16 digits inv-hpii-1: HPI-I prefix shall be 800361 inv-hpii-2: HPI-I shall pass the Luhn algorithm check
| ||||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||||
name | SOΣ | 1..* | HumanName | The name(s) associated with the practitioner
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
use | ?!Σ | 0..1 | code | usual | official | temp | 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 | ||||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||||
address | C | 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 | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
ahpraProfession-details | C | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | ||||||
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 | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation | |||||||
code | C | 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 | SC | 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 |
Path | Conformance | ValueSet | URI | |||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended | ||||
Practitioner.communication | extensible | CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-prac-01 | error | Practitioner.qualification | If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display : issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUCorePractitioner
Other representations of profile: CSV, Excel, Schematron