Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.4.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R5 R4 R3

1.0 StructureDefinition-au-practitionerrole

AU Base Practitioner Role Profile

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

Identifiers

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

  • Provider Number

METeOR Description

METeOR Description

A unique numeric identifier for the Medicare service provider to facilitate the payment of patient/provider claims and a unique alphanumeric identifier for a Medicare service provider’s location, which may be the place of a provider’s practice or the place of equipment.

Examples

Practitioner Role with Provider Number and ANZSCO coded role

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Base profile for Australian context Practitioner Role (Individual Provider)

This profile builds on PractitionerRole.

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.

AU Base Practitioner Role profile contains:

  1. Base: Practitioner in a Role (as PractitionerRole)
  2. Optional Provider Number (as Identifier)
  3. Optional Practitioner at Organization Number (as Identifier)
  4. Optional Care Agency Employee Identifier (as Identifier)
  5. Optional Employee Numbers (as Identifier)
  6. Optional Practitioner Specialties (as CodeableConcept)
  7. Optional Location (as Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*Australian practitioner role at a location
... identifier IdentifierAustralian Practitioner Role Identifiers
Slice: Unordered, Open by value:type, value:system
... identifier 0..1IdentifierAustralian provider number
.... type 1..1CodeableConceptProvider Number Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingProvider Number Identifier Type Code
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}
..... text 1..1stringProvider Number Identifier Type Descriptive Text
Fixed Value: Medicare Provider Number
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value 1..1stringMedicare Provider Number Value
Example Provider number': 2426621B
... identifier 0..1IdentifierProvider at Organisation Identifier
.... type 1..1CodeableConceptNational Provider at Organisation Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NPIO"}
..... text 1..1stringNational Provider at Organisation Identifer Type Descriptive Text
Fixed Value: NPIO
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/npio
.... value I1..1stringNPIO Value
inv-npio-0: NPIO length is exactly 33 characters
... identifier 0..1IdentifierCare Agency Employee Identifier
.... type 1..1CodeableConcept
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"EI"}
..... text 1..1stringFixed Value: Care Agency Employee Identifier
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
.... value I1..1stringCAEI Number Value
inv-caei-0: The CAEI shall be an exactly 16 digit number
inv-caei-1: The CAEI SHALL contain a prefix of 900360
inv-caei-2: The CAEI shall pass the Luhn algorithm check
... identifier 0..*IdentifierEmployee Number
.... type 1..1CodeableConcept
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"EI"}
..... text 1..1stringFixed Value: Employee Number
.... value 1..1stringEmployee Number Value
.... assigner 1..1Reference(Organization)
..... display 1..1string
... practitioner 0..1Reference(AU Base Practitioner)
... organization 0..1Reference(AU Base Organisation)
... specialty CodeableConceptSlice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptPractitioner Specialty
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations (required)
... location 0..1Reference(Location)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*Australian practitioner role at a location
... 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 ΣIdentifierAustralian Practitioner Role Identifiers
Slice: Unordered, Open by value:type, value:system
... identifier Σ0..1IdentifierAustralian provider number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptProvider Number Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingProvider Number Identifier Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}
..... text Σ1..1stringProvider Number Identifier Type Descriptive Text
Fixed Value: Medicare Provider Number
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value Σ1..1stringMedicare Provider Number Value
Example General': 123456
Example Provider number': 2426621B
.... 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..1IdentifierProvider at Organisation Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptNational Provider at Organisation Identifier Type
Binding: v2 Identifier Type - AU Extended (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":"NPIO"}
..... text Σ1..1stringNational Provider at Organisation Identifer Type Descriptive Text
Fixed Value: NPIO
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/npio
.... value ΣI1..1stringNPIO Value
inv-npio-0: NPIO length is exactly 33 characters
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)
... identifier Σ0..1IdentifierCare Agency Employee Identifier
.... 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/fhir/v2/0203","code":"EI"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Care Agency Employee Identifier
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
.... value ΣI1..1stringCAEI Number Value
inv-caei-0: The CAEI shall be an exactly 16 digit number
inv-caei-1: The CAEI SHALL contain a prefix of 900360
inv-caei-2: The CAEI shall pass the Luhn algorithm check
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)
... identifier Σ0..*IdentifierEmployee 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/fhir/v2/0203","code":"EI"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Employee 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..1stringEmployee Number Value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active Σ0..1booleanWhether this practitioner's record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(AU Base Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(AU Base Organisation)Organization where the roles are available
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty ΣCodeableConceptSpecific specialty of the practitioner
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptPractitioner Specialty
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations (required)
... location Σ0..1Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

AU Base Practitioner Role profile contains:

  1. Base: Practitioner in a Role (as PractitionerRole)
  2. Optional Provider Number (as Identifier)
  3. Optional Practitioner at Organization Number (as Identifier)
  4. Optional Care Agency Employee Identifier (as Identifier)
  5. Optional Employee Numbers (as Identifier)
  6. Optional Practitioner Specialties (as CodeableConcept)
  7. Optional Location (as Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*Australian practitioner role at a location
... identifier IdentifierAustralian Practitioner Role Identifiers
Slice: Unordered, Open by value:type, value:system
... identifier 0..1IdentifierAustralian provider number
.... type 1..1CodeableConceptProvider Number Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingProvider Number Identifier Type Code
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}
..... text 1..1stringProvider Number Identifier Type Descriptive Text
Fixed Value: Medicare Provider Number
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value 1..1stringMedicare Provider Number Value
Example Provider number': 2426621B
... identifier 0..1IdentifierProvider at Organisation Identifier
.... type 1..1CodeableConceptNational Provider at Organisation Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NPIO"}
..... text 1..1stringNational Provider at Organisation Identifer Type Descriptive Text
Fixed Value: NPIO
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/npio
.... value I1..1stringNPIO Value
inv-npio-0: NPIO length is exactly 33 characters
... identifier 0..1IdentifierCare Agency Employee Identifier
.... type 1..1CodeableConcept
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"EI"}
..... text 1..1stringFixed Value: Care Agency Employee Identifier
.... system 1..1uriFixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
.... value I1..1stringCAEI Number Value
inv-caei-0: The CAEI shall be an exactly 16 digit number
inv-caei-1: The CAEI SHALL contain a prefix of 900360
inv-caei-2: The CAEI shall pass the Luhn algorithm check
... identifier 0..*IdentifierEmployee Number
.... type 1..1CodeableConcept
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org/fhir/v2/0203","code":"EI"}
..... text 1..1stringFixed Value: Employee Number
.... value 1..1stringEmployee Number Value
.... assigner 1..1Reference(Organization)
..... display 1..1string
... practitioner 0..1Reference(AU Base Practitioner)
... organization 0..1Reference(AU Base Organisation)
... specialty CodeableConceptSlice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptPractitioner Specialty
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations (required)
... location 0..1Reference(Location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*Australian practitioner role at a location
... 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 ΣIdentifierAustralian Practitioner Role Identifiers
Slice: Unordered, Open by value:type, value:system
... identifier Σ0..1IdentifierAustralian provider number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptProvider Number Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingProvider Number Identifier Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}
..... text Σ1..1stringProvider Number Identifier Type Descriptive Text
Fixed Value: Medicare Provider Number
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value Σ1..1stringMedicare Provider Number Value
Example General': 123456
Example Provider number': 2426621B
.... 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..1IdentifierProvider at Organisation Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptNational Provider at Organisation Identifier Type
Binding: v2 Identifier Type - AU Extended (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":"NPIO"}
..... text Σ1..1stringNational Provider at Organisation Identifer Type Descriptive Text
Fixed Value: NPIO
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/npio
.... value ΣI1..1stringNPIO Value
inv-npio-0: NPIO length is exactly 33 characters
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)
... identifier Σ0..1IdentifierCare Agency Employee Identifier
.... 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/fhir/v2/0203","code":"EI"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Care Agency Employee Identifier
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
.... value ΣI1..1stringCAEI Number Value
inv-caei-0: The CAEI shall be an exactly 16 digit number
inv-caei-1: The CAEI SHALL contain a prefix of 900360
inv-caei-2: The CAEI shall pass the Luhn algorithm check
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)
... identifier Σ0..*IdentifierEmployee 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/fhir/v2/0203","code":"EI"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Employee 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..1stringEmployee Number Value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active Σ0..1booleanWhether this practitioner's record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner Σ0..1Reference(AU Base Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(AU Base Organisation)Organization where the roles are available
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty ΣCodeableConceptSpecific specialty of the practitioner
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptPractitioner Specialty
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations (required)
... location Σ0..1Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

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

none defined