Australian Profile for Provider Directory Services

This page is part of the Australian Provider Directory IG (v0.3.0: PD 1 on FHIR STU3 Draft) based on FHIR R3. The current version which supercedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

SD.4 StructureDefinition-au-pd-practitioner

Australian Practitioner Directory Entry Profile

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

Examples

Practitioner Directory Entry Example

SD.4.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Base profile for Australian context Practitioner for provider directory usage

This profile builds on AU Base Practitioner.

This profile was published on Fri May 05 16:52:22 AEST 2017 as a draft by null.

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

Australian Practitioner Directory Entry

  1. Must Support Optional: HPI-I
  2. Must Support Required: Active status
  3. Must Support Required: Usual name with family name and one or more given names
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Australian Practitioner Directory Entry
... identifier S0..1Identifier
... active S0..1boolean
... name HumanNameSlice: Unordered, Open At End by value:use
... name S1..*HumanNameUsual practitioner name
.... use 1..1codeFixed Value: usual
.... family 1..1string
.... given 1..*string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*Australian Practitioner Directory Entry
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ΣIdentifierA identifier for the person as this agent
Slice: Unordered, Open by value:system, value:type
... identifier SΣ0..1IdentifierHPI-I
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-I Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-I Identifier Type Code

Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI"}
..... text Σ1..1stringHPI-I Identifier Type Descriptive Text
Fixed Value: HPI-I
.... system Σ1..1urinational namespace for hpi-i
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
.... value ΣI1..1stringThe value that is unique
inv-hpii-0: The HPI-I shall be an exactly 16 digit number
inv-hpii-1: HPI-I prefix is 800361
inv-hpii-2: The identifier shall pass the Luhn algorithm check
Example General': 123456
Example HPI-I number': 8003610833334085
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..1IdentifierPrescriber Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPrescriber Number Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingPrescriber Number Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES"}
..... text Σ1..1stringPrescriber Number Identifier Type Descriptive Text
Fixed Value: Prescriber Number
.... system Σ1..1urinamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/prescriber-number
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example Prescriber Number': 453221
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..1IdentifierAustralian Health Practitioner Regulation Agency Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"AHPRA"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Australian Health Practitioner Regulation Agency Number
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this practitioner's record is in active use
... name ΣHumanNameThe name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
... name SΣ1..*HumanNameUsual practitioner name
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
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..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... 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 is able to use in patient communication
Binding: Common Languages (extensible)

doco Documentation for this format

Australian Practitioner Directory Entry

  1. Must Support Optional: HPI-I
  2. Must Support Required: Active status
  3. Must Support Required: Usual name with family name and one or more given names

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Australian Practitioner Directory Entry
... identifier S0..1Identifier
... active S0..1boolean
... name HumanNameSlice: Unordered, Open At End by value:use
... name S1..*HumanNameUsual practitioner name
.... use 1..1codeFixed Value: usual
.... family 1..1string
.... given 1..*string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*Australian Practitioner Directory Entry
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ΣIdentifierA identifier for the person as this agent
Slice: Unordered, Open by value:system, value:type
... identifier SΣ0..1IdentifierHPI-I
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-I Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-I Identifier Type Code

Required Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI"}
..... text Σ1..1stringHPI-I Identifier Type Descriptive Text
Fixed Value: HPI-I
.... system Σ1..1urinational namespace for hpi-i
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
.... value ΣI1..1stringThe value that is unique
inv-hpii-0: The HPI-I shall be an exactly 16 digit number
inv-hpii-1: HPI-I prefix is 800361
inv-hpii-2: The identifier shall pass the Luhn algorithm check
Example General': 123456
Example HPI-I number': 8003610833334085
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..1IdentifierPrescriber Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPrescriber Number Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingPrescriber Number Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES"}
..... text Σ1..1stringPrescriber Number Identifier Type Descriptive Text
Fixed Value: Prescriber Number
.... system Σ1..1urinamespace for prescriber number
Fixed Value: http://ns.electronichealth.net.au/id/prescriber-number
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example Prescriber Number': 453221
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier Σ0..1IdentifierAustralian Health Practitioner Regulation Agency Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"AHPRA"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Australian Health Practitioner Regulation Agency Number
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this practitioner's record is in active use
... name ΣHumanNameThe name(s) associated with the practitioner
Slice: Unordered, Open At End by value:use
... name SΣ1..*HumanNameUsual practitioner name
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
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..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... 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 is able to use in patient communication
Binding: Common Languages (extensible)

doco Documentation for this format

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

 

SD.4.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: 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)