NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. 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/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Resource Profile: PH PractitionerRole

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-PractitionerRole | Version: 0.1.0
Standards status: Draft | Computable Name: PH_PractitionerRole
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Usages:

- Refer to this Profile: PH Appointment, PH Claim, PH DiagnosticReport, PH Immunization... Show 8 more, PH MedicationAdministration, PH MedicationRequest, PH MedicationStatement, PH Procedure, PH Provenance, PH ServiceRequest, PH Signature and PH Specimen

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
practitioner | Σ | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | Σ | 0..1 | Reference(PH Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | required | Practitioner Role | 📦0.1.0 | This IG

#### Constraints

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

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
lastUpdated |  | 0..1 | instant | When the resource was uploaded to the NHDR.
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
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 0..0 |  | Business Identifiers that are specific to a role/location
active |  | 0..0 |  | Whether this practitioner role record is in active use
period |  | 0..0 |  | The period during which the practitioner is authorized to perform in these role(s)
practitioner |  | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization |  | 0..1 | Reference(PH Organization) | Organization where the roles are available
code |  | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
location |  | 0..0 |  | The location(s) at which this practitioner provides care
healthcareService |  | 0..0 |  | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom |  | 0..0 |  | Contact details that are specific to the role/location/service
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..0 |  | 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.code | Base | required | Practitioner Role | 📦0.1.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource was uploaded to the NHDR.
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
practitioner | Σ | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | Σ | 0..1 | Reference(PH Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.meta.​security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
PractitionerRole.meta.​tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | required | Practitioner Role | 📦0.1.0 | This IG
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.
PractitionerRole.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from PractitionerRole

Summary

Prohibited: 16 elements

Structures

This structure refers to these other structures:

- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
practitioner | Σ | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | Σ | 0..1 | Reference(PH Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | required | Practitioner Role | 📦0.1.0 | This IG

#### Constraints

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

Differential View

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
lastUpdated |  | 0..1 | instant | When the resource was uploaded to the NHDR.
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
extension |  | 0..0 |  | Extension
modifierExtension |  | 0..0 |  | Extension
identifier |  | 0..0 |  | Business Identifiers that are specific to a role/location
active |  | 0..0 |  | Whether this practitioner role record is in active use
period |  | 0..0 |  | The period during which the practitioner is authorized to perform in these role(s)
practitioner |  | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization |  | 0..1 | Reference(PH Organization) | Organization where the roles are available
code |  | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
location |  | 0..0 |  | The location(s) at which this practitioner provides care
healthcareService |  | 0..0 |  | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom |  | 0..0 |  | Contact details that are specific to the role/location/service
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..0 |  | 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.code | Base | required | Practitioner Role | 📦0.1.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hfRecordedDate |  | 0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
extension:hfLastUpdated |  | 0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource was uploaded to the NHDR.
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
practitioner | Σ | 0..1 | Reference(PH Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | Σ | 0..1 | Reference(PH Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (required)
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.meta.​security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
PractitionerRole.meta.​tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | required | Practitioner Role | 📦0.1.0 | This IG
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.
PractitionerRole.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from PractitionerRole

Summary

Prohibited: 16 elements

Structures

This structure refers to these other structures:

- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Other representations of profile: CSV, Excel, Schematron