AU Core Practitioner - AU Core Implementation Guide v1.1.0-ci-build

AU Core Implementation Guide
1.1.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.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/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.1.0-ci-build
Standards status: Trial-use	Maturity Level: 2	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:

Refer to this Resource Profile: AU Core Pathology Result Observation, AU Core Diagnostic Result Observation, AU Core Encounter, AU Core MedicationRequest and AU Core PractitionerRole
Examples for this Resource Profile: Practitioner/bobrester-bob, Practitioner/chau-fryer, Practitioner/darleen-mackay and Practitioner/sallie-sutherland
CapabilityStatements using this Resource Profile: AU Core Requester CapabilityStatement and AU Core Responder CapabilityStatement

Changes since version 1.0.0:

The resource metadata has changed (description)

Formal Views of Profile Content

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

This structure is derived from AUBasePractitioner

Description & Constraints

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 for the person as this agent
Slice: Unordered, Open by pattern:type

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

identifier:hpii

SO

0..1

AUHPII

An identifier for the person as this agent

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

name

SO

1..*

HumanName

The name(s) associated with the practitioner

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

family

SO

1..1

string

Family name (often called 'Surname')

Obligations

Actor

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

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Description & Constraints

Practitioner

C

0..*

AUBasePractitioner

A person with a formal responsibility in the provisioning of services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
inv-pra-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pra-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pra-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pra-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pra-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

modifierExtension

?!

0..*

Extension

Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

Slices for identifier

SOΣ

0..*

Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber

An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

identifier:hpii

SOΣ

0..1

AUHPII

An identifier for the person as this agent
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

name

SOΣ

1..*

HumanName

The name(s) associated with the practitioner
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

use

?!Σ

0..1

code

family

SOΣ

1..1

string

Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

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
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse `http://hl7.org/fhir/ValueSet/name-use\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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'))

Description & Constraints

Practitioner

C

0..*

AUBasePractitioner

A person with a formal responsibility in the provisioning of services
inv-pra-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pra-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pra-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pra-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pra-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Practitioner.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Practitioner.name.use

required

NameUse

http://hl7.org/fhir/ValueSet/name-use|4.0.1

from the FHIR Standard

Practitioner.gender

required

AdministrativeGender

http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

from the FHIR Standard

Practitioner.qualification.code

preferred

Hl7VSDegreeLicenseCertificateAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0360-extended

Practitioner.communication

extensible

CommonLanguagesInAustralia

https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
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 AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)

Slices

This structure defines the following Slices:

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

Maturity: 2

Differential View

This structure is derived from AUBasePractitioner

Description & Constraints

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 for the person as this agent
Slice: Unordered, Open by pattern:type

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

identifier:hpii

SO

0..1

AUHPII

An identifier for the person as this agent

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

name

SO

1..*

HumanName

The name(s) associated with the practitioner

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

family

SO

1..1

string

Family name (often called 'Surname')

Obligations

Actor

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

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Key Elements View

Description & Constraints

Practitioner

C

0..*

AUBasePractitioner

A person with a formal responsibility in the provisioning of services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
inv-pra-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pra-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pra-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pra-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pra-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

modifierExtension

?!

0..*

Extension

Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

Slices for identifier

SOΣ

0..*

Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber

An identifier for the person as this agent
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

identifier:hpii

SOΣ

0..1

AUHPII

An identifier for the person as this agent
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

name

SOΣ

1..*

HumanName

The name(s) associated with the practitioner
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

use

?!Σ

0..1

code

family

SOΣ

1..1

string

Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children

Obligations

Actor

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
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse `http://hl7.org/fhir/ValueSet/name-use\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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'))

Snapshot View

Description & Constraints

Practitioner

C

0..*

AUBasePractitioner

A person with a formal responsibility in the provisioning of services
inv-pra-0: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply
inv-pra-1: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
inv-pra-2: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply
inv-pra-3: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply
inv-pra-4: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Practitioner.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Practitioner.name.use

required

NameUse

http://hl7.org/fhir/ValueSet/name-use|4.0.1

from the FHIR Standard

Practitioner.gender

required

AdministrativeGender

http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

from the FHIR Standard

Practitioner.qualification.code

preferred

Hl7VSDegreeLicenseCertificateAUExtended

http://terminology.hl7.org.au/ValueSet/v2-0360-extended

Practitioner.communication

extensible

CommonLanguagesInAustralia

https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
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 AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)

Slices

This structure defines the following Slices:

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

Maturity: 2

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:

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:

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)
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)

IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#1.1.0-ci-build based on FHIR 4.0.1. Generated 2025-03-11
Links: Table of Contents | QA Report | Version History | | Propose a change