PD 1 on FHIR STU3

This page is part of the Australian Provider Directory IG (v1.0.0: PD 1 on FHIR STU3) 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.2 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.2.1 Formal Views of Profile Content

The official URL for this profile is:

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

Provider directory entry for a practitioner role

This profile builds on AUBasePractitionerRole.

This profile was published on Tue May 14 00:00:00 AEST 2019 as a draft by null.

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

Text Summary
Differential Table
Snapshot Table
All

Australian Practitioner Role Directory Entry

Must Support Optional: Meta-Source (uri)
Must Support 0 or more: Medicare Provider Number (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support 0 or more: Directroy Entry Practitioner at Organisation (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support 0 or more: Secure Messaging Vendor’s Provider Identifier (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support Required: Active Status (boolean)
Must Support Required: Practitioner (Reference)
Must Support Required: Organisation (Reference)
Must Support 0 or more: Specialties (Coding)
Must Support 1 or more: Location (Reference)
Must Support 0 or more: HealthcareService (Reference)
Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
Must Support 0 or more: Endpoint, secure messaging or others (Reference)

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*
meta		0..1	Meta	Metadata about the resource (extended)
extension		0..*	Extension	Slice: Unordered, Open by value:url
meta-source	S	0..*	uri	Preadopt STU4 Meta.source to identify source system URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
identifier	S	0..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
identifier	S	0..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
identifier	S	0..*	Identifier	Medicare Provider Number
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 routing content URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
type		0..1	CodeableConcept	Required Provider Number Identifier Type
coding		1..*	Coding	Required Provider Number Identifier Type Code
identifier	S	0..*	Identifier	Secure Messaging Vendor's Provider Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
type		0..1	CodeableConcept	Vendor assigned directory identifier type
coding		1..*	Coding	Vendor assigned directory identifier type code
system		0..1	uri	Vendor assigned directory identifier type coding system
code		0..1	code	Fixed Value: VDI
text		1..1	string	Fixed Value: Vendor Directory Identifier Type
system		1..1	uri	Required vendor assigned identifier system URI
assigner		1..1	Reference(Organization)	Assigning vendor reference
display		1..1	string	Assigning vendor name
active	S	1..1	boolean	Required status
practitioner	S	1..1	Reference(AU PD Practitioner)	Practitioner in the role
organization	S	1..1	Reference(AU PD Organisation)	Organisation providing this role
specialty	S	0..*	CodeableConcept	Directory SNOMED-CT Practitioner Specialty
location	S	1..*	Reference(AU PD Location)	Location at which this role is provided
healthcareService	S	0..*	Reference(HealthcareService)	Healthcare services provided in this role
telecom	S	0..*	ContactPoint	Contact details for the practitioner in this role.
endpoint	S	0..*	Reference(AU PD Secure Messaging Endpoint \| Endpoint)	Technical endpoints for this practitioner role, including secure messaging endpoints
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*		A practitioner in a healthcare role in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource (extended)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
meta-source	S	0..*	uri	Preadopt STU4 Meta.source to identify source system URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/meta-source"
valueUri		1..1	uri	Source System URI
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	Σ	0..*	uri	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: Common Tags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier	SΣ	0..*	Identifier	Australian Medicare Provider Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medicare Provider Number
system	Σ	1..1	uri	Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
value	Σ	1..1	string	Medicare provider number Example General': 123456 Example Medicare provider number': 2426621B
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..*	Identifier	National Provider at Organisation Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NPIO"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: NPIO
system	Σ	1..1	uri	Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio
value	ΣI	1..1	string	National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	Σ	0..*	Identifier	Employee Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"EI"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Employee Number
system	Σ	1..1	uri	The 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..1	string	Employee number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Employing organisation
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Employing organisation name
identifier	SΣ	0..*	Identifier	Medicare Provider Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 routing content URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Required Provider Number Identifier Type Binding: Identifier Type Codes (extensible)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Required Provider Number Identifier Type Code
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The 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	Σ	0..1	string	The value that is unique Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..*	Identifier	Secure Messaging Vendor's Provider Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Vendor assigned directory identifier type Binding: Identifier Type Codes (extensible)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Vendor assigned directory identifier type code
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Vendor assigned directory identifier type coding system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: VDI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Vendor Directory Identifier Type
system	Σ	1..1	uri	Required vendor assigned identifier system URI Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	0..1	string	The value that is unique Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Assigning vendor reference
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Assigning vendor name
active	SΣ	1..1	boolean	Required status
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	1..1	Reference(AU PD Practitioner)	Practitioner in the role
organization	SΣ	1..1	Reference(AU PD Organisation)	Organisation providing this role
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example)
specialty	SΣ	0..*	CodeableConcept	Directory SNOMED-CT Practitioner Specialty Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
location	SΣ	1..*	Reference(AU PD Location)	Location at which this role is provided
healthcareService	S	0..*	Reference(HealthcareService)	Healthcare services provided in this role
telecom	SΣ	0..*	ContactPoint	Contact details for the practitioner in this role.
availableTime	I	0..*	BackboneElement	Times the Service Site is available
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
daysOfWeek		0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required)
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	I	0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not availablefrom this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(AU PD Secure Messaging Endpoint \| Endpoint)	Technical endpoints for this practitioner role, including secure messaging endpoints
Documentation for this format

Australian Practitioner Role Directory Entry

Must Support Optional: Meta-Source (uri)
Must Support 0 or more: Medicare Provider Number (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support 0 or more: Directroy Entry Practitioner at Organisation (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support 0 or more: Secure Messaging Vendor’s Provider Identifier (Identifier)
- Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
Must Support Required: Active Status (boolean)
Must Support Required: Practitioner (Reference)
Must Support Required: Organisation (Reference)
Must Support 0 or more: Specialties (Coding)
Must Support 1 or more: Location (Reference)
Must Support 0 or more: HealthcareService (Reference)
Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
Must Support 0 or more: Endpoint, secure messaging or others (Reference)

Differential View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*
meta		0..1	Meta	Metadata about the resource (extended)
extension		0..*	Extension	Slice: Unordered, Open by value:url
meta-source	S	0..*	uri	Preadopt STU4 Meta.source to identify source system URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
identifier	S	0..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
identifier	S	0..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
identifier	S	0..*	Identifier	Medicare Provider Number
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 routing content URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
type		0..1	CodeableConcept	Required Provider Number Identifier Type
coding		1..*	Coding	Required Provider Number Identifier Type Code
identifier	S	0..*	Identifier	Secure Messaging Vendor's Provider Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
type		0..1	CodeableConcept	Vendor assigned directory identifier type
coding		1..*	Coding	Vendor assigned directory identifier type code
system		0..1	uri	Vendor assigned directory identifier type coding system
code		0..1	code	Fixed Value: VDI
text		1..1	string	Fixed Value: Vendor Directory Identifier Type
system		1..1	uri	Required vendor assigned identifier system URI
assigner		1..1	Reference(Organization)	Assigning vendor reference
display		1..1	string	Assigning vendor name
active	S	1..1	boolean	Required status
practitioner	S	1..1	Reference(AU PD Practitioner)	Practitioner in the role
organization	S	1..1	Reference(AU PD Organisation)	Organisation providing this role
specialty	S	0..*	CodeableConcept	Directory SNOMED-CT Practitioner Specialty
location	S	1..*	Reference(AU PD Location)	Location at which this role is provided
healthcareService	S	0..*	Reference(HealthcareService)	Healthcare services provided in this role
telecom	S	0..*	ContactPoint	Contact details for the practitioner in this role.
endpoint	S	0..*	Reference(AU PD Secure Messaging Endpoint \| Endpoint)	Technical endpoints for this practitioner role, including secure messaging endpoints
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*		A practitioner in a healthcare role in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource (extended)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
meta-source	S	0..*	uri	Preadopt STU4 Meta.source to identify source system URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/meta-source"
valueUri		1..1	uri	Source System URI
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	Σ	0..*	uri	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: Common Tags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ		Identifier	Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier	SΣ	0..*	Identifier	Australian Medicare Provider Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"UPIN"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Medicare Provider Number
system	Σ	1..1	uri	Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number
value	Σ	1..1	string	Medicare provider number Example General': 123456 Example Medicare provider number': 2426621B
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..*	Identifier	National Provider at Organisation Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NPIO"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: NPIO
system	Σ	1..1	uri	Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio
value	ΣI	1..1	string	National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	Σ	0..*	Identifier	Employee Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	1..1	CodeableConcept	Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"EI"}]}
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Employee Number
system	Σ	1..1	uri	The 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..1	string	Employee number Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Employing organisation
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Employing organisation name
identifier	SΣ	0..*	Identifier	Medicare Provider Number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 routing content URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Required Provider Number Identifier Type Binding: Identifier Type Codes (extensible)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Required Provider Number Identifier Type Code
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The 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	Σ	0..1	string	The value that is unique Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier	SΣ	0..*	Identifier	Secure Messaging Vendor's Provider Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
au-assigningauthority	S	0..1	(Complex)	Optional HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"namespace-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id"
valueString		0..1	string	Value of extension
extension		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"universal-id-type"
valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Vendor assigned directory identifier type Binding: Identifier Type Codes (extensible)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..*	Coding	Vendor assigned directory identifier type code
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Vendor assigned directory identifier type coding system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: VDI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Plain text representation of the concept Fixed Value: Vendor Directory Identifier Type
system	Σ	1..1	uri	Required vendor assigned identifier system URI Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
value	Σ	0..1	string	The value that is unique Example General': 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Assigning vendor reference
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	ΣI	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Assigning vendor name
active	SΣ	1..1	boolean	Required status
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	1..1	Reference(AU PD Practitioner)	Practitioner in the role
organization	SΣ	1..1	Reference(AU PD Organisation)	Organisation providing this role
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example)
specialty	SΣ	0..*	CodeableConcept	Directory SNOMED-CT Practitioner Specialty Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
location	SΣ	1..*	Reference(AU PD Location)	Location at which this role is provided
healthcareService	S	0..*	Reference(HealthcareService)	Healthcare services provided in this role
telecom	SΣ	0..*	ContactPoint	Contact details for the practitioner in this role.
availableTime	I	0..*	BackboneElement	Times the Service Site is available
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
daysOfWeek		0..*	code	mon \| tue \| wed \| thu \| fri \| sat \| sun Binding: DaysOfWeek (required)
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	I	0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not availablefrom this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(AU PD Secure Messaging Endpoint \| Endpoint)	Technical endpoints for this practitioner role, including secure messaging endpoints
Documentation for this format

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

SD.2.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: Active Status

Search based on active status of the practitioner role record.

GET [base]/PractitionerRole?active=[status]

Example: GET [base]/PractitionerRole?active=true

Support: MUST support search PractitionerRole by active status (true | false).

Implementation Notes: (how to search by token)

Search: Provider Practitioner Name

Chained search (via Practitioner) based on family, given and/or any 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]|[code]

Example: GET [base]/PractitionerRole?endpoint.connection-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|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?endpoint.payload-type=[system]|[code]

Example: GET [base]/PractitionerRole?endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|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:practitioner&_include=PractitionerRole:organization&_include=PractitionerRole:endpoint&_include=PractitionerRole:location

Support:

MUST support _include PractitionerRole references practitioner (Practitioner), location (Location), organization (Organization), endpoint (Endpoint), service (HealthcareService).

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