HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole | Version: 1.0.0 | |||
Draft as of 2024-08-12 | Computable Name: NzPractitionerRole |
PractitionerRole resource for use in NZ
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization where the roles are available | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from PractitionerRole
Differential View
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization where the roles are available | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Times the Service Site is available | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from PractitionerRole
Other representations of profile: CSV, Excel, Schematron