NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NHSD Practitioner

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner Version: 4.0.1
Draft as of 2017-10-25 Computable Name: NHSDPratitioner

Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved.

A National Health Services Directory (NHSD) Practitioner

An extended resource providing additional information on the Practitioner not offered by the AU-BASE.

NHSD Provider directory entry for a Practitioner. In a provider directory this provides details of an individual person delivering health related services.

Examples

Practitioner Resource

  1. Resource definition as per AU-PD and AU-BASE
  2. Not supported: address (the practitioner private address)
  3. Not supported: birthDate
  4. Not supported: photo (future support to be provided)

Practitioner Directory Entry Example

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active This element must be supported. This element is included in summaries. 1..1 boolean Required status
Practitioner.Slices for name This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
Practitioner.Slices for name.name:directory-practitioner-name This element must be supported. This element is included in summaries. 1..* HumanName Usual practitioner name
Practitioner.Slices for name.name:directory-practitioner-name.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual (no extensions allowed)
Practitioner.Slices for name.name:directory-practitioner-name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.Slices for name.name:directory-practitioner-name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier:hpii.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:hpii.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:medicarePrescriberNumber.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:medicarePrescriberNumber.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:careAgencyEmployeeIdentifier.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.name:directory-practitioner-name.​use Base required NameUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.qualification:ahpraRegistration.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
inv-ahpra-1 error Practitioner.qualification:ahpraRegistration.identifier AHPRA registration value shall be 3 uppercase letters, followed by 10 digits value.matches('^[A-Z]{3}[0-9]{10}$')

This structure is derived from AUPDPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id 1..1 id Logical id of this artifact
Practitioner.meta 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.id 0..0 Unique id for inter-element referencing
Practitioner.meta.extension 0..0 Extension
Practitioner.meta.versionId 0..0 Version specific identifier
Practitioner.meta.lastUpdated 1..1 instant The timestamp when the resource was last updated
Practitioner.meta.source 0..0 Identifies where the resource comes from
Practitioner.meta.profile 0..0 Profiles this resource claims to conform to
Practitioner.meta.security 0..0 Security Labels applied to this resource
Practitioner.meta.tag 0..0 Tags applied to this resource
Practitioner.implicitRules 0..0 A set of rules under which this content was created
Practitioner.text 0..0 Text summary of the resource, for human interpretation
Practitioner.contained 0..0 Contained, inline Resources
Practitioner.extension 0..0 Extension
Practitioner.modifierExtension 0..0 Extension
Practitioner.Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii 0..0 HPI-I for Directory Entry Practitioner
Practitioner.Slices for identifier.identifier:medicarePrescriberNumber 0..0 Medicare Prescriber Number
Practitioner.Slices for identifier.identifier:careAgencyEmployeeIdentifier 0..0 Care Agency Employee (CAE) Identifier
Practitioner.Slices for identifier.identifier:ahpraRegistration 0..0 Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active 1..1 boolean Required status
Practitioner.telecom 0..0 A contact detail for the practitioner (that apply to all roles)
Practitioner.address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.birthDate 0..0 The date on which the practitioner was born
Practitioner.photo 0..0 Image of the person
Practitioner.qualification 0..0 Certification, licenses, or training pertaining to the provision of care
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active This element must be supported. This element is included in summaries. 1..1 boolean Required status
Practitioner.Slices for name This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
Practitioner.Slices for name.name:directory-practitioner-name This element must be supported. This element is included in summaries. 1..* HumanName Usual practitioner name
Practitioner.Slices for name.name:directory-practitioner-name.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for name.name:directory-practitioner-name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for name.name:directory-practitioner-name.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual (no extensions allowed)
Practitioner.Slices for name.name:directory-practitioner-name.text This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.Slices for name.name:directory-practitioner-name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.Slices for name.name:directory-practitioner-name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier:hpii.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:hpii.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:medicarePrescriberNumber.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:medicarePrescriberNumber.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:careAgencyEmployeeIdentifier.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:careAgencyEmployeeIdentifier.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:ahpraRegistration.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.name:directory-practitioner-name.​use Base required NameUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.qualification:ahpraRegistration.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​issuer.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
inv-ahpra-1 error Practitioner.qualification:ahpraRegistration.identifier AHPRA registration value shall be 3 uppercase letters, followed by 10 digits value.matches('^[A-Z]{3}[0-9]{10}$')

This structure is derived from AUPDPractitioner

Summary

Mandatory: 4 elements
Must-Support: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • There is a slice with no discriminator at Practitioner.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active This element must be supported. This element is included in summaries. 1..1 boolean Required status
Practitioner.Slices for name This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
Practitioner.Slices for name.name:directory-practitioner-name This element must be supported. This element is included in summaries. 1..* HumanName Usual practitioner name
Practitioner.Slices for name.name:directory-practitioner-name.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual (no extensions allowed)
Practitioner.Slices for name.name:directory-practitioner-name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.Slices for name.name:directory-practitioner-name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier:hpii.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:hpii.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:medicarePrescriberNumber.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:medicarePrescriberNumber.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:careAgencyEmployeeIdentifier.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.name:directory-practitioner-name.​use Base required NameUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.qualification:ahpraRegistration.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
inv-ahpra-1 error Practitioner.qualification:ahpraRegistration.identifier AHPRA registration value shall be 3 uppercase letters, followed by 10 digits value.matches('^[A-Z]{3}[0-9]{10}$')

Differential View

This structure is derived from AUPDPractitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id 1..1 id Logical id of this artifact
Practitioner.meta 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.id 0..0 Unique id for inter-element referencing
Practitioner.meta.extension 0..0 Extension
Practitioner.meta.versionId 0..0 Version specific identifier
Practitioner.meta.lastUpdated 1..1 instant The timestamp when the resource was last updated
Practitioner.meta.source 0..0 Identifies where the resource comes from
Practitioner.meta.profile 0..0 Profiles this resource claims to conform to
Practitioner.meta.security 0..0 Security Labels applied to this resource
Practitioner.meta.tag 0..0 Tags applied to this resource
Practitioner.implicitRules 0..0 A set of rules under which this content was created
Practitioner.language 0..0 Language of the resource content
Practitioner.text 0..0 Text summary of the resource, for human interpretation
Practitioner.contained 0..0 Contained, inline Resources
Practitioner.extension 0..0 Extension
Practitioner.modifierExtension 0..0 Extension
Practitioner.Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:hpii 0..0 HPI-I for Directory Entry Practitioner
Practitioner.Slices for identifier.identifier:medicarePrescriberNumber 0..0 Medicare Prescriber Number
Practitioner.Slices for identifier.identifier:careAgencyEmployeeIdentifier 0..0 Care Agency Employee (CAE) Identifier
Practitioner.Slices for identifier.identifier:ahpraRegistration 0..0 Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active 1..1 boolean Required status
Practitioner.telecom 0..0 A contact detail for the practitioner (that apply to all roles)
Practitioner.address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.birthDate 0..0 The date on which the practitioner was born
Practitioner.photo 0..0 Image of the person
Practitioner.qualification 0..0 Certification, licenses, or training pertaining to the provision of care
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
Practitioner.id This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 1..1 Meta Metadata about Practitioner resource
Practitioner.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Practitioner.Slices for identifier This element is included in summaries. 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An identifier intended for computation
Practitioner.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier An identifier intended for computation
Practitioner.active This element must be supported. This element is included in summaries. 1..1 boolean Required status
Practitioner.Slices for name This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
Practitioner.Slices for name.name:directory-practitioner-name This element must be supported. This element is included in summaries. 1..* HumanName Usual practitioner name
Practitioner.Slices for name.name:directory-practitioner-name.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for name.name:directory-practitioner-name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for name.name:directory-practitioner-name.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual (no extensions allowed)
Practitioner.Slices for name.name:directory-practitioner-name.text This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.Slices for name.name:directory-practitioner-name.family This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.Slices for name.name:directory-practitioner-name.given This element is included in summaries. 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.Slices for name.name:directory-practitioner-name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: Common Languages in Australia (preferred): A human language.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier:hpii.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:hpii.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:medicarePrescriberNumber.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:medicarePrescriberNumber.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:careAgencyEmployeeIdentifier.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:careAgencyEmployeeIdentifier.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.identifier:ahpraRegistration.​use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.identifier:ahpraRegistration.​type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.name:directory-practitioner-name.​use Base required NameUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.use Base required IdentifierUse 📍4.0.1 → 4.0.0 FHIR Std.
Practitioner.qualification:ahpraRegistration.​identifier.type Base required v2 Identifier Type - AU Extended ⏿1.0.2 tx.hl7.org.au
Practitioner.qualification:ahpraRegistration.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.qualification:ahpraRegistration.​issuer.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Practitioner.communication Base preferred Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
inv-ahpra-1 error Practitioner.qualification:ahpraRegistration.identifier AHPRA registration value shall be 3 uppercase letters, followed by 10 digits value.matches('^[A-Z]{3}[0-9]{10}$')

This structure is derived from AUPDPractitioner

Summary

Mandatory: 4 elements
Must-Support: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • There is a slice with no discriminator at Practitioner.identifier

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Operation Format Example
Read GET [base]/Practitioner/[id] GET [base]/Practitioner/bd9fb7ed-3a80-4951-90a4-cb2ef4e815b7
search POST [base]/Practitioner/_search  

IMPORTANT NOTES ON SEARCH BEHAVIOUR

NHSD recommends search using POST with for complex search scenarios.

For further information and examples, refer to the capability statement

Read: Practitioner

Read identified practitioner resource content.

GET [base]/Practitioner/[id]

Example: 
GET [base]/Practitioner/bd9fb7ed-3a80-4951-90a4-cb2ef4e815b7

Support: Read Practitioner

Implementation Notes:

Search by Practitioner Name

Search based on family, given and/or any name.

GET [base]/Practitioner?family=[string]
GET [base]/Practitioner?family=[string]&given=[string]
GET [base]/Practitioner?name=[string]

Example:

GET [base]/Practitioner?family=Phillip
GET [base]/Practitioner?family=Phillip&given=David
GET [base]/Practitioner?name=Brown

Support: Search by family, given and name.

Implementation Notes:

Pagination

  • NHSD supports paging using page and _count param to fetch Practitioner resources. By default the count is 10.
GET [base]/Practitioner?_format=json&page=1&_count=10

Refer to the capability statement for further details on paging support through Bundle.Links