FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)
This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-practitionerrole
Profile of PractitionerRole for use with CPG Implementation Guide
This profile builds on PractitionerRole.
This profile was published on Thu Jun 20 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 7 elements
Must-Support: 6 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | |||
  identifier | S | (Slice Definition) | Slice: Unordered, Open by value:use | |
  officialIdentifier | S | 1..1 | Identifier | |
   use | S | 1..1 | code | Fixed Value: official |
 value | S | 1..1 | string | |
 practitioner | 1..1 | Reference(CPGPractitioner) | ||
 code | S | (Slice Definition) | Slice: Unordered, Open by value:coding.system | |
| persona | S | 1..1 | CodeableConcept | Binding: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona (extensible) |
| Documentation for this format | ||||
| 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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Σ | (Slice Definition) | Business Identifiers that are specific to a role/location Slice: Unordered, Open by value:use | |
| officialIdentifier | SΣ | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
| value | SΣ | 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 | Reference(Organization) | Organization that issued id (may be just text) |
| active | Σ | 0..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 | Reference(CPGPractitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | SΣ | (Slice Definition) | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example) | |
| persona | SΣ | 1..1 | CodeableConcept | Roles which this practitioner may perform Binding: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona (extensible) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred) |
| location | Σ | 0..* | Reference(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 | 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) | |
| 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 | 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..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
Summary
Mandatory: 7 elements
Must-Support: 6 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | |||
| identifier | S | (Slice Definition) | Slice: Unordered, Open by value:use | |
| officialIdentifier | S | 1..1 | Identifier | |
| use | S | 1..1 | code | Fixed Value: official |
| value | S | 1..1 | string | |
| practitioner | 1..1 | Reference(CPGPractitioner) | ||
| code | S | (Slice Definition) | Slice: Unordered, Open by value:coding.system | |
| persona | S | 1..1 | CodeableConcept | Binding: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona (extensible) |
| Documentation for this format | ||||
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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Σ | (Slice Definition) | Business Identifiers that are specific to a role/location Slice: Unordered, Open by value:use | |
| officialIdentifier | SΣ | 1..1 | Identifier | Business Identifiers that are specific to a role/location |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
| value | SΣ | 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 | Reference(Organization) | Organization that issued id (may be just text) |
| active | Σ | 0..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 | Reference(CPGPractitioner) | Practitioner that is able to provide the defined services for the organization |
| organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available |
| code | SΣ | (Slice Definition) | Roles which this practitioner may perform Slice: Unordered, Open by value:coding.system Binding: PractitionerRole (example) | |
| persona | SΣ | 1..1 | CodeableConcept | Roles which this practitioner may perform Binding: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona (extensible) |
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred) |
| location | Σ | 0..* | Reference(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 | 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) | |
| 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 | 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..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| PractitionerRole.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PractitionerRole.identifier:officialIdentifier.use | required | Fixed Value: official |
| PractitionerRole.identifier:officialIdentifier.type | extensible | Identifier Type Codes |
| PractitionerRole.code | example | PractitionerRole |
| PractitionerRole.code:persona | extensible | http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona |
| PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet |
| 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-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 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-6 | PractitionerRole | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| ele-1 | PractitionerRole.availableTime | 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()) |
© HL7.org (Clinical Decision Support WG). hl7.fhir.uv.cpg#0.1.0 based on FHIR v4.0.0 generated 05/08/2019.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change