NHSD Implementation Guide - Outbound
4.0.1 - active
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
| Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-practitionerrole | Version: 4.0.1 | |||
| Draft as of 2025-12-19 | 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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
 lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  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 |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 identifier:medicareProviderNumber |
0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role | |
  Slices for extension |
Content/Rules for all slices | |||
  extension:mpnAssigningAuthority |
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 | |
 Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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: v2 Identifier Type - AU Extended (required): Local identifier typeRequired Pattern: | |
| text |
0..1 | string | Plain text representation of the concept Fixed Value: Medicare Provider Number (no extensions allowed) | |
| system |
1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number (no extensions allowed) | |
| value |
1..1 | string | Medicare provider number Example General: 123456 Example Medicare provider number: 2426621B | |
| identifier:vendorAssignedDirectoryIdentifier |
0..* | Identifier | Secure Messaging Vendor's Provider Identifier | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vdiAssigningAuthority |
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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| active |
1..1 | boolean | Required status | |
| 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 Role Codes 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 | |
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:medicareProviderNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:medicareProviderNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:nationalProviderAtOrganisation.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:nationalProviderAtOrganisation.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:employeeNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUPDPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| versionId |
0..0 | Version specific identifier | ||
| lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| security |
0..0 | Security Labels applied to this resource | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | Extension | ||
| Slices for identifier |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 identifier:nationalProviderAtOrganisation |
0..0 | National Provider at Organisation Identifier for Directory Entry Practitioner Role | ||
| identifier:employeeNumber |
0..0 | Employee Number | ||
| identifier:rid |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| period |
0..0 | The period during which the practitioner is authorized to perform in these role(s) | ||
| 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 Role Codes SNOMED-CT (preferred) | |
| specialty |
0..0 | Directory SNOMED-CT Practitioner Specialty Binding: http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties (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 | Contact details for the practitioner in this role. | ||
| availableTime |
0..0 | Times the Service Site is available | ||
| notAvailable |
0..0 | Not available during this time due to provided reason | ||
| availabilityExceptions |
0..0 | Description of availability exceptions | ||
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:medicareProviderNumber |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:mpnAssigningAuthority |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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: v2 Identifier Type - AU Extended (required): Local identifier typeRequired Pattern: | |
| 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 (no extensions allowed) | |
| system |
1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number (no extensions allowed) | |
| 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 |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vdiAssigningAuthority |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 (no extensions allowed) | |
| 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 (no extensions allowed) | |
| 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 |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| active |
1..1 | boolean | Required status | |
| 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 Role Codes 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 | |
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:medicareProviderNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:medicareProviderNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:nationalProviderAtOrganisation.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:nationalProviderAtOrganisation.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:employeeNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUPDPractitionerRole
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Prohibited: 20 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:medicareProviderNumber |
0..* | Identifier | Medicare Provider Number for Directory Entry Practitioner Role | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:mpnAssigningAuthority |
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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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: v2 Identifier Type - AU Extended (required): Local identifier typeRequired Pattern: | |
| text |
0..1 | string | Plain text representation of the concept Fixed Value: Medicare Provider Number (no extensions allowed) | |
| system |
1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number (no extensions allowed) | |
| value |
1..1 | string | Medicare provider number Example General: 123456 Example Medicare provider number: 2426621B | |
| identifier:vendorAssignedDirectoryIdentifier |
0..* | Identifier | Secure Messaging Vendor's Provider Identifier | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vdiAssigningAuthority |
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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| active |
1..1 | boolean | Required status | |
| 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 Role Codes 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 | |
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:medicareProviderNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:medicareProviderNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:nationalProviderAtOrganisation.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:nationalProviderAtOrganisation.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:employeeNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from AUPDPractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| versionId |
0..0 | Version specific identifier | ||
| lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| source |
0..0 | Identifies where the resource comes from | ||
| profile |
0..0 | Profiles this resource claims to conform to | ||
| security |
0..0 | Security Labels applied to this resource | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | Extension | ||
| Slices for identifier |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:nationalProviderAtOrganisation |
0..0 | National Provider at Organisation Identifier for Directory Entry Practitioner Role | ||
| identifier:employeeNumber |
0..0 | Employee Number | ||
| identifier:rid |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| period |
0..0 | The period during which the practitioner is authorized to perform in these role(s) | ||
| 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 Role Codes SNOMED-CT (preferred) | |
| specialty |
0..0 | Directory SNOMED-CT Practitioner Specialty Binding: http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties (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 | Contact details for the practitioner in this role. | ||
| availableTime |
0..0 | Times the Service Site is available | ||
| notAvailable |
0..0 | Not available during this time due to provided reason | ||
| availabilityExceptions |
0..0 | Description of availability exceptions | ||
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| lastUpdated |
1..1 | instant | The timestamp when the resource was last updated | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 |
0..* | Identifier | NHSD Practitioner Role identifiers Slice: Unordered, Open by pattern:type, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:medicareProviderNumber |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:mpnAssigningAuthority |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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: v2 Identifier Type - AU Extended (required): Local identifier typeRequired Pattern: | |
| 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 (no extensions allowed) | |
| system |
1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number (no extensions allowed) | |
| 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 |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vdiAssigningAuthority |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 | |
| Slices for value[x] |
Content/Rules for all slices | |||
| 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 (no extensions allowed) | |
| 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 (no extensions allowed) | |
| 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 |
0..1 | NHSDResourceIdentifier | Business Identifiers that are specific to a role/location | |
| active |
1..1 | boolean | Required status | |
| 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 Role Codes 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 | |
| endpoint |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier:medicareProviderNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:medicareProviderNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:nationalProviderAtOrganisation.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:nationalProviderAtOrganisation.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:employeeNumber.type | Base | required |
v2 Identifier Type - AU Extended
|
⏿1.0.2 | tx.hl7.org.au |
| PractitionerRole.identifier:employeeNumber.assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | preferred | Practitioner Role Codes SNOMED-CT | 📦4.0.1 | This IG |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUPDPractitionerRole
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Prohibited: 20 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
| 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:
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:
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:
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:
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:
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:
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:
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.
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 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|adult65Plus&_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
GET [base]/PractitionerRole?_format=json&page=1&_count=10
Refer to the capability statement for further details on paging support through Bundle.Links
IG © 2022+ Healthdirect Australia. Package nhsd.org.au.r4#4.0.1 based on FHIR 4.0.1. Generated 2026-10-26
Links: Table of Contents |
QA Report
| Version History |
