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

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

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

Australian Practitioner Role

  1. Optional Provider Number
  2. Location reference restricted to maximum of one
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*Roles/organizations the practitioner is associated with
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier 0..1IdentifierAustralian provider number
.... type 1..1CodeableConceptProvider Number Identifier Type
..... coding 0..1CodingProvider Number Identifier Type Code
Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"PRN","display":"Provider number"}
..... 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..1stringExample Provider number': 2426621B
... code CodeableConceptSlice: Unordered, Open At End by value:Coding.system
... code Σ0..1CodeableConceptPractitioner Role
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (required)
... location 0..1Reference(Location)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*Roles/organizations the practitioner is associated with
... 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 ΣIdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open At End by value:system, value:type
... 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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingProvider Number Identifier Type Code

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"PRN","display":"Provider number"}
..... 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..1stringThe value that is unique
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)
... 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(Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code ΣCodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:Coding.system
Binding: PractitionerRole (example)
... code Σ0..1CodeableConceptPractitioner Role
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred)
... 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

Australian Practitioner Role

  1. Optional Provider Number
  2. Location reference restricted to maximum of one

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*Roles/organizations the practitioner is associated with
... identifier IdentifierSlice: Unordered, Open At End by value:system, value:type
... identifier 0..1IdentifierAustralian provider number
.... type 1..1CodeableConceptProvider Number Identifier Type
..... coding 0..1CodingProvider Number Identifier Type Code
Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"PRN","display":"Provider number"}
..... 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..1stringExample Provider number': 2426621B
... code CodeableConceptSlice: Unordered, Open At End by value:Coding.system
... code Σ0..1CodeableConceptPractitioner Role
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (required)
... location 0..1Reference(Location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*Roles/organizations the practitioner is associated with
... 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 ΣIdentifierBusiness Identifiers that are specific to a role/location
Slice: Unordered, Open At End by value:system, value:type
... 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: Identifier Type Codes (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingProvider Number Identifier Type Code

Fixed Value: {"system":"http://hl7.org/fhir/v2/0203","code":"PRN","display":"Provider number"}
..... 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..1stringThe value that is unique
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)
... 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(Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code ΣCodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:Coding.system
Binding: PractitionerRole (example)
... code Σ0..1CodeableConceptPractitioner Role
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Practice Setting Code Value Set (preferred)
... 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