Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3 United States of America flag

Interoperable Digital Identity and Patient Matching, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 3.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-identity-matching-ig/ and changes regularly. See the Directory of published versions

Resource Profile: A PractitionerRole resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI)

Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/PractitionerRoleLei Version: 3.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: PractitionerRoleLei
Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.9

A PractitionerRole resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI). This profile is used to represent a practitioner role that has a legal entity identifier, which is typically used for roles that are associated with legal entities in financial transactions. The profile includes an extension for the verified LEI (vLEI) to indicate that the LEI has been verified and is valid.

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: doco
PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
PractitionerRole.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PractitionerRole.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PractitionerRole.Slices for identifier This element is included in summaries. 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI Business Identifiers that are specific to a role/location
PractitionerRole.practitioner This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Organization Profile) Organization where the roles are available
PractitionerRole.code This element must be supported. This element is included in summaries. 0..* CodeableConcept 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.
PractitionerRole.specialty This element must be supported. This element is included in summaries. 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
PractitionerRole.location This element must be supported. This element is included in summaries. C 0..* Reference(Location) The location(s) at which this practitioner provides care
PractitionerRole.telecom This element must be supported. This element is included in summaries. C 0..* ContactPoint Contact details that are specific to the role/location/service
PractitionerRole.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
PractitionerRole.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.endpoint This element must be supported. C 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.code Base extensible Care Team Member Function 📦20190418 VSAC v0.11
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy 📦20190521 VSAC v0.11
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

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PractitionerRole 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
PractitionerRole.Slices for identifier 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. 1..* LEI Business Identifiers that are specific to a role/location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
PractitionerRole.id This element is included in summaries. 0..1 id Logical id of this artifact
PractitionerRole.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PractitionerRole.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PractitionerRole.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
PractitionerRole.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
PractitionerRole.contained 0..* Resource Contained, inline Resources
PractitionerRole.extension 0..* Extension Additional content defined by implementations
PractitionerRole.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PractitionerRole.Slices for identifier This element is included in summaries. 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI Business Identifiers that are specific to a role/location
PractitionerRole.active This element is included in summaries. 0..1 boolean Whether this practitioner role record is in active use
PractitionerRole.period This element is included in summaries. 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
PractitionerRole.practitioner This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Organization Profile) Organization where the roles are available
PractitionerRole.code This element must be supported. This element is included in summaries. 0..* CodeableConcept 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.
PractitionerRole.specialty This element must be supported. This element is included in summaries. 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
PractitionerRole.location This element must be supported. This element is included in summaries. C 0..* Reference(Location) The location(s) at which this practitioner provides care
PractitionerRole.healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom This element must be supported. This element is included in summaries. C 0..* ContactPoint Contact details that are specific to the role/location/service
PractitionerRole.telecom.id 0..1 string Unique id for inter-element referencing
PractitionerRole.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PractitionerRole.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
PractitionerRole.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
PractitionerRole.availableTime 0..* BackboneElement Times the Service Site is available
PractitionerRole.availableTime.id 0..1 string Unique id for inter-element referencing
PractitionerRole.availableTime.extension 0..* Extension Additional content defined by implementations
PractitionerRole.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PractitionerRole.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
PractitionerRole.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
PractitionerRole.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
PractitionerRole.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
PractitionerRole.notAvailable 0..* BackboneElement Not available during this time due to provided reason
PractitionerRole.notAvailable.id 0..1 string Unique id for inter-element referencing
PractitionerRole.notAvailable.extension 0..* Extension Additional content defined by implementations
PractitionerRole.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PractitionerRole.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during 0..1 Period Service not available from this date
PractitionerRole.availabilityExceptions 0..1 string Description of availability exceptions
PractitionerRole.endpoint This element must be supported. C 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.code Base extensible Care Team Member Function 📦20190418 VSAC v0.11
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy 📦20190521 VSAC v0.11
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

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
PractitionerRole.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PractitionerRole.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PractitionerRole.Slices for identifier This element is included in summaries. 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI Business Identifiers that are specific to a role/location
PractitionerRole.practitioner This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Organization Profile) Organization where the roles are available
PractitionerRole.code This element must be supported. This element is included in summaries. 0..* CodeableConcept 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.
PractitionerRole.specialty This element must be supported. This element is included in summaries. 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
PractitionerRole.location This element must be supported. This element is included in summaries. C 0..* Reference(Location) The location(s) at which this practitioner provides care
PractitionerRole.telecom This element must be supported. This element is included in summaries. C 0..* ContactPoint Contact details that are specific to the role/location/service
PractitionerRole.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
PractitionerRole.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.endpoint This element must be supported. C 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.code Base extensible Care Team Member Function 📦20190418 VSAC v0.11
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy 📦20190521 VSAC v0.11
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

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PractitionerRole 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
PractitionerRole.Slices for identifier 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. 1..* LEI Business Identifiers that are specific to a role/location

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
PractitionerRole C 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
Constraints: pd-1, us-core-13
PractitionerRole.id This element is included in summaries. 0..1 id Logical id of this artifact
PractitionerRole.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PractitionerRole.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PractitionerRole.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
PractitionerRole.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
PractitionerRole.contained 0..* Resource Contained, inline Resources
PractitionerRole.extension 0..* Extension Additional content defined by implementations
PractitionerRole.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
PractitionerRole.Slices for identifier This element is included in summaries. 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI Business Identifiers that are specific to a role/location
PractitionerRole.active This element is included in summaries. 0..1 boolean Whether this practitioner role record is in active use
PractitionerRole.period This element is included in summaries. 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
PractitionerRole.practitioner This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization This element must be supported. This element is included in summaries. C 0..1 Reference(US Core Organization Profile) Organization where the roles are available
PractitionerRole.code This element must be supported. This element is included in summaries. 0..* CodeableConcept 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.
PractitionerRole.specialty This element must be supported. This element is included in summaries. 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
PractitionerRole.location This element must be supported. This element is included in summaries. C 0..* Reference(Location) The location(s) at which this practitioner provides care
PractitionerRole.healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom This element must be supported. This element is included in summaries. C 0..* ContactPoint Contact details that are specific to the role/location/service
PractitionerRole.telecom.id 0..1 string Unique id for inter-element referencing
PractitionerRole.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
PractitionerRole.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
PractitionerRole.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
PractitionerRole.availableTime 0..* BackboneElement Times the Service Site is available
PractitionerRole.availableTime.id 0..1 string Unique id for inter-element referencing
PractitionerRole.availableTime.extension 0..* Extension Additional content defined by implementations
PractitionerRole.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PractitionerRole.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
PractitionerRole.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
PractitionerRole.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
PractitionerRole.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
PractitionerRole.notAvailable 0..* BackboneElement Not available during this time due to provided reason
PractitionerRole.notAvailable.id 0..1 string Unique id for inter-element referencing
PractitionerRole.notAvailable.extension 0..* Extension Additional content defined by implementations
PractitionerRole.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
PractitionerRole.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during 0..1 Period Service not available from this date
PractitionerRole.availabilityExceptions 0..1 string Description of availability exceptions
PractitionerRole.endpoint This element must be supported. C 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.code Base extensible Care Team Member Function 📦20190418 VSAC v0.11
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy 📦20190521 VSAC v0.11
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

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 2 elements
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron