Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-practitioner

AU Base Practitioner Profile [FMM Level 3]

This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions, defined as profiles of Identifier, represent common data held in the Practitioner.identifier element:

Qualifications

These definitions represent common data held in the Practitioner.qualification element:

  • Australian Health Practitioner Regulation Agency (AHPRA) Registration Number [1] [2]

Extensions

No extensions are used in this profile.

Usage Notes

Where a sending system includes a practitioner’s qualification using their AHPRA Registration Number, this should be done using Practitioner.qualification(ahpraRegistration). A practitioner’s AHPRA Registration Number may also be included as an identifier, using Practitioner.identifier(ahpraRegistration).

Examples

Practitioner with HPI-I, Prescriber Number and AHPRA Registration Number

Qualified Radiologist

Qualified Pathologist

AHPRA qualified General Practitioner

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-practitioner

This profile defines a practitioner administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Practitioner.

This profile was published on Fri Jul 26 00:00:00 UTC 2019 as a draft by Health Level Seven Australia (Patient Administration WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA practitioner in an Australian healthcare context
... identifier 0..*Identifier, AUHPIINumber, AUMedicarePrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier for the person as this agent
... address 0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification 0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:ahpraRegistration 0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... identifier 1..1AUAHPRARegistrationNumberAHPRA Registration Number
..... code 1..1CodeableConceptAHPRA codings
...... text 1..1stringAHPRA Registration Role
..... issuer 1..1Reference(Organization)Organization that regulates and issues the qualification
...... display 1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA practitioner in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*Identifier, AUHPIINumber, AUMedicarePrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier for the person as this agent
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address I0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:ahpraRegistration I0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I1..1AUAHPRARegistrationNumberAHPRA Registration Number
..... code I1..1CodeableConceptAHPRA codings
Binding: v2 table 0360, Version 2.7 (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringAHPRA Registration Role
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I1..1Reference(Organization)Organization that regulates and issues the qualification
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA practitioner in an Australian healthcare context
... identifier 0..*Identifier, AUHPIINumber, AUMedicarePrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier for the person as this agent
... address 0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification 0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:ahpraRegistration 0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... identifier 1..1AUAHPRARegistrationNumberAHPRA Registration Number
..... code 1..1CodeableConceptAHPRA codings
...... text 1..1stringAHPRA Registration Role
..... issuer 1..1Reference(Organization)Organization that regulates and issues the qualification
...... display 1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA practitioner in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*Identifier, AUHPIINumber, AUMedicarePrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier for the person as this agent
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name ΣI0..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address I0..*Address, AUBaseAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*(Slice Definition)Certification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:identifier.system
.... qualification:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
..... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:ahpraRegistration I0..*BackboneElementAustralian Health Practitioner Regulation Agency (AHPRA) qualification details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... identifier I1..1AUAHPRARegistrationNumberAHPRA Registration Number
..... code I1..1CodeableConceptAHPRA codings
Binding: v2 table 0360, Version 2.7 (example)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI1..1stringAHPRA Registration Role
..... period I0..1PeriodPeriod during which the qualification is valid
..... issuer I1..1Reference(Organization)Organization that regulates and issues the qualification
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
...... display ΣI1..1stringText alternative for the resource
Fixed Value: AHPRA
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-practitioner

none defined