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

AU eRequesting 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-erequesting/ and changes regularly. See the Directory of published versions

Resource Profile: AU eRequesting Practitioner

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitioner Version: 1.0.0-ci-build
Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingPractitioner

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Practitioner resource that is used to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the AU Core Practitioner profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Practitioner resource when conforming to this profile.

Obligations for AU Core actors (AU Core Requester and AU Core Responder) inherited from AU Core Practitioner currently render in the profile view. This is a tooling limitation, and only the AU eRequesting actor obligations should be applied. See Zulip discussion for more information.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

  • New Content

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension Content/Rules for all slices
    .... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    .... identifier:hpii SOΣ 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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')
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Practitioner If 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-4 error Practitioner If 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-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pra-0 warning Practitioner Individual 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-1 warning Practitioner Individual 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-2 warning Practitioner 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 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-3 warning Practitioner 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 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-4 warning Practitioner 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 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 AUCorePractitioner

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    ... identifier O 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... Slices for identifier Content/Rules for all slices
    .... identifier:hpii O 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... name O 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... family O 1..1 string Family name (often called 'Surname')
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... given O 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
    ... 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
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for identifier SOΣ 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
    Slice: Unordered, Open by pattern:type
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... identifier:hpii SOΣ 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... active Σ 0..1 boolean Whether this practitioner's record is in active use
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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')
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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 Σ 0..* Address, AustralianAddress Address(es) of the practitioner that are not role specific (typically home address)
    ... 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 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... identifier 0..* Identifier An identifier for this qualification for the practitioner
    .... code 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

    Path Status Usage ValueSet Version Source
    Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Practitioner.qualification.​code Base preferred hl7VS-degreeLicenseCertificate - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Practitioner.communication Base extensible Common Languages in Australia . ⏿2.2.1 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Practitioner If 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-4 error Practitioner If 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-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pra-0 warning Practitioner Individual 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-1 warning Practitioner Individual 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-2 warning Practitioner 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 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-3 warning Practitioner 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 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-4 warning Practitioner 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 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 AUCorePractitioner

    Summary

    Maturity: 0

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... Slices for extension Content/Rules for all slices
    .... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    .... identifier:hpii SOΣ 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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')
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Practitioner If 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-4 error Practitioner If 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-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pra-0 warning Practitioner Individual 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-1 warning Practitioner Individual 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-2 warning Practitioner 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 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-3 warning Practitioner 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 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-4 warning Practitioner 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 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'))

    Differential View

    This structure is derived from AUCorePractitioner

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    ... identifier O 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... Slices for identifier Content/Rules for all slices
    .... identifier:hpii O 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... name O 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... family O 1..1 string Family name (often called 'Surname')
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... given O 0..* string Given names (not always 'first'). Includes middle names
    ObligationsActorSource
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Practitioner C 0..* AUCorePractitioner A person with a formal responsibility in the provisioning of services
    Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
    ... 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
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... 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
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for identifier SOΣ 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier for the person as this agent
    Slice: Unordered, Open by pattern:type
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... identifier:hpii SOΣ 0..1 AUHPII An identifier for the person as this agent
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... active Σ 0..1 boolean Whether this practitioner's record is in active use
    ... name SOΣ 1..* HumanName The name(s) associated with the practitioner
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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')
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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
    ObligationsActorSource
    SHALL:populate-if-known AU Core Responder from AU Core Practitioner
    SHALL:no-error AU Core Requester from AU Core Practitioner
    SHALL:populate-if-known & SHALL:populate-if-known AU Core ResponderAU eRequesting Placer from AU Core Practitioner
    SHALL:no-error & SHALL:handle AU Core RequesterAU eRequesting Filler from AU Core Practitioner
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... 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 Σ 0..* Address, AustralianAddress Address(es) of the practitioner that are not role specific (typically home address)
    ... 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 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... identifier 0..* Identifier An identifier for this qualification for the practitioner
    .... code 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

    Path Status Usage ValueSet Version Source
    Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Practitioner.qualification.​code Base preferred hl7VS-degreeLicenseCertificate - AU Extended 📦6.0.0-ci-build AU Base Implementation Guide vnull
    Practitioner.communication Base extensible Common Languages in Australia . ⏿2.2.1 tx.ontoserver.csiro.au

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error Practitioner If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error Practitioner If 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-4 error Practitioner If 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-5 error Practitioner If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice Practitioner A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    inv-pra-0 warning Practitioner Individual 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-1 warning Practitioner Individual 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-2 warning Practitioner 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 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-3 warning Practitioner 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 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-4 warning Practitioner 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 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 AUCorePractitioner

    Summary

    Maturity: 0

     

    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 eRequesting 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 eRequesting interactions is defined here.

    Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".

    Parameter(s) Server Conformance Placer Conformance Filler Conformance Patient Conformance Type(s) Requirements (when used alone or in combination)
    _id SHALL MAY MAY MAY token
    identifier SHALL - MAY MAY token

    Search Parameters:

    The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

    1. _id search parameter

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

      Example:

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

    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)

    1. 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|8003616566719020

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