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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about Practitioner resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... lastUpdated Σ 1..1 instant The timestamp when the resource was last updated
... Slices for identifier Σ 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ahpraregistrationnumber Σ 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid SΣ 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... Slices for name Σ 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ 1..* HumanName Usual practitioner name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 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
... 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
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())
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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id 1..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about Practitioner resource
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... versionId 0..0 Version specific identifier
.... lastUpdated 1..1 instant The timestamp when the resource was last updated
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... security 0..0 Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
.... identifier:hpii 0..0 HPI-I for Directory Entry Practitioner
.... identifier:medicarePrescriberNumber 0..0 Medicare Prescriber Number
.... identifier:careAgencyEmployeeIdentifier 0..0 Care Agency Employee (CAE) Identifier
.... identifier:ahpraRegistration 0..0 Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier
.... identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid S 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... active 1..1 boolean Required status
... telecom 0..0 A contact detail for the practitioner (that apply to all roles)
... address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
... birthDate 0..0 The date on which the practitioner was born
... photo 0..0 Image of the person
... qualification 0..0 Certification, licenses, or training pertaining to the provision of care
... 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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about Practitioner resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... lastUpdated Σ 1..1 instant The timestamp when the resource was last updated
... Slices for identifier Σ 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ahpraregistrationnumber Σ 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid SΣ 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... Slices for name Σ 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ 1..* HumanName Usual practitioner name
..... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 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
..... 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
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... 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
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())
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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about Practitioner resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... lastUpdated Σ 1..1 instant The timestamp when the resource was last updated
... Slices for identifier Σ 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ahpraregistrationnumber Σ 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid SΣ 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... Slices for name Σ 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ 1..* HumanName Usual practitioner name
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 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
... 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
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())
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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id 1..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about Practitioner resource
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... versionId 0..0 Version specific identifier
.... lastUpdated 1..1 instant The timestamp when the resource was last updated
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... security 0..0 Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
.... identifier:hpii 0..0 HPI-I for Directory Entry Practitioner
.... identifier:medicarePrescriberNumber 0..0 Medicare Prescriber Number
.... identifier:careAgencyEmployeeIdentifier 0..0 Care Agency Employee (CAE) Identifier
.... identifier:ahpraRegistration 0..0 Australian Health Practitioner Regulation Agency (AHPRA) registration as identifier
.... identifier:ahpraregistrationnumber 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid S 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... active 1..1 boolean Required status
... telecom 0..0 A contact detail for the practitioner (that apply to all roles)
... address 0..0 Address(es) of the practitioner that are not role specific (typically home address)
... birthDate 0..0 The date on which the practitioner was born
... photo 0..0 Image of the person
... qualification 0..0 Certification, licenses, or training pertaining to the provision of care
... 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: Filtersdoco
.. Practitioner 0..* AUPDPractitioner Australian Practitioner Directory Entry
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about Practitioner resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... lastUpdated Σ 1..1 instant The timestamp when the resource was last updated
... Slices for identifier Σ 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:ahpraregistrationnumber Σ 0..1 AUAHPRARegistrationNumber An identifier for the person as this agent
.... identifier:rid SΣ 0..1 NHSDResourceIdentifier An identifier for the person as this agent
... Slices for name Σ 1..* HumanName The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ 1..* HumanName Usual practitioner name
..... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: usual
..... text Σ 0..1 string Text representation of the full name
..... family Σ 1..1 string Family name (often called 'Surname')
..... given Σ 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
..... 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
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... 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
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())
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