Australian Base Profiles Implementation Guide

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

1.0 StructureDefinition-au-practitioner

Australian Practitioner Profile

This profile defines a practitioner administration details structure that includes core localisation concepts.

Identifiers

These definitions represent common data held in the Practitioner.identifier element.

  • Healthcare Provider Identifier - Individual

The Healthcare provider identifier—individual (HPI-I) is the numerical identifier that uniquely identifies individuals in Australia providing healthcare.

A unique numeric identifier for the prescriber of the Pharmaceutical Benefits Scheme (PBS) item for which the PBS benefit is being claimed.

Examples

Practitioner with HPI-I and Prescriber Number

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Base profile for Australian context Practitioner

This profile builds on Practitioner.

This profile was published on Sat Mar 11 17:30:54 AEDT 2017 as a draft by Health Level Seven Australia (Patient Administration).

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

Australian Practitioner

  1. Optional HPI-I profile defined
  2. Optional Prescriber Number profile defined
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational Individual Provider Healthcare Identifier
inv-hpii-0: HPI-I is exactly 16 characters
inv-hpii-1: HPI-I prefix is 800361
.... type 1..1CodeableConceptHPI-I Identifier Type
..... coding 0..1CodingHPI-I Identifier Type Code
Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI","display":"National provider identifier"}
..... 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 1..1stringExample HPI-I number': 8003610833334085
Max Length: 16
... identifier 0..1IdentifierPrescriber Number
.... type 1..1CodeableConceptPrescriber Number Type
..... coding 0..1CodingPrescriber Number Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES","display":"Prescriber Number"}
..... 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..1stringExample Prescriber Number': 453221

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... 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 At End by value:system, value:type
... identifier ΣI0..1IdentifierNational Individual Provider Healthcare Identifier
inv-hpii-0: HPI-I is exactly 16 characters
inv-hpii-1: HPI-I prefix is 800361
.... 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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-I Identifier Type Code

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI","display":"National provider identifier"}
..... 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 Σ1..1stringThe value that is unique
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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingPrescriber Number Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES","display":"Prescriber Number"}
..... 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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ0..*HumanNameThe name(s) associated with the practitioner
... 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

  1. Optional HPI-I profile defined
  2. Optional Prescriber Number profile defined

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier I0..1IdentifierNational Individual Provider Healthcare Identifier
inv-hpii-0: HPI-I is exactly 16 characters
inv-hpii-1: HPI-I prefix is 800361
.... type 1..1CodeableConceptHPI-I Identifier Type
..... coding 0..1CodingHPI-I Identifier Type Code
Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI","display":"National provider identifier"}
..... 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 1..1stringExample HPI-I number': 8003610833334085
Max Length: 16
... identifier 0..1IdentifierPrescriber Number
.... type 1..1CodeableConceptPrescriber Number Type
..... coding 0..1CodingPrescriber Number Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES","display":"Prescriber Number"}
..... 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..1stringExample Prescriber Number': 453221

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... 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 At End by value:system, value:type
... identifier ΣI0..1IdentifierNational Individual Provider Healthcare Identifier
inv-hpii-0: HPI-I is exactly 16 characters
inv-hpii-1: HPI-I prefix is 800361
.... 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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-I Identifier Type Code

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"NPI","display":"National provider identifier"}
..... 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 Σ1..1stringThe value that is unique
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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingPrescriber Number Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"PRES","display":"Prescriber Number"}
..... 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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ0..*HumanNameThe name(s) associated with the practitioner
... 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

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-practitioner

none defined