AU Core Implementation Guide
1.0.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-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-core/ and changes regularly. See the Directory of published versions

Resource Profile: AU Core Practitioner

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner Version: 1.0.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: AUCorePractitioner

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Record or update information about a practitioner referenced by another resource
  • Read information about a practitioner referenced by another resource

Profile specific implementation guidance

  • Even though AU Core Profiles allow both PractitionerRole and Practitioner to be referenced, because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced instead of the Practitioner resource.
  • If a system only supports Practitioner, the system SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Changes since version 1.0.0-ballot:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from AUBasePractitioner

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner 0..* AUBasePractitioner A person with a formal responsibility in the provisioning of services
    ... Slices for identifier SO 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
    Slice: Unordered, Open by pattern:type
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... identifier:hpii SO 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SO 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SO 1..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SO 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner C 0..* AUBasePractitioner 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
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address C 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Practitioner.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practicePractitionerA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-hpii-0errorPractitioner.identifier:hpiiHPI-I shall be 16 digits
    : value.matches('^([0-9]{16})$')
    inv-hpii-1errorPractitioner.identifier:hpiiHPI-I prefix shall be 800361
    : value.startsWith('800361')
    inv-hpii-2errorPractitioner.identifier:hpiiHPI-I shall pass the Luhn algorithm check
    : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
    inv-pra-2warningPractitionerIndividual 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-3warningPractitionerIndividual 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-4warningPractitionerRecorded 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-5warningPractitionerRecorded 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-6warningPractitionerRecorded 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'))
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner C 0..* AUBasePractitioner 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
    ... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... active Σ 0..1 boolean Whether this practitioner's record is in active use
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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 C 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
    .... 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 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Practitioner.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Practitioner.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Practitioner.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0360-extended
    Practitioner.communicationextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practicePractitionerA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-hpii-0errorPractitioner.identifier:hpiiHPI-I shall be 16 digits
    : value.matches('^([0-9]{16})$')
    inv-hpii-1errorPractitioner.identifier:hpiiHPI-I prefix shall be 800361
    : value.startsWith('800361')
    inv-hpii-2errorPractitioner.identifier:hpiiHPI-I shall pass the Luhn algorithm check
    : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
    inv-pra-0errorPractitioner.qualificationA qualification shall only have Ahpra Profession details if the code is Ahpra Profession
    : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
    inv-pra-1errorPractitioner.qualificationA qualification shall only have Ahpra Registration details if the code is Ahpra Registration
    : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
    inv-pra-2warningPractitionerIndividual 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-3warningPractitionerIndividual 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-4warningPractitionerRecorded 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-5warningPractitionerRecorded 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-6warningPractitionerRecorded 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'))

    This structure is derived from AUBasePractitioner

    Summary

    Mandatory: 2 elements
    Must-Support: 5 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Practitioner.identifier

    Maturity: 1

    Differential View

    This structure is derived from AUBasePractitioner

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner 0..* AUBasePractitioner A person with a formal responsibility in the provisioning of services
    ... Slices for identifier SO 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
    Slice: Unordered, Open by pattern:type
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... identifier:hpii SO 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SO 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... family SO 1..1 string Family name (often called 'Surname')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... given SO 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner C 0..* AUBasePractitioner 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
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... address C 0..* Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Practitioner.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practicePractitionerA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-hpii-0errorPractitioner.identifier:hpiiHPI-I shall be 16 digits
    : value.matches('^([0-9]{16})$')
    inv-hpii-1errorPractitioner.identifier:hpiiHPI-I prefix shall be 800361
    : value.startsWith('800361')
    inv-hpii-2errorPractitioner.identifier:hpiiHPI-I shall pass the Luhn algorithm check
    : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
    inv-pra-2warningPractitionerIndividual 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-3warningPractitionerIndividual 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-4warningPractitionerRecorded 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-5warningPractitionerRecorded 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-6warningPractitionerRecorded 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'))

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Practitioner C 0..* AUBasePractitioner 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
    ... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... active Σ 0..1 boolean Whether this practitioner's record is in active use
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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')
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    .... 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 C 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
    .... 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 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Practitioner.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Practitioner.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Practitioner.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
    http://terminology.hl7.org.au/ValueSet/v2-0360-extended
    Practitioner.communicationextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practicePractitionerA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    inv-hpii-0errorPractitioner.identifier:hpiiHPI-I shall be 16 digits
    : value.matches('^([0-9]{16})$')
    inv-hpii-1errorPractitioner.identifier:hpiiHPI-I prefix shall be 800361
    : value.startsWith('800361')
    inv-hpii-2errorPractitioner.identifier:hpiiHPI-I shall pass the Luhn algorithm check
    : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
    inv-pra-0errorPractitioner.qualificationA qualification shall only have Ahpra Profession details if the code is Ahpra Profession
    : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
    inv-pra-1errorPractitioner.qualificationA qualification shall only have Ahpra Registration details if the code is Ahpra Registration
    : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
    inv-pra-2warningPractitionerIndividual 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-3warningPractitionerIndividual 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-4warningPractitionerRecorded 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-5warningPractitionerRecorded 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-6warningPractitionerRecorded 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'))

    This structure is derived from AUBasePractitioner

    Summary

    Mandatory: 2 elements
    Must-Support: 5 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Practitioner.identifier

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

    Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

    Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
    identifier SHALL token The requester SHALL provide both the system and code values. The responder SHALL support both.

    The requester SHOULD support search using a HPI-I identifier as defined in the profile. The responder SHOULD support search using the using a HPI-I identifier as defined in the profile.
    _id SHOULD token
    name SHOULD string

    Mandatory Search Parameters

    The following search parameters SHALL be supported:

    1. SHALL support searching using the identifier search parameter:

      GET [base]/Practitioner?identifier={system|}[code]

      Example:

      1. GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717

      Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)

    Optional Search Parameters:

    The following search parameters SHOULD be supported:

    1. SHOULD support searching using the _id search parameter:

      GET [base]/Practitioner?_id=[id]

      Example:

      1. GET [base]/Practitioner?_id=5678

      Implementation Notes: Fetches a bundle with the requested Practitioner, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

    2. SHOULD support searching for a practitioner based on text name using the name search parameter:

      GET [base]/Practitioner?name=[string]

      Example:

      1. GET [base]/Practitioner?name=Sandyson
      2. GET [base]/Practitioner?name=Sandyson&

      Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)