This page is part of the Quality Improvement Core Framework (v3.1.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
PractitionerRole Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole
Profile of PractitionerRole for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on PractitionerRole.
This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | I | 0..* | 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: Common Languages (extensible) | |
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 | SΣ | 1..* | Identifier | Business Identifiers that are specific to a role/location |
active | SΣ | 1..1 | boolean | Whether this practitioner's record is in active use |
period | SΣ | 1..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
practitioner | SΣ | 1..1 | Reference(QICore-Practitioner) | Practitioner that is able to provide the defined services for the organation |
organization | SΣ | 1..1 | Reference(QICore-Organization) | Organization where the roles are available |
code | SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
specialty | SΣ | 1..* | CodeableConcept | Specific specialty of the practitioner Binding: Practice Setting Code Value Set (preferred) |
location | SΣ | 1..* | Reference(QICore-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
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | I | 0..* | 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: Common Languages (extensible) | |
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 | SΣ | 1..* | Identifier | Business Identifiers that are specific to a role/location |
active | SΣ | 1..1 | boolean | Whether this practitioner's record is in active use |
period | SΣ | 1..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
practitioner | SΣ | 1..1 | Reference(QICore-Practitioner) | Practitioner that is able to provide the defined services for the organation |
organization | SΣ | 1..1 | Reference(QICore-Organization) | Organization where the roles are available |
code | SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example) |
specialty | SΣ | 1..* | CodeableConcept | Specific specialty of the practitioner Binding: Practice Setting Code Value Set (preferred) |
location | SΣ | 1..* | Reference(QICore-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 |
Path | Name | Conformance | ValueSet |
PractitionerRole.language | Common Languages | extensible | Common Languages |
PractitionerRole.code | PractitionerRole | example | PractitionerRole |
PractitionerRole.specialty | Practice Setting Code Value Set | preferred | Practice Setting Code Value Set |
PractitionerRole.availableTime.daysOfWeek | DaysOfWeek | required | DaysOfWeek |
Id | Path | Details | Requirements |
dom-2 | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | PractitionerRole.availableTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | PractitionerRole.notAvailable | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |