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.5 StructureDefinition-au-pd-practitionerrole

Australian Practitioner Role Directory Entry Profile

This profile describes a practitioner in role for an organisation at a location.

The Australian profile for practitioner role is for a single location only, this allows as single provider number to be associated with the role.

In the context of provider directories the practitioner role may include references to endpoints that describe channels of communication to the provider in this role.

Examples

Practitioner Role Directory Entry Example

SD.5.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Provider directory entry for a practitioner role

This profile builds on AU Base Practitioner Role.

This profile was published on Fri Jun 09 16:36:38 AEST 2017 as a draft by null.

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

Australian Practitioner Role Directory Entry

  1. Must Support Optional: Provider Number (Identifier)
  2. Must Support Required: Practitioner (Reference)
  3. Must Support Reqiired: Organisation (Reference)
  4. Must Support Required: Specialty (Coding)
  5. Must Support Required: Location (Reference)
  6. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  7. Must Support 0 or more: Endpoint, secure messaging or others (Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*
... identifier S0..1IdentifierMedicare Provider Number
.... type 1..1CodeableConcept
..... coding 1..1Coding
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..1IdentifierPractitioner at Organisation Identifier
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..1IdentifierSecure Messaging Vendor's Provider Identifier
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingVendor Directory Identifier
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"VDI"}
..... text 1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system 1..1uriVendor allocated URL
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value 1..1stringVendor Directory Identifier Value
Example Provider number': 2426621B
.... assigner 1..1Reference(Organization)
..... display 1..1string
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... practitioner S1..1Reference(AU PD Practitioner)Practitioner in the role
... organization S1..1Reference(AU PD Organisation)Organisation providing this role
... specialty S1..*CodeableConcept
... specialty 0..*CodeableConceptPractitioner Role Extended Coding
Binding: Practitioner Role (ANZSCO based) Valueset (required)
... specialty 0..*CodeableConceptSNOMED-CT Healthcare Professional Subset
Binding: Provider Specialties (required)
... location S1..1Reference(AU PD Location)Location at which this role is provided
... telecom S0..*ContactPointContact details for the practitioner in this role.
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Service based communication points

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 SΣ0..1IdentifierMedicare Provider Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... 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 Σ1..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 SΣ0..1IdentifierPractitioner at Organisation Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... 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
... identifier SΣ0..1IdentifierSecure Messaging Vendor's Provider Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingVendor Directory Identifier

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"VDI"}
..... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system Σ1..1uriVendor allocated URL
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value Σ1..1stringVendor Directory Identifier Value
Example General': 123456
Example Provider number': 2426621B
.... 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 SΣ1..1Reference(AU PD Practitioner)Practitioner in the role
... organization SΣ1..1Reference(AU PD Organisation)Organisation providing this role
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty SΣ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)
... specialty Σ0..*CodeableConceptPractitioner Role Extended Coding
Binding: Practitioner Role (ANZSCO based) Valueset (required)
... specialty Σ0..*CodeableConceptSNOMED-CT Healthcare Professional Subset
Binding: Provider Specialties (required)
... location SΣ1..1Reference(AU PD Location)Location at which this role is provided
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details for the practitioner in this role.
... 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 S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Service based communication points

doco Documentation for this format

Australian Practitioner Role Directory Entry

  1. Must Support Optional: Provider Number (Identifier)
  2. Must Support Required: Practitioner (Reference)
  3. Must Support Reqiired: Organisation (Reference)
  4. Must Support Required: Specialty (Coding)
  5. Must Support Required: Location (Reference)
  6. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  7. Must Support 0 or more: Endpoint, secure messaging or others (Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*
... identifier S0..1IdentifierMedicare Provider Number
.... type 1..1CodeableConcept
..... coding 1..1Coding
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..1IdentifierPractitioner at Organisation Identifier
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..1IdentifierSecure Messaging Vendor's Provider Identifier
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingVendor Directory Identifier
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"VDI"}
..... text 1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system 1..1uriVendor allocated URL
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value 1..1stringVendor Directory Identifier Value
Example Provider number': 2426621B
.... assigner 1..1Reference(Organization)
..... display 1..1string
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... practitioner S1..1Reference(AU PD Practitioner)Practitioner in the role
... organization S1..1Reference(AU PD Organisation)Organisation providing this role
... specialty S1..*CodeableConcept
... specialty 0..*CodeableConceptPractitioner Role Extended Coding
Binding: Practitioner Role (ANZSCO based) Valueset (required)
... specialty 0..*CodeableConceptSNOMED-CT Healthcare Professional Subset
Binding: Provider Specialties (required)
... location S1..1Reference(AU PD Location)Location at which this role is provided
... telecom S0..*ContactPointContact details for the practitioner in this role.
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Service based communication points

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 SΣ0..1IdentifierMedicare Provider Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... 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 Σ1..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 SΣ0..1IdentifierPractitioner at Organisation Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority 0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... 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
... identifier SΣ0..1IdentifierSecure Messaging Vendor's Provider Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingVendor Directory Identifier

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"VDI"}
..... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system Σ1..1uriVendor allocated URL
Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
.... value Σ1..1stringVendor Directory Identifier Value
Example General': 123456
Example Provider number': 2426621B
.... 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 SΣ1..1Reference(AU PD Practitioner)Practitioner in the role
... organization SΣ1..1Reference(AU PD Organisation)Organisation providing this role
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty SΣ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)
... specialty Σ0..*CodeableConceptPractitioner Role Extended Coding
Binding: Practitioner Role (ANZSCO based) Valueset (required)
... specialty Σ0..*CodeableConceptSNOMED-CT Healthcare Professional Subset
Binding: Provider Specialties (required)
... location SΣ1..1Reference(AU PD Location)Location at which this role is provided
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣ0..*ContactPointContact details for the practitioner in this role.
... 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 S0..*Reference(AU PD Secure Messaging Endpoint), Reference(Endpoint)Service based communication points

doco Documentation for this format

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

 

SD.5.2 Quick Start

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

Read: PractitionerRole

Read identified practitioner role resource content.

GET [base]/PractitionerRole/[id]

Example: GET [base]/PractitionerRole/1234

Support:

  • MUST support read PractitionerRole

Implementation Notes: [(how to read resource)

Search: Provider Practitioner Name

Chained search (via Practitioner) based on family, given and/or any name.

GET [base]/PractitionerRole?practitioner.family=[string]

GET [base]/PractitionerRole?practitioner.family=[string]&practitioner.given=[string]

GET [base]/PractitionerRole?practitioner.name=[string]

Example:

GET [base]/PractitionerRole?practitioner.family=Smith

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

GET [base]/PractitionerRole?practitioner.name=Smith

Support:

  • MUST support search by Practitioner family, given and name.
  • MUST support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by string)

Search: Provider Specialty

Search based on specialty code.

GET [base]/PractitionerRole?specialty=[system]|[code]

Example: GET [base]/PractitionerRole?specialty=http://snomed.info/sct|17561000

Support:

  • MUST support search PractitionerRole by specialty.

Implementation Notes: (how to search by token)

Search: Organisation of Provider HPI-O

Chained search (via Organisation) based on identifier token.

GET [base]/PractitionerRole?organization.identifier=[system]|[value]

Example: GET [base]/PractitionerRole?organization.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328

Support:

  • MUST support search by HPI-O.

Implementation Notes: (how to search by token)

Search: Provider Practitioner HPI-I

Chained search (via Practitioner) based on identifier token.

GET [base]/PractitionerRole?practitioner.identifier=[system]|[value]

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

Support:

  • MUST support search PractitionerRole by HPI-I.

Implementation Notes: (how to search by token)

Search: Vendor Directory Identifier

Search based on identifier.

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

Example: GET [base]/PractitionerRole?identifier=http://smvendor.com.au/id/provider-id|4412365432

Support:

  • MUST support search PractitionerRole by vendor directory identifier; [system] url will be defined by vendors. Effectively this is a general search for identifier capability.

Implementation Notes: (how to search by token)

Search: Provider Number

Search based on identifier.

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

Example: GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B

Support:

  • MUST support search PractitionerRole by Provider Number.

Implementation Notes: (how to search by token)

Search: National Provider at Organisation Identifier

Search based on identifier.

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

Example: GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/npio|8003610833334085@8003627500000328

Support:

  • MUST support search PractitionerRole by National Provider at Organisation Identifier.

Implementation Notes: (how to search by token)

  • Note NPIO format is [HPI-I]@[HPI-O].

Search: Location Address Parts

Chained search (via Location) based on address parts for postcode, suburb, and state.

GET [base]/PractitionerRole?location.address-postalcode=[postcode]

GET [base]/PractitionerRole?location.address-postalcode=[postcode],[postcode]

GET [base]/PractitionerRole?location.address-postalcode=[postcode],[postcode],[postcode] etc.

GET [base]/PractitionerRole?location.address-city=[suburb]

GET [base]/PractitionerRole?location.address-state=[state]

Example:

GET [base]/PractitionerRole?location.address-postalcode=3101

GET [base]/PractitionerRole?location.address-postalcode=3101,3101

GET [base]/PractitionerRole?location.address-city=Bundaberg

GET [base]/PractitionerRole?location.address-state=VIC

Support:

  • MUST support search PractitionerRole by location address parts address-postalcode, address-city, address-state.
  • MUST support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by string)

Search: Location Distance

Chained search (via Location) for a location within a nominated distance.

GET [base]/PractitionerRole?location.near=[latitude]:[longitude]&location.near-distance=[prefix][value]|[units-system]|[units]

Example: GET [base]/PractitionerRole?location.near==-83.694810:42.256500&location.near-distance=le10.0|http://unitsofmeasure.org|km

Support:

  • SHOULD support search PractitionerRole by location within a distance.
  • SHOULD support: [prefix] fixed ‘le’ is less than or equal to distance [value] is a decimal quantity number [units-system] fixed ‘http://unitsofmeasure.org’ identifies standard distance units are used [units] distance units must support ‘km’ or ‘m’

Implementation Notes: (how to search by token) and (how to search by quantity)

Search: Connection Type (Service Interface)

Chaned search (via Endpoint) based on token for a protocol to be used to connnect to the endpoint.

GET [base]/PractitionerRole?endpoint.connection-type=[system]|[value]

Example: GET [base]/PractitionerRole?endpoint.connection-type=http://hl7.org.au.fhir/ValueSet/au-serviceinterfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010

Support:

  • MUST support search by PractitionerRole by endpoint connection type.

Implementation Notes: (how to search by token)

Search: Payload Type (Service Category)

Chaned search (via Endpoint) based on token for the type of content supported by the endpoint.

GET [base]/PractitionerRole?endpint.payload-type=[system]|[value]

Example: GET [base]/PractitionerRole?endpoint.payload-type=http://hl7.org.au.fhir/ValueSet/valueset-au-endpoint-payload-type|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706

Support:

  • MUST support search PractitionerRole by endpoint payload type.

Implementation Notes: (how to search by token)

Search: Include References

The _include argument allows the automatic inclusion of referenced resources in the response for a search; based on search parameters defined for this resource type.

Example: GET [base]/PractitionerRole?_include=PractitionerRole:organization&_include=PractitionerRole:endpoint&_include=PractitionerRole:location

Support:

  • MUST support _include PractitionerRole references location, organization, endpoint.

Search: Combination

  • Searches MUST be able to be perfomed in a single request using logical AND for criteria. e.g specialty cardiologist in post code 4846