HL7.FHIR.US.QICORE\QICorePractitionerRole

QI-Core Implementation Guide
4.1.0 - release

This page is part of the Quality Improvement Core Framework (v4.1.0: STU 4) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

Resource Profile: QICorePractitionerRole

Defining URL:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole

Version:

4.1.0

Name:

QICorePractitionerRole

Status:

Draft as of 8/22/18

Definition:

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

Publisher:

http://www.hl7.org/Special/committees/cqi/index.cfm

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole

Usage

See the patterns page for implementation and usage patterns.

Examples

PractitionerRole Example

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

This structure is derived from USCorePractitionerRoleProfile

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	USCorePractitionerRoleProfile	Roles/organizations the practitioner is associated with
identifier	S	1..*	Identifier	Business Identifiers that are specific to a role/location
use	S	1..1	code	usual \| official \| temp \| secondary \| old (If known)
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
active	S	1..1	boolean	Whether this practitioner role 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(QICorePractitioner)	Practitioner that is able to provide the defined services for the organization
organization	S	1..1	Reference(QICoreOrganization)	Organization where the roles are available
location	S	0..*	Reference(QICoreLocation)	The location(s) at which this practitioner provides care
Documentation for this format

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	Σ	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: A human language.
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Σ	1..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
Slices for 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): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description 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..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	SΣ	1..1	boolean	Whether this practitioner role 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(QICorePractitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	1..1	Reference(QICoreOrganization)	Organization where the roles are available
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.
location	SΣ	0..*	Reference(QICoreLocation)	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ΣI	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		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): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
availableTime		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): The days of the week.
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		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	SI	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*	USCorePractitionerRoleProfile	Roles/organizations the practitioner is associated with
identifier	Σ	1..*	Identifier	Business Identifiers that are specific to a role/location
use	?!Σ	1..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique
active	Σ	1..1	boolean	Whether this practitioner role record is in active use
period	Σ	1..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	Σ	1..1	Reference(QICorePractitioner)	Practitioner that is able to provide the defined services for the organization
organization	Σ	1..1	Reference(QICoreOrganization)	Organization where the roles are available
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.
location	Σ	0..*	Reference(QICoreLocation)	The location(s) at which this practitioner provides care
telecom	ΣI	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 6 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from USCorePractitionerRoleProfile

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	USCorePractitionerRoleProfile	Roles/organizations the practitioner is associated with
identifier	S	1..*	Identifier	Business Identifiers that are specific to a role/location
use	S	1..1	code	usual \| official \| temp \| secondary \| old (If known)
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
active	S	1..1	boolean	Whether this practitioner role 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(QICorePractitioner)	Practitioner that is able to provide the defined services for the organization
organization	S	1..1	Reference(QICoreOrganization)	Organization where the roles are available
location	S	0..*	Reference(QICoreLocation)	The location(s) at which this practitioner provides care
Documentation for this format

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	Σ	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: A human language.
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Σ	1..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
Slices for 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): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description 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..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	SΣ	1..1	boolean	Whether this practitioner role 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(QICorePractitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	1..1	Reference(QICoreOrganization)	Organization where the roles are available
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Provider Speciality (NUCC) (extensible): Provider specialty codes consist of NUCC Health Care Provider Taxonomy Code Set for providers.
location	SΣ	0..*	Reference(QICoreLocation)	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ΣI	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		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): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
availableTime		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): The days of the week.
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		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	SI	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
PractitionerRole.language	preferred	CommonLanguages Max Binding: AllLanguages
PractitionerRole.identifier.use	required	IdentifierUse
PractitionerRole.identifier.type	extensible	Identifier Type Codes
PractitionerRole.code	extensible	USCoreProviderRoleNucc
PractitionerRole.specialty	extensible	USCoreProviderSpecialityNucc
PractitionerRole.telecom.system	required	ContactPointSystem
PractitionerRole.telecom.use	required	ContactPointUse
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	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	error	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	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint : telecom or endpoint
ele-1	error	PractitionerRole.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.practitioner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.specialty	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.healthcareService	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.telecom.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availableTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availableTime.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.availableTime.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.availableTime.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.availableTime.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.availableTime.daysOfWeek	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availableTime.allDay	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availableTime.availableStartTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availableTime.availableEndTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.notAvailable	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.notAvailable.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.notAvailable.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.notAvailable.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	PractitionerRole.notAvailable.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	PractitionerRole.notAvailable.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.notAvailable.during	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.availabilityExceptions	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	PractitionerRole.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#4.1.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents | QA Report | Version History | Search | | Propose a change