AU Core Implementation Guide
0.1.0-draft - Draft
AU Core Implementation Guide
0.1.0-draft - Draft
This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner | Version: 0.1.0-draft | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCorePractitioner | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the AU Base Practitioner profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Practitioner when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |
  Slices for identifier | S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type |
   identifier:hpii | S | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) |
  active | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | |
| name | SC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present |
| 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 | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
| identifier | S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation |
| code | S | 1..1 | CodeableConcept | Coded representation of the qualification |
| 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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |
 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) |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true |
 name | SΣC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present |
| 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 | Certification, licenses, or training pertaining to the provision of care |
| ahpraProfession-details | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |
| ahpraRegistration-details | 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 | S | 1..1 | CodeableConcept | Coded representation of the qualification 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtended |
| Practitioner.communication | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |||||
| 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 | |||||
 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) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||
| name | SΣC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present | ||||
| 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 | Certification, licenses, or training pertaining to the provision of care | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ahpraProfession-details | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |||||
| ahpraRegistration-details | 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 | S | 1..1 | CodeableConcept | Coded representation of the qualification 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtended | ||||
| Practitioner.communication | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
This structure is derived from AUBasePractitioner
Differential View
This structure is derived from AUBasePractitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |
| Slices for identifier | S | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber | An identifier intended for computation Slice: Unordered, Open by pattern:type |
| identifier:hpii | S | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I) |
| active | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | |
| name | SC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present |
| 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 | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
| identifier | S | 0..* | Identifier, AUAhpraRegistrationNumber | An identifier intended for computation |
| code | S | 1..1 | CodeableConcept | Coded representation of the qualification |
| 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 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |
| 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) |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true |
| name | SΣC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present |
| 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 | Certification, licenses, or training pertaining to the provision of care |
| ahpraProfession-details | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |
| ahpraRegistration-details | 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 | S | 1..1 | CodeableConcept | Coded representation of the qualification 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtended |
| Practitioner.communication | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | AUBasePractitioner | A person with a formal responsibility in the provisioning of services | |||||
| 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 | |||||
| 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) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use Fixed Value: true | ||||
| name | SΣC | 1..* | HumanName | The name(s) associated with the practitioner au-core-prac-01: At least text or family name shall be present | ||||
| 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 | Certification, licenses, or training pertaining to the provision of care | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ahpraProfession-details | 0..1 | (Complex) | Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |||||
| ahpraRegistration-details | 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 | S | 1..1 | CodeableConcept | Coded representation of the qualification 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: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtended | ||||
| Practitioner.communication | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-prac-01 | error | Practitioner.name | At least text or family name shall be present : text.exists() or family.exists() |
This structure is derived from AUBasePractitioner
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
| Name | Type | Conformance | Description | Path |
|---|---|---|---|---|
| TBD | TBD | TBD | TBD | TBD |
The following search parameters and search parameter combinations SHALL be supported:
The following search parameters and search parameter combinations SHOULD be supported:
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.1.0-draft based on FHIR 4.0.1. Generated 2023-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change