Australian Provider Directory Implementation Guide (PD 2.1)

Implementation Guide Template, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-pd/ and changes regularly. See the Directory of published versions

SD.1 StructureDefinition-au-pd-practitioner

Australian Practitioner Directory Entry Profile

Provider directory details of an individual person delivering health related services.

SD.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitioner

This profile builds on AUBasePractitioner.

This profile was published on Mon May 03 02:23:16 UTC 2021 as a draft by HL7 Australia.

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

Australian Practitioner Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: HPI-I (Identifier)
  3. Must Support Required: Active Status (boolean)
  4. Must Support 1 or more: Usual name with family name and one or more given names (HumanName)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerAustralian Practitioner Directory Entry
... meta 0..1MetaMetadata on Practitioner
.... source S0..1uriIdentifies where the resource comes from
... identifier:hpii S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberHPI-I for Directory Entry Practitioner
... active S1..1booleanRequired status
... name 1..*(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name S1..*HumanNameUsual practitioner name
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
Fixed Value: usual
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..*stringGiven names (not always 'first'). Includes middle names

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerAustralian Practitioner Directory Entry
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata on Practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier:hpii S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberHPI-I for Directory Entry Practitioner
... active SΣ1..1booleanRequired status
... name Σ1..*(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ1..*HumanNameUsual practitioner name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: usual
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ahpraprofession-details 0..1(Complex)AHPRA Profession Details
URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details
.... ahpraregistration-details 0..1(Complex)AHPRA Registration Details
URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: V2 Degree/License/Certificate - AU Extended (preferred)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Australian Practitioner Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: HPI-I (Identifier)
  3. Must Support Required: Active Status (boolean)
  4. Must Support 1 or more: Usual name with family name and one or more given names (HumanName)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerAustralian Practitioner Directory Entry
... meta 0..1MetaMetadata on Practitioner
.... source S0..1uriIdentifies where the resource comes from
... identifier:hpii S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberHPI-I for Directory Entry Practitioner
... active S1..1booleanRequired status
... name 1..*(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name S1..*HumanNameUsual practitioner name
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
Fixed Value: usual
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..*stringGiven names (not always 'first'). Includes middle names

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerAustralian Practitioner Directory Entry
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata on Practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier:hpii S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumberHPI-I for Directory Entry Practitioner
... active SΣ1..1booleanRequired status
... name Σ1..*(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
.... name:directory-practitioner-name SΣ1..*HumanNameUsual practitioner name
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: usual
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ahpraprofession-details 0..1(Complex)AHPRA Profession Details
URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details
.... ahpraregistration-details 0..1(Complex)AHPRA Registration Details
URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*Identifier, AUAHPRARegistrationNumberAn identifier intended for computation
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: V2 Degree/License/Certificate - AU Extended (preferred)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.1.2 Quick Start

Below is an overview of the requirements for search and read operations.


Read: Practitioner

Read identified practitioner resource content.

GET [base]/Practitioner/[id]

Example: GET [base]/Practitioner/1234

Support: MUST support read Practitioner

Implementation Notes: (how to read resource)


Search: Active Status

Search based on active status of the practitioner record.

GET [base]/Practitioner?active=[status]

Example: GET [base]/Practitioner?active=true

Support: MUST support search Practitioner by active status (true | false).

Implementation Notes: (how to search by token)


Search: 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=Smith

GET [base]/Practitioner?family=Smith&practitioner.given=John

GET [base]/Practitioner?name=Smith

Support: SHOULD support search by family, given and name.

Implementation Notes: (how to search by string)


Search: HPI-I

Search based on identifier token.

GET [base]/Practitioner?identifier=[system]|[value]

Example: GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003610833334085

Support: SHOULD support search by HPI-I.

Implementation Notes: (how to search by token)