QI-Core Implementation Guide
6.0.0-ballot - ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore PractitionerRole

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole Version: 6.0.0-ballot
Active as of 2018-08-22 Computable Name: QICorePractitionerRole

Profile of PractitionerRole for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

Examples

PractitionerRole Example

Usage:

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... identifier S1..*IdentifierBusiness Identifiers that are specific to a role/location
.... use S1..1codeusual | official | temp | secondary | old (If known)
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... active S1..1booleanWhether this practitioner role record is in active use
... period S1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... organization S0..1Reference(QICore Organization)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.

... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location S0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SC0..*ContactPointContact details that are specific to the role/location/service
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness Identifiers that are specific to a role/location
.... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC0..1Reference(QICore Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣC0..1Reference(QICore Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣC0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC0..*ContactPointContact details that are specific to the role/location/service
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... 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
... text 0..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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC0..1Reference(QICore Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣC0..1Reference(QICore Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣC0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... 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 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... identifier S1..*IdentifierBusiness Identifiers that are specific to a role/location
.... use S1..1codeusual | official | temp | secondary | old (If known)
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... active S1..1booleanWhether this practitioner role record is in active use
... period S1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... organization S0..1Reference(QICore Organization)Organization where the roles are available
... code S0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.

... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location S0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SC0..*ContactPointContact details that are specific to the role/location/service
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness Identifiers that are specific to a role/location
.... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC0..1Reference(QICore Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣC0..1Reference(QICore Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣC0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC0..*ContactPointContact details that are specific to the role/location/service
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C0..*USCorePractitionerRoleProfileRoles/organizations the practitioner is associated with
... 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
... text 0..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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period SΣ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC0..1Reference(QICore Practitioner)Practitioner that is able to provide the defined services for the organization
... organization SΣC0..1Reference(QICore Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles which this practitioner may perform
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣC0..*Reference(QICore Location)The location(s) at which this practitioner provides care
... healthcareService C0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC0..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... 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 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint SC0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codeextensibleCare Team Member Function
PractitionerRole.specialtyextensibleHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron