QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)

This page is part of the Quality Improvement Core Framework (v3.2.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

D.4.1 StructureDefinition-qicore-practitionerrole

Examples:

PractitionerRole Example

D.4.1.1 Formal Views of Profile Content

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 US Core PractitionerRole Profile.

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*US Core PractitionerRole Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣ1..1booleanWhether this practitioner's record is in active use
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(QICore-Practitioner)Practitioner that is able to provide the defined services for the organation
... organization SΣ1..1Reference(QICore-Organization)Organization where the roles are available
... code SΣ1..1CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Speciality (NUCC) (extensible)
... specialty SΣ1..1CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... 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 SΣ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*US Core PractitionerRole Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣ1..1booleanWhether this practitioner's record is in active use
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(QICore-Practitioner)Practitioner that is able to provide the defined services for the organation
... organization SΣ1..1Reference(QICore-Organization)Organization where the roles are available
... code SΣ1..1CodeableConceptRoles which this practitioner may perform
Binding: US Core Provider Speciality (NUCC) (extensible)
... specialty SΣ1..1CodeableConceptSpecific specialty of the practitioner
Binding: US Core Provider Speciality (NUCC) (extensible)
... 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 SΣ0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
PractitionerRole.code:codeextensibleUS Core Provider Speciality (NUCC)
PractitionerRole.specialty:specialtyextensibleUS Core Provider Speciality (NUCC)
PractitionerRole.telecom.systemrequiredContactPointSystem

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1PractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4PractitionerRoleIf 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-3PractitionerRoleIf 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()
pd-1PractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
ele-1PractitionerRole.availableTimeAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1PractitionerRole.notAvailableAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())