NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSD Practitioner Role

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitionerrole | Version: 4.0.1
Draft as of 2017-10-25 | Computable Name: NHSDPractitionerRole
Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved.

A National Health Services Directory (NHSD) Practitioner Role

An extended resource providing additional information on the Practitioner Role not offered by the AU-BASE.

NHSD Provider directory entry for a Practitioner Role describes a practitioner in a role for an organisation at a location.

#### NHSD Practitioner Role Resource

1. Resource definition as per AU-PD and AU-BASE
2. Not supported: period
3. Not supported: telecom (defer to Healthcare Service contact information)
4. Not supported: availableTime (deferred to Healthcare Service availableTime)
5. Not supported: notAvailable (deferred to Healthcare Service notAvailable)
6. Not supported: availabilityExceptions

#### Examples

Practitioner Role Directory Entry Example

Usages:

- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about PractitionerRole resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
Slices for identifier | S Σ | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:medicareProviderNumber | S Σ | 0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role
Slices for extension |  |  |  | Content/Rules for all slices
extension:mpnAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
Slices for extension |  |  |  | Content/Rules for all slices
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | ​Coded identifier type for provider number Binding: http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 (required): Local identifier type Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
identifier:vendorAssignedDirectoryIdentifier | S Σ | 0..* | Identifier | Secure Messaging Vendor's Provider Identifier
Slices for extension |  |  |  | Content/Rules for all slices
extension:vdiAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
Slices for extension |  |  |  | Content/Rules for all slices
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 1..1 | Reference(Organization) | Assigning vendor reference
display | Σ | 1..1 | string | Assigning vendor name
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
active | S Σ | 1..1 | boolean | Required status
practitioner | S Σ | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization | S Σ | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location | S Σ | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService | S | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.identifier:medicareProviderNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:medicareProviderNumber.type | required | Pattern Value: UPIN `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:nationalProviderAtOrganisation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:nationalProviderAtOrganisation.type | required | Pattern Value: NPIO `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:employeeNumber.type | required | Pattern Value: EI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-npio-0 | error | PractitionerRole.identifier:nationalProviderAtOrganisation.value | NPIO length is exactly 33 characters : value.length() = 33 |

This structure is derived from AUPDPractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id |  | 1..1 | id | Logical id of this artifact
meta |  | 1..1 | Meta | Metadata about PractitionerRole resource
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The timestamp when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by
identifier:nationalProviderAtOrganisation |  | 0..0 |  |
identifier:employeeNumber |  | 0..0 |  |
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
period |  | 0..0 |  |
practitioner |  | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization |  | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code |  | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty |  | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location |  | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService |  | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
telecom |  | 0..0 |  |
availableTime |  | 0..0 |  |
notAvailable |  | 0..0 |  |
availabilityExceptions |  | 0..0 |  |
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about PractitionerRole resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
Slices for identifier | S Σ | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:medicareProviderNumber | S Σ | 0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:mpnAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | ​Coded identifier type for provider number Binding: http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 (required): Local identifier type Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
id |  | 0..1 | string | Unique id for inter-element referencing
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:vendorAssignedDirectoryIdentifier | S Σ | 0..* | Identifier | Secure Messaging Vendor's Provider Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:vdiAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Vendor assigned directory identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
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 | Unique id for inter-element referencing
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: Secure Messaging Vendor Identifier Directory Entry
system | Σ | 0..1 | uri | Required vendor assigned identifier system URI Example General: http://www.acme.com/identifiers/patient
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 | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Assigning vendor name
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
active | S Σ | 1..1 | boolean | Required status
practitioner | S Σ | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization | S Σ | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location | S Σ | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService | S | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.identifier:medicareProviderNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:medicareProviderNumber.type | required | Pattern Value: UPIN `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:nationalProviderAtOrganisation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:nationalProviderAtOrganisation.type | required | Pattern Value: NPIO `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:employeeNumber.type | required | Pattern Value: EI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-npio-0 | error | PractitionerRole.identifier:nationalProviderAtOrganisation.value | NPIO length is exactly 33 characters : value.length() = 33 |

This structure is derived from AUPDPractitionerRole

Summary

Mandatory: 5 elements
Must-Support: 2 elements
Prohibited: 19 elements

Structures

This structure refers to these other structures:

- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Practitioner (http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)
- NHSD Location (http://fhir.nhsd.com.au/StructureDefinition/nhsd-location)
- NHSD HealthcareService (http://fhir.nhsd.com.au/StructureDefinition/nhsd-healthcareservice)
- NHSD Secure Messaging Endpoint (http://fhir.nhsd.com.au/StructureDefinition/nhsd-endpoint)

Extensions

This structure refers to these extensions:

- http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication

Slices

This structure defines the following Slices:

- There is a slice with no discriminator at PractitionerRole.identifier

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about PractitionerRole resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
Slices for identifier | S Σ | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:medicareProviderNumber | S Σ | 0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role
Slices for extension |  |  |  | Content/Rules for all slices
extension:mpnAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
Slices for extension |  |  |  | Content/Rules for all slices
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | ​Coded identifier type for provider number Binding: http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 (required): Local identifier type Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
identifier:vendorAssignedDirectoryIdentifier | S Σ | 0..* | Identifier | Secure Messaging Vendor's Provider Identifier
Slices for extension |  |  |  | Content/Rules for all slices
extension:vdiAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
Slices for extension |  |  |  | Content/Rules for all slices
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 1..1 | Reference(Organization) | Assigning vendor reference
display | Σ | 1..1 | string | Assigning vendor name
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
active | S Σ | 1..1 | boolean | Required status
practitioner | S Σ | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization | S Σ | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location | S Σ | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService | S | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.identifier:medicareProviderNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:medicareProviderNumber.type | required | Pattern Value: UPIN `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:nationalProviderAtOrganisation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:nationalProviderAtOrganisation.type | required | Pattern Value: NPIO `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:employeeNumber.type | required | Pattern Value: EI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-npio-0 | error | PractitionerRole.identifier:nationalProviderAtOrganisation.value | NPIO length is exactly 33 characters : value.length() = 33 |

Differential View

This structure is derived from AUPDPractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id |  | 1..1 | id | Logical id of this artifact
meta |  | 1..1 | Meta | Metadata about PractitionerRole resource
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The timestamp when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by
identifier:nationalProviderAtOrganisation |  | 0..0 |  |
identifier:employeeNumber |  | 0..0 |  |
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
period |  | 0..0 |  |
practitioner |  | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization |  | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code |  | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty |  | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location |  | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService |  | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
telecom |  | 0..0 |  |
availableTime |  | 0..0 |  |
notAvailable |  | 0..0 |  |
availabilityExceptions |  | 0..0 |  |
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUPDPractitionerRole | A practitioner in a healthcare role in an Australian healthcare context
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 1..1 | Meta | Metadata about PractitionerRole resource
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:communication |  | 0..* | CodeableConcept | The languages supported by Practitioner Role URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication Binding: Common Languages in Australia (required)
Slices for identifier | S Σ | 0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system
identifier:medicareProviderNumber | S Σ | 0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:mpnAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | ​Coded identifier type for provider number Binding: http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 (required): Local identifier type Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
id |  | 0..1 | string | Unique id for inter-element referencing
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:vendorAssignedDirectoryIdentifier | S Σ | 0..* | Identifier | Secure Messaging Vendor's Provider Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:vdiAssigningAuthority | S | 0..1 | (Complex) | HL7 V2 Assigning Authority URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type Scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
Slices for value[x] |  | 0..1 | string | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString |  | 0..1 | string | Value of extension
url |  | 1..1 | string | identifies the meaning of the extension
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Vendor assigned directory identifier type Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
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 | Unique id for inter-element referencing
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: Secure Messaging Vendor Identifier Directory Entry
system | Σ | 0..1 | uri | Required vendor assigned identifier system URI Example General: http://www.acme.com/identifiers/patient
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 | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Assigning vendor name
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Practitioner role identifiers
active | S Σ | 1..1 | boolean | Required status
practitioner | S Σ | 1..1 | Reference(NHSD Practitioner) | Practitioner in the role
organization | S Σ | 1..1 | Reference(NHSD Organisation) | Organisation providing this role
code | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Role Code Binding: Practitioner Specialties SNOMED-CT (preferred)
specialty | S Σ | 1..* | CodeableConcept | Directory SNOMED-CT Practitioner Specialty Binding: Practitioner Specialties SNOMED-CT (preferred)
location | S Σ | 1..* | Reference(NHSD Location) | Location at which this role is provided
healthcareService | S | 0..* | Reference(NHSD HealthcareService) | Healthcare services provided in this role
endpoint | S | 0..* | Reference(NHSD Secure Messaging Endpoint) | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.identifier:medicareProviderNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:medicareProviderNumber.type | required | Pattern Value: UPIN `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:nationalProviderAtOrganisation.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:nationalProviderAtOrganisation.type | required | Pattern Value: NPIO `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:employeeNumber.type | required | Pattern Value: EI `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203`
PractitionerRole.identifier:employeeNumber.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
PractitionerRole.code | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.specialty | preferred | Practitioner Specialties SNOMED-CT (a valid code from Standard list of Practitioner Specialties (SNOMED)) `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` From this IG
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.div.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-npio-0 | error | PractitionerRole.identifier:nationalProviderAtOrganisation.value | NPIO length is exactly 33 characters : value.length() = 33 |

This structure is derived from AUPDPractitionerRole

Summary

Mandatory: 5 elements
Must-Support: 2 elements
Prohibited: 19 elements

Structures

This structure refers to these other structures:

- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Practitioner (http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)
- NHSD Location (http://fhir.nhsd.com.au/StructureDefinition/nhsd-location)
- NHSD HealthcareService (http://fhir.nhsd.com.au/StructureDefinition/nhsd-healthcareservice)
- NHSD Secure Messaging Endpoint (http://fhir.nhsd.com.au/StructureDefinition/nhsd-endpoint)

Extensions

This structure refers to these extensions:

- http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitioner-role-communication

Slices

This structure defines the following Slices:

- There is a slice with no discriminator at PractitionerRole.identifier

Other representations of profile: CSV, Excel, Schematron

### Notes:

Operation | Format | Example
--- | --- | ---
Read | GET [base]/PractitionerRole/[id] | GET [base]/PractitionerRole/bd9fb7ed-3a80-4951-90a4-cb2ef4e815b7
search | POST [base]/PractitionerRole/_search |

IMPORTANT NOTES ON SEARCH BEHAVIOUR

    NHSD recommends search using POST with for complex search scenarios.

For further information and examples, refer to the capability statement

Read: PractitionerRole

Read identified practitioner role resource content.

    GET [base]/PractitionerRole/[id]

    Example:
    GET [base]/PractitionerRole/fad482ad-be24-4b5c-8262-a40c8b4e23ca

Support:

- Support read PractitionerRole

Implementation Notes:

Search by 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=Jones
    GET [base]/PractitionerRole?practitioner.family=Jones&practitioner.given=David
    GET [base]/PractitionerRole?practitioner.name=Mario

Support:

- Search by Practitioner family, given and name.
- Does not support partial or starts with searches.

Implementation Notes:

Search by Provider Specialty Search based on specialty code.

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

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

Support:

- Search PractitionerRole by specialty.

Implementation Notes:

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|4609743J

Support:

- Support search PractitionerRole by Provider Number.

Implementation Notes:

Search by Healthcare Service Resource Id

Search all the practitioner roles in an healthcare service based on Healthcare Service resource Id.

    GET [base]/PractitionerRole?service={resourceId}

    Example:
    GET [base]/PractitionerRole?service=2badb483-f304-0be7-dde1-89fd2bd8f64e

Support:

- Support search PractitionerRole by Healthcare Service Resource Id.

Implementation Notes:

Search by Practitioner Resource Id

Search all the practitioner roles of a Practitioner using practitioner resource id.

    GET [base]/PractitionerRole?practitioner:Practitioner={resourceId}

    Example:
    GET [base]/PractitionerRole?practitioner:Practitioner=0647db81-219a-0259-982c-7cb944f1604d

Support:

- Support search PractitionerRole by Practitioner Resource Id.

Implementation Notes:

Search by 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=3996
    GET [base]/PractitionerRole?location.address-postalcode=3996,3075
    GET [base]/PractitionerRole?location.address-city=INVERLOCH
    GET [base]/PractitionerRole?location.address-state=VIC

Support:

- Search PractitionerRole by location address parts address-postalcode, address-city, address-state.

Implementation Notes:

Search by Location Distance

Chained search (via Location) for a Practitioner role in locations 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=-37.67481995:145.0154266&location.near-distance=10.0|http://unitsofmeasure.org|m
    GET [base]/PractitionerRole?location.near=-37.67481995:145.0154266&location.near-distance=10.0|http://unitsofmeasure.org|km

Support: Search PractitionerRole by location within a 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:

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?location.address-postalcode=3996&_include=PractitionerRole:service&_include=PractitionerRole:location&_include=PractitionerRole:organization&_include=PractitionerRole:endpoint

Search By characteristic and Include referenced Practitioner resource

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

    Example:
    GET [base]/PractitionerRole?characteristic=http://hl7.org.au/fhir/CodeSystem/service-provision-conditions|FAP&location.near=-37.67481995:145.0154266&location.near-distance=10.0|http://unitsofmeasure.org|m&_include=PractitionerRole:practitioner
    GET [base]/PractitionerRole?characteristic=http://hl7.org.au/fhir/CodeSystem/service-provision-conditions|FAP&location.near=-37.67481995:145.0154266&location.near-distance=10.0|http://unitsofmeasure.org|km&_include=PractitionerRole:practitioner

Search by Combination Search

Search Practitioner Role with practitioner name and locations with in a given distance at which a service is provided.

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

    Example: GET [base]/PractitionerRole?practitioner.name=Brown&location.near=-37.67481995:145.0154266&location.near-distance=10.0|http://unitsofmeasure.org|m

Support:

- Search PractitionerRole using combination of practitioner name, speciality and location.
- Search PractitionerRole using combination of practitioner identifier (PVN), speciality and location.

Search by Healthcare Service identifier

    GET [base]/PractitionerRole?service.identifier=[system]|[code]&_include=PractitionerRole:service

    Example: GET [base]/PractitionerRole?service.identifier=http://fhir.nhsd.com.au/CodeSystem/nhsdIdentifiers#ssid|30000000000&_include=PractitionerRole:service

Search by Healthcare Service name

    GET [base]/PractitionerRole?service.name=[name]&_include=PractitionerRole:service

    Example: GET [base]/PractitionerRole?service.name=Coopers Brewery Original Pale Ale&_include=PractitionerRole:service

Search by Healthcare Service type

    GET [base]/PractitionerRole?service.service-type=[system]|[code]&_include=PractitionerRole:service

    Example: GET [base]/PractitionerRole?service.service-type=nhsd:/reference/taxonomies/snomed-servicetype|700232004&_include=PractitionerRole:service

Search by calendar Search based on Calendar for service open now and open at a specific date and time.

    GET [base]/PractitionerRole?service.openNow=[true]&_include=PractitionerRole:service
    GET [base]/PractitionerRole?service.openAt=[Date (yyyy-MM-dd'T'HH:mm:ssXXX)]
    GET [base]/PractitionerRole?openIn=[Number in minutes]

    Example:
    GET [base]/PractitionerRole?service.openNow=true&_include=PractitionerRole:service
    GET [base]/PractitionerRole?service.openAt=2017-09-16T14:30:00+10:00
    GET [base]/PractitionerRole?service.openIn=30&_include=PractitionerRole:service
    GET [base]/PractitionerRole?service.name=Coopers Brewery Original Pale Ale&service.openAt=2025-12-25T12:00:00+10:00&_include=PractitionerRole:service

Search by Coverage Provides the ability to search Practitioner roles providing healthcare Services in a limited area (the coverage area). The coverage area is normally associated with Phone Line services (Virtual) or Home treatment services (Home Visit).

    Example:
    GET [base]/PractitionerRole?location.physicalType=virtual&service.coverageArea.address-postalcode=2000&_include=PractitionerRole:location&_include=PractitionerRole:service
    GET [base]/PractitionerRole?location.physicalType=home&service.coverageArea.address-postalcode=7000&_include=PractitionerRole:location&_include=PractitionerRole:service
    GET [base]/PractitionerRole?location.physicalType=home&service.coverageArea.address-city=Hobart&service.coverageArea.address-postalcode=7000&_include=PractitionerRole:location&_include=PractitionerRole:service

Search by Healthcare Service characteristic

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

    Example:
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-facility|parkingFree&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://hl7.org.au/fhir/CodeSystem/service-provision-conditions|FAP&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-program|pirPartnersInRecoveryProgram&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-referralInformation|forPublicUse&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-availability|available&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=nhsd:/reference/common/language|es&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-providerLocationServiceCharacteristic|myHealthRecord&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-offering|explanationOfPaymentOptions&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-eligibility|age-olderAdults65&_include=PractitionerRole:service
    GET [base]/PractitionerRole?characteristic=http://fhir.nhsd.com.au/CodeSystem/rc-fundingSource|publicFederal&_include=PractitionerRole:service

Search Practitioner Role by language

    GET [base]/PractitionerRole/_search?languages=[value]

    Example:
    GET [base]/PractitionerRole/_search?languages=nhsd:/reference/common/language/tiw,nhsd:/reference/common/language/en

Search by Practitioner Role by code

    GET [base]/PractitionerRole/_search?code=[value]

    Example:
    GET [base]/PractitionerRole/_search?code=http://snomed.info/sct|11911009

Pagination

- NHSD supports paging using page and _count param to fetch Practitioner Role resources. By default the count is 10.

    GET [base]/PractitionerRole?_format=json&page=1&_count=10

Refer to the capability statement for further details on paging support through Bundle.Links