Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Core Practitioner [Active]

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. The concept of a practitioner in this implementation guide is always within the context of a practitioner role - as the practitioner that performs the role(s). In the context of an exchange of health information a practitioner is part of the context established for a set of healthcare-related information.

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:

  • Querying practitioners referenced in PractitionerRole or other resources
  • Recording or updating a practitioner referenced by a PractitionerRole or other resource

Profile specific guidance

None.

Boundaries and relationships

This profile is referenced by ADHA Authoring PractitionerRole and ADHA Core PractitionerRole.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitioner-core-1

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 builds on AUBasePractitioner.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active 0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SC1..*HumanNameThe name(s) associated with the practitioner
inv-dh-prac-01: At least text or family name shall be present
... telecom S0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
inv-dh-prac-02: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display
.... identifier S0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer SC0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active Σ0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
inv-dh-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
inv-dh-prac-02: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer SC0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*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..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active 0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SC1..*HumanNameThe name(s) associated with the practitioner
inv-dh-prac-01: At least text or family name shall be present
... telecom S0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
inv-dh-prac-02: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display
.... identifier S0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer SC0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active Σ0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
inv-dh-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
inv-dh-prac-02: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer SC0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*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

 

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
Practitioner.communicationextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Search Parameters

None defined.