QI-Core Implementation Guide
7.0.0-ballot - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore PractitionerRole

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole Version: 7.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.

Must Have:
  • telecom.system: (QI) phone | fax | email | pager | url | sms | other
  • telecom.value: (QI) The actual contact point details
QI Elements:
  • identifier: (QI) Business Identifiers that are specific to a role/location
  • identifier.use: (QI) usual | official | temp | secondary | old (If known)
  • identifier.system: (QI) The namespace for the identifier value
  • identifier.value: (QI) The value that is unique
  • active: (QI) Whether this practitioner role record is in active use
  • period: (QI) The period during which the practitioner is authorized to perform in these role(s)
  • practitioner: (QI) Practitioner that is able to provide the defined services for the organization
  • organization: (QI) Organization where the roles are available
  • code: (QI) Roles which this practitioner may perform
  • specialty: (QI) Specific specialty of the practitioner
  • location: (QI) The location(s) at which this practitioner provides care
  • telecom: (QI) Contact details that are specific to the role/location/service
  • endpoint: (QI) Technical endpoints providing access to services operated for the practitioner with this role
Primary code path: code
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

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 USCorePractitionerRoleProfile
... identifier 1..* Identifier (QI) Business Identifiers that are specific to a role/location
.... use 1..1 code (QI) usual | official | temp | secondary | old (If known)
.... system 1..1 uri (QI) The namespace for the identifier value
.... value 1..1 string (QI) The value that is unique
... active 1..1 boolean (QI) Whether this practitioner role record is in active use
... period 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... organization 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code 0..* CodeableConcept (QI) Roles 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 0..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom C 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... system 1..1 code (QI) phone | fax | email | pager | url | sms | other
.... value 1..1 string (QI) The actual contact point details
... endpoint C 0..* Reference(Endpoint) (QI) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier (QI) Business Identifiers that are specific to a role/location
.... use ?!Σ 1..1 code (QI) usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri (QI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (QI) The value that is unique
Example General: 123456
... period Σ 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(QICore Practitioner) (QI) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code SΣ 0..* CodeableConcept (QI) Roles 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..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... system SΣC 1..1 code (QI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (QI) 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.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

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.exists() or endpoint.exists()
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
... 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
... 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 Σ 1..* Identifier (QI) 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 ?!Σ 1..1 code (QI) 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 Σ 1..1 uri (QI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (QI) 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 Σ 1..1 boolean (QI) Whether this practitioner role record is in active use
... period Σ 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(QICore Practitioner) (QI) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code SΣ 0..* CodeableConcept (QI) Roles 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..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (QI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (QI) 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 SC 0..* Reference(Endpoint) (QI) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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.exists() or endpoint.exists()
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole USCorePractitionerRoleProfile
... identifier 1..* Identifier (QI) Business Identifiers that are specific to a role/location
.... use 1..1 code (QI) usual | official | temp | secondary | old (If known)
.... system 1..1 uri (QI) The namespace for the identifier value
.... value 1..1 string (QI) The value that is unique
... active 1..1 boolean (QI) Whether this practitioner role record is in active use
... period 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... organization 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code 0..* CodeableConcept (QI) Roles 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 0..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom C 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... system 1..1 code (QI) phone | fax | email | pager | url | sms | other
.... value 1..1 string (QI) The actual contact point details
... endpoint C 0..* Reference(Endpoint) (QI) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier (QI) Business Identifiers that are specific to a role/location
.... use ?!Σ 1..1 code (QI) usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri (QI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (QI) The value that is unique
Example General: 123456
... period Σ 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(QICore Practitioner) (QI) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code SΣ 0..* CodeableConcept (QI) Roles 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..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... system SΣC 1..1 code (QI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (QI) 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.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

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.exists() or endpoint.exists()
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
pd-1: SHALL have contact information or a reference to an Endpoint
us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
... 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
... 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 Σ 1..* Identifier (QI) 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 ?!Σ 1..1 code (QI) 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 Σ 1..1 uri (QI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (QI) 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 Σ 1..1 boolean (QI) Whether this practitioner role record is in active use
... period Σ 1..1 Period (QI) The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(QICore Practitioner) (QI) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(QICore Organization) (QI) Organization where the roles are available
... code SΣ 0..* CodeableConcept (QI) Roles 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..* CodeableConcept (QI) Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(QICore Location) (QI) The location(s) at which this practitioner provides care
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣC 0..* ContactPoint (QI) Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (QI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string (QI) 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 SC 0..* Reference(Endpoint) (QI) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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.exists() or endpoint.exists()
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

 

Other representations of profile: CSV, Excel, Schematron