Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
AU Base Practitioner Role Profile [FMM Level 3]
This profile defines a practitioner role administration details structure that includes core localisation concepts for use in an Australian context.
These definitions represent common data held in the PractitionerRole.identifier element:
Examples
Practitioner Role with Provider Number and SNOMED-CT coded specialty
Radiologist with ABN-scoped employee number
Pathologist with ABN-scoped employee number
General Practitioner with Medicare Provider Number
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-practitionerrole
This profile defines a practitioner role administration details structure that includes core localisation concepts for use in an Australian context.
This profile builds on PractitionerRole.
This profile was published on Sat Mar 11 17:30:54 AEDT 2017 as a active by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | PractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |
  identifier | 0..* | (Slice Definition) | Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system | |
   identifier:medicareProviderNumber | 0..* | Identifier | Australian Medicare Provider Number | |
   type | 1..1 | CodeableConcept | Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN | |
| text | 0..1 | string | 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 Medicare provider number: 2426621B | |
| identifier:nationalProviderAtOrganisation | 0..* | Identifier | National Provider at Organisation Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPIO | |
| text | 0..1 | string | Fixed Value: NPIO | |
| system | 1..1 | uri | Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio | |
| value | I | 1..1 | string | National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters |
 identifier:employeeNumber | 0..* | Identifier | Employee Number | |
 type | 1..1 | CodeableConcept | Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| text | 1..1 | string | Fixed Value: Employee Number | |
| system | 1..1 | uri | ||
| value | 1..1 | string | Employee number | |
| assigner | 1..1 | Reference(Organization) | Employing organisation | |
| display | 1..1 | string | Employing organisation name | |
| specialty | 0..* | CodeableConcept | Practitioner specialties Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | I | 0..* | PractitionerRole | A practitioner in a healthcare role in an Australian healthcare context |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | (Slice Definition) | Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system |
| identifier:medicareProviderNumber | Σ | 0..* | Identifier | Australian Medicare Provider Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Medicare Provider Number |
| system | Σ | 1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number |
| value | Σ | 1..1 | string | Medicare provider number Example General: 123456 Example Medicare provider number: 2426621B |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:nationalProviderAtOrganisation | Σ | 0..* | Identifier | National Provider at Organisation Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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: NPIO | |
| 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: NPIO |
| system | Σ | 1..1 | uri | Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio |
| value | ΣI | 1..1 | string | National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:employeeNumber | Σ | 0..* | Identifier | Employee Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: EI | |
| 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Employee Number |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Employing organisation name |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organation |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Practitioner specialties Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) |
| location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care |
| healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable | I | 0..* | BackboneElement | Not available during this time due to provided reason |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| description | 1..1 | string | Reason presented to the user explaining why time not available | |
| during | 0..1 | Period | Service not availablefrom this date | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | A practitioner in a healthcare role in an Australian healthcare context | |
| identifier | 0..* | (Slice Definition) | Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system | |
| identifier:medicareProviderNumber | 0..* | Identifier | Australian Medicare Provider Number | |
| type | 1..1 | CodeableConcept | Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: UPIN | |
| text | 0..1 | string | 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 Medicare provider number: 2426621B | |
| identifier:nationalProviderAtOrganisation | 0..* | Identifier | National Provider at Organisation Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPIO | |
| text | 0..1 | string | Fixed Value: NPIO | |
| system | 1..1 | uri | Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio | |
| value | I | 1..1 | string | National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters |
| identifier:employeeNumber | 0..* | Identifier | Employee Number | |
| type | 1..1 | CodeableConcept | Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| text | 1..1 | string | Fixed Value: Employee Number | |
| system | 1..1 | uri | ||
| value | 1..1 | string | Employee number | |
| assigner | 1..1 | Reference(Organization) | Employing organisation | |
| display | 1..1 | string | Employing organisation name | |
| specialty | 0..* | CodeableConcept | Practitioner specialties Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | I | 0..* | PractitionerRole | A practitioner in a healthcare role in an Australian healthcare context |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | (Slice Definition) | Practitioner role identifiers Slice: Unordered, Open by pattern:type, value:system |
| identifier:medicareProviderNumber | Σ | 0..* | Identifier | Australian Medicare Provider Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for provider number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: Medicare Provider Number |
| system | Σ | 1..1 | uri | Namespace for Medicare provider number Fixed Value: http://ns.electronichealth.net.au/id/medicare-provider-number |
| value | Σ | 1..1 | string | Medicare provider number Example General: 123456 Example Medicare provider number: 2426621B |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:nationalProviderAtOrganisation | Σ | 0..* | Identifier | National Provider at Organisation Identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for national provider identifier at organisation Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/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: NPIO | |
| 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: NPIO |
| system | Σ | 1..1 | uri | Namespace for national provider identifier (HPI-I) at organisation with national identifier (HPI-O) Fixed Value: http://hl7.org.au/id/npio |
| value | ΣI | 1..1 | string | National provider identifier at organisation in the form HPI-I@HPI-O inv-npio-0: NPIO length is exactly 33 characters Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:employeeNumber | Σ | 0..* | Identifier | Employee Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for employee number Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/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: EI | |
| 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Employee Number |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Employing organisation name |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner | Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organation |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
| specialty | Σ | 0..* | CodeableConcept | Practitioner specialties Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) |
| location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care |
| healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable | I | 0..* | BackboneElement | Not available during this time due to provided reason |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| description | 1..1 | string | Reason presented to the user explaining why time not available | |
| during | 0..1 | Period | Service not availablefrom this date | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-practitionerrole
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
