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

PathConformanceValueSet / CodeURI
Practitioner.identifier:hpii.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:hpii.typerequiredPattern Value: NPI
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:medicarePrescriberNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:medicarePrescriberNumber.typerequiredPattern Value: PRES
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:careAgencyEmployeeIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.name:directory-practitioner-name.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.0
From the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.qualification:ahpraRegistration.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.communicationpreferredCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.div.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-ahpra-1errorPractitioner.qualification:ahpraRegistration.identifierAHPRA 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
.... extension 0..0
.... versionId 0..0
.... lastUpdated 1..1 instant The timestamp when the resource was last updated
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
.... identifier:hpii 0..0
.... identifier:medicarePrescriberNumber 0..0
.... identifier:careAgencyEmployeeIdentifier 0..0
.... identifier:ahpraRegistration 0..0
.... 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
... address 0..0
... birthDate 0..0
... photo 0..0
... qualification 0..0
... 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)

PathConformanceValueSetURI
Practitioner.communicationpreferredCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
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
.... 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

PathConformanceValueSet / CodeURI
Practitioner.identifier:hpii.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:hpii.typerequiredPattern Value: NPI
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:medicarePrescriberNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:medicarePrescriberNumber.typerequiredPattern Value: PRES
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:careAgencyEmployeeIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:careAgencyEmployeeIdentifier.typerequiredhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:ahpraRegistration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.name:directory-practitioner-name.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.0
From the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
From the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.qualification:ahpraRegistration.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.issuer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Practitioner.communicationpreferredCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.div.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-ahpra-1errorPractitioner.qualification:ahpraRegistration.identifierAHPRA 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
.... 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

PathConformanceValueSet / CodeURI
Practitioner.identifier:hpii.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:hpii.typerequiredPattern Value: NPI
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:medicarePrescriberNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:medicarePrescriberNumber.typerequiredPattern Value: PRES
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:careAgencyEmployeeIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.name:directory-practitioner-name.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.0
From the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.qualification:ahpraRegistration.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.communicationpreferredCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.div.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-ahpra-1errorPractitioner.qualification:ahpraRegistration.identifierAHPRA 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
.... extension 0..0
.... versionId 0..0
.... lastUpdated 1..1 instant The timestamp when the resource was last updated
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... Slices for identifier 0..* Identifier NHSD Practitioner identifiers
Slice: Unordered, Open by
.... identifier:hpii 0..0
.... identifier:medicarePrescriberNumber 0..0
.... identifier:careAgencyEmployeeIdentifier 0..0
.... identifier:ahpraRegistration 0..0
.... 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
... address 0..0
... birthDate 0..0
... photo 0..0
... qualification 0..0
... 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)

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

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

PathConformanceValueSet / CodeURI
Practitioner.identifier:hpii.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:hpii.typerequiredPattern Value: NPI
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:medicarePrescriberNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:medicarePrescriberNumber.typerequiredPattern Value: PRES
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:careAgencyEmployeeIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:careAgencyEmployeeIdentifier.typerequiredhttp://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.identifier:ahpraRegistration.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.identifier:ahpraRegistration.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.name:directory-practitioner-name.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/name-use|4.0.0
From the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
From the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.0
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.identifier.typerequiredPattern Value: AHPRA
http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203
Practitioner.qualification:ahpraRegistration.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Practitioner.qualification:ahpraRegistration.issuer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Practitioner.communicationpreferredCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.div.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-ahpra-1errorPractitioner.qualification:ahpraRegistration.identifierAHPRA 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