AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. 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

Resource Profile: AU Base Practitioner

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-practitioner Version: 5.0.1-ci-build
Standards status: Trial-use Maturity Level: 3 Computable Name: AUBasePractitioner

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a practitioner structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • See each Identifier profile page for guidance related to that identifier type.
  • This profile supports the sex, gender, and related concepts of: Name to Use, Gender Identity, Individual Pronouns, Recorded Sex or Gender, Sex Assigned at Birth:
  • See Australian Health Practitioner Regulation Agency (Ahpra) Data Guidance for detailed guidance on representing Ahpra-sourced data.
  • A tertiary qualification or professional membership (non-Ahpra-sourced data) is represented by Practitioner.qualification
    • If none of the codes from the preferred value set are suitable then at least text should be sent in Practitioner.qualification.code

Potentially useful extensions:

Usage:

Changes since version 5.0.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed
  • Formal Views of Profile Content

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

    This structure is derived from Practitioner

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner C 0..* Practitioner A practitioner in an Australian healthcare context
    inv-pra-0: 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-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
    inv-pra-2: 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-3: 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-4: 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
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension: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
    .... extension:individualPronouns 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
    .... extension: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
    ... identifier 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
    ... address 0..* Address, AustralianAddress Address(es) of the practitioner that are not role specific (typically home address)
    .... code 1..1 CodeableConcept Coded representation of the qualification
    Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
    ... communication 0..* CodeableConcept A language the practitioner can use in patient communication
    Binding: Common Languages in Australia . (extensible)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0360-extended
    from this IG
    Practitioner.communicationextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    inv-pra-0warningPractitionerIndividual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
    : extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
    inv-pra-1warningPractitionerIndividual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
    : extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
    inv-pra-2warningPractitionerRecorded 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
    : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
    inv-pra-3warningPractitionerRecorded 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
    : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))
    inv-pra-4warningPractitionerRecorded 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
    : extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

     

    Other representations of profile: CSV, Excel, Schematron