US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.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-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core PractitionerRole

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-practitionerrole Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCorePractitionerRole
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.41

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

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
code Roles which this practitioner may perform Care Team Members: Care Team Member Role
identifier Business Identifiers that are specific to a role/location Care Team Members: Care Team Member Identifier
identifier.system The namespace for the identifier value Care Team Members: Care Team Member Identifier
identifier.value The value that is unique Care Team Members: Care Team Member Identifier
location The location(s) at which this practitioner provides care Care Team Members: Care Team Member Location
practitioner Practitioner that is able to provide the defined services for the organization Care Team Members: Care Team Member Name
specialty Specific specialty of the practitioner Care Team Members: Care Team Member Role
telecom Contact details that are specific to the role/location/service Care Team Members: Care Team Member Telecom
telecom.system phone | fax | email | pager | url | sms | other Care Team Members: Care Team Member Telecom
telecom.value The actual contact point details Care Team Members: Care Team Member Telecom

Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core PractitionerRole Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... 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 (USCDI+ Quality) 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 (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (USCDI+ Quality) The value that is unique
Example General: 123456
... period Σ 1..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(US Quality Core Practitioner) (USCDI+ Quality) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Specific specialty of the practitioner
Binding: US Core Practitioner Role Specialty Codes (extensible)
... location SΣC 0..* Reference(US Quality Core Location) (USCDI+ Quality) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint (USCDI+ Quality) Contact details that are specific to the role/location/service
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) 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) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PractitionerRole.code Base extensible Care Team Member Function . ⏿20240605 tx.fhir.org
PractitionerRole.specialty Base extensible US Core Practitioner Role Specialty Codes 📦9.0.0 US Core v9.0
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
... identifier 1..* Identifier (USCDI+ Quality) Business Identifiers that are specific to a role/location
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) 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)
... organization 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code 0..* CodeableConcept (USCDI+ Quality) Roles which this practitioner may perform
... specialty 0..* CodeableConcept (USCDI+ Quality) Specific specialty of the practitioner
... location 0..* Reference(US Quality Core Location) (USCDI+ Quality) The location(s) at which this practitioner provides care
... telecom 0..* ContactPoint (USCDI+ Quality) Contact details that are specific to the role/location/service
.... system 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
.... value 1..1 string (USCDI+ Quality) The actual contact point details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 (USCDI+ Quality) 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 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 (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (USCDI+ Quality) 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 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 SΣC 0..1 Reference(US Quality Core Practitioner) (USCDI+ Quality) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Specific specialty of the practitioner
Binding: US Core Practitioner Role Specialty Codes (extensible)
... location SΣC 0..* Reference(US Quality Core Location) (USCDI+ Quality) 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 (USCDI+ Quality) 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 (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) 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) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PractitionerRole.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PractitionerRole.code Base extensible Care Team Member Function . ⏿20240605 tx.fhir.org
PractitionerRole.specialty Base extensible US Core Practitioner Role Specialty Codes 📦9.0.0 US Core v9.0
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... 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 (USCDI+ Quality) 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 (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (USCDI+ Quality) The value that is unique
Example General: 123456
... period Σ 1..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(US Quality Core Practitioner) (USCDI+ Quality) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Specific specialty of the practitioner
Binding: US Core Practitioner Role Specialty Codes (extensible)
... location SΣC 0..* Reference(US Quality Core Location) (USCDI+ Quality) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint (USCDI+ Quality) Contact details that are specific to the role/location/service
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) 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) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PractitionerRole.code Base extensible Care Team Member Function . ⏿20240605 tx.fhir.org
PractitionerRole.specialty Base extensible US Core Practitioner Role Specialty Codes 📦9.0.0 US Core v9.0
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
... identifier 1..* Identifier (USCDI+ Quality) Business Identifiers that are specific to a role/location
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) 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)
... organization 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code 0..* CodeableConcept (USCDI+ Quality) Roles which this practitioner may perform
... specialty 0..* CodeableConcept (USCDI+ Quality) Specific specialty of the practitioner
... location 0..* Reference(US Quality Core Location) (USCDI+ Quality) The location(s) at which this practitioner provides care
... telecom 0..* ContactPoint (USCDI+ Quality) Contact details that are specific to the role/location/service
.... system 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
.... value 1..1 string (USCDI+ Quality) The actual contact point details

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(9.0.0) Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 (USCDI+ Quality) 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 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 (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string (USCDI+ Quality) 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 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 SΣC 0..1 Reference(US Quality Core Practitioner) (USCDI+ Quality) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Quality Core Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept (USCDI+ Quality) 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 (USCDI+ Quality) Specific specialty of the practitioner
Binding: US Core Practitioner Role Specialty Codes (extensible)
... location SΣC 0..* Reference(US Quality Core Location) (USCDI+ Quality) 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 (USCDI+ Quality) 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 (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) 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) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PractitionerRole.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PractitionerRole.code Base extensible Care Team Member Function . ⏿20240605 tx.fhir.org
PractitionerRole.specialty Base extensible US Core Practitioner Role Specialty Codes 📦9.0.0 US Core v9.0
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom.exists() or endpoint.exists()
us-core-13 error PractitionerRole SHALL 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

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Core US Quality Core
identifier Mandatory USCDI+ Quality
identifier.use Mandatory
identifier.system Mandatory USCDI+ Quality
identifier.value Mandatory USCDI+ Quality
active Mandatory
period Mandatory
practitioner Must Support USCDI+ Quality
organization Must Support
code Must Support USCDI+ Quality
specialty Must Support USCDI+ Quality
location Must Support USCDI+ Quality
telecom Must Support USCDI+ Quality
telecom.system Mandatory Must Support USCDI+ Quality
telecom.value Mandatory Must Support USCDI+ Quality
notAvailable.description Mandatory
endpoint Must Support

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.