SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
Resource Profile: HIE PractitionerRole
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/practitionerrole | Version: 0.1.0 | |||
| Active as of 2026-10-20 | Computable Name: HIEPractitionerRole | |||
R4B PractitionerRole for HIE directories, scheduling, and attribution. Emphasizes identifiers, practitioner, organization, role codes, specialties, service locations, telecom, and availability.
Usages:
- Refer to this Profile: HIE MedicationDispense, HIE MedicationRequest, HIE QuestionnaireResponse and HIE ServiceRequest
- Examples for this Profile: PractitionerRole/HIEPractitionerRole-example
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |
 use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
  assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |
| code |
C | 1..* | HIECodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole  (example): The role a person plays representing an organization.Constraints: cc-text-or-code |
| specialty |
C | 1..* | HIECodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. Constraints: cc-text-or-code |
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| notAvailable |
1..* | BackboneElement | Not available during this time due to provided reason | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| PractitionerRole.code | Base | example |
Practitioner role
|
⏿4.0.1 | tx.fhir.org |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | PractitionerRole.identifier.type, PractitionerRole.code, PractitionerRole.specialty | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |
| code |
1..* | HIECodeableConcept | Roles which this practitioner may perform | |
| specialty |
1..* | HIECodeableConcept | Specific specialty of the practitioner | |
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |
| notAvailable |
1..* | BackboneElement | Not available during this time due to provided reason | |
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| 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: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |||||
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |||||
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |||||
| code |
C | 1..* | HIECodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.Constraints: cc-text-or-code | ||||
| specialty |
C | 1..* | HIECodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. Constraints: cc-text-or-code | ||||
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |||||
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |||||
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| 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 |
1..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| PractitionerRole.code | Base | example |
Practitioner role
|
⏿4.0.1 | tx.fhir.org |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | PractitionerRole.identifier.type, PractitionerRole.code, PractitionerRole.specialty | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | PractitionerRole.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PractitionerRole
Summary
Mandatory: 14 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
- HIE ContactPoint (https://nshr.dha.go.ke/fhir/StructureDefinition/contact-point)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |
| code |
C | 1..* | HIECodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.Constraints: cc-text-or-code |
| specialty |
C | 1..* | HIECodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. Constraints: cc-text-or-code |
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| notAvailable |
1..* | BackboneElement | Not available during this time due to provided reason | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| PractitionerRole.code | Base | example |
Practitioner role
|
⏿4.0.1 | tx.fhir.org |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | PractitionerRole.identifier.type, PractitionerRole.code, PractitionerRole.specialty | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |
| code |
1..* | HIECodeableConcept | Roles which this practitioner may perform | |
| specialty |
1..* | HIECodeableConcept | Specific specialty of the practitioner | |
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |
| notAvailable |
1..* | BackboneElement | Not available during this time due to provided reason | |
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| 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: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |||||
| type |
C | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code | ||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this practitioner role record is in active use | |||||
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
| practitioner |
1..1 | HIEReference(HIE Practitioner) | Practitioner that is able to provide the defined services for the organization | |||||
| organization |
1..1 | HIEReference(HIE Organization) | Organization where the roles are available | |||||
| code |
C | 1..* | HIECodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.Constraints: cc-text-or-code | ||||
| specialty |
C | 1..* | HIECodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. Constraints: cc-text-or-code | ||||
| location |
0..* | HIEReference(Location) | The location(s) at which this practitioner provides care | |||||
| healthcareService |
1..* | HIEReference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
| telecom |
1..* | HIEContactPoint | Contact details that are specific to the role/location/service | |||||
| availableTime |
1..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| 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 |
1..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | HIEReference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| PractitionerRole.code | Base | example |
Practitioner role
|
⏿4.0.1 | tx.fhir.org |
| PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.3.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| cc-text-or-code | warning | PractitionerRole.identifier.type, PractitionerRole.code, PractitionerRole.specialty | Text is optional, coding is required |
coding.exists()
|
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | PractitionerRole.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PractitionerRole
Summary
Mandatory: 14 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
- HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
- HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
- HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
- HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)
- HIE ContactPoint (https://nshr.dha.go.ke/fhir/StructureDefinition/contact-point)
Other representations of profile: CSV, Excel, Schematron