QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. 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 USCorePractitionerRoleProfile.
This profile was published on Wed Aug 22 00:00:00 UTC 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..* | USCorePractitionerRoleProfile | Roles/organizations the practitioner is associated with |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
 identifier:identifier | SΣI | 1..* | Identifier | Business Identifiers that are specific to a role/location |
| active:active | SΣI | 1..1 | boolean | Whether this practitioner role record is in active use |
| period:period | SΣI | 1..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner:practitioner | SΣI | 1..1 | Reference(QICorePractitioner) | Practitioner that is able to provide the defined services for the organization |
| organization:organization | SΣI | 1..1 | Reference(QICoreOrganization) | Organization where the roles are available |
| code:code | SΣI | 1..1 | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible) |
| specialty:specialty | SΣI | 1..1 | CodeableConcept | Specific specialty of the practitioner Binding: US Core Provider Speciality (NUCC) (extensible) |
| location:location | SΣI | 1..* | Reference(QICoreLocation) | The location(s) at which this practitioner provides care |
 healthcareService | I | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom | SΣI | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | SΣI | 1..1 | string | The actual contact point details |
| use | ?!ΣI | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| rank | ΣI | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
 period | ΣI | 0..1 | Period | Time period when the contact point was/is in use |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | I | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| allDay | I | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | I | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | I | 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 | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | I | 1..1 | string | Reason presented to the user explaining why time not available |
| during | I | 0..1 | Period | Service not available from this date |
| availabilityExceptions | I | 0..1 | string | Description of availability exceptions |
| endpoint | SI | 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..* | USCorePractitionerRoleProfile | Roles/organizations the practitioner is associated with |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier:identifier | SΣI | 1..* | Identifier | Business Identifiers that are specific to a role/location |
| active:active | SΣI | 1..1 | boolean | Whether this practitioner role record is in active use |
| period:period | SΣI | 1..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
| practitioner:practitioner | SΣI | 1..1 | Reference(QICorePractitioner) | Practitioner that is able to provide the defined services for the organization |
| organization:organization | SΣI | 1..1 | Reference(QICoreOrganization) | Organization where the roles are available |
| code:code | SΣI | 1..1 | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible) |
| specialty:specialty | SΣI | 1..1 | CodeableConcept | Specific specialty of the practitioner Binding: US Core Provider Speciality (NUCC) (extensible) |
| location:location | SΣI | 1..* | Reference(QICoreLocation) | The location(s) at which this practitioner provides care |
| healthcareService | I | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom | SΣI | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | SΣI | 1..1 | string | The actual contact point details |
| use | ?!ΣI | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| rank | ΣI | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | ΣI | 0..1 | Period | Time period when the contact point was/is in use |
| availableTime | I | 0..* | BackboneElement | Times the Service Site is available |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | I | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| allDay | I | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | I | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | I | 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 | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | I | 1..1 | string | Reason presented to the user explaining why time not available |
| during | I | 0..1 | Period | Service not available from this date |
| availabilityExceptions | I | 0..1 | string | Description of availability exceptions |
| endpoint | SI | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PractitionerRole.code:code | extensible | USCoreProviderRoleNucc |
| PractitionerRole.specialty:specialty | extensible | USCoreProviderSpecialityNucc |
| PractitionerRole.telecom.system | required | ContactPointSystem |
| PractitionerRole.telecom.use | required | ContactPointUse |
| PractitionerRole.availableTime.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-3 | 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 | 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 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| pd-1 | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint | |
| ele-1 | PractitionerRole.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.identifier:identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.active:active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.period:period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.practitioner:practitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.organization:organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.code:code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.specialty:specialty | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.location:location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.healthcareService | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.telecom.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.telecom.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.telecom.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.availableTime.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.availableTime.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.availableTime.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.availableTime.daysOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.allDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.availableStartTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availableTime.availableEndTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.notAvailable.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.notAvailable.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PractitionerRole.notAvailable.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PractitionerRole.notAvailable.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.notAvailable.during | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.availabilityExceptions | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PractitionerRole.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 