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: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile 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
... Slices for identifier Σ 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI Business Identifiers that are specific to a role/location
... practitioner SΣC 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Core Organization Profile) Organization where the roles are available
... code SΣ 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.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 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.
... 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.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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
... Slices for identifier 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei S 1..* LEI Business Identifiers that are specific to a role/location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for identifier Σ 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Core Organization Profile) Organization where the roles are available
... code SΣ 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.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(Location) 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 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 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 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.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

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: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile 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
... Slices for identifier Σ 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI Business Identifiers that are specific to a role/location
... practitioner SΣC 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Core Organization Profile) Organization where the roles are available
... code SΣ 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.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 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.
... 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.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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile Roles/organizations the practitioner is associated with
... Slices for identifier 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei S 1..* LEI Business Identifiers that are specific to a role/location

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for identifier Σ 1..* Identifier Business Identifiers that are specific to a role/location
Slice: Unordered, Open by profile:$this
.... identifier:lei SΣ 1..* LEI Business Identifiers that are specific to a role/location
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(US Core Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(US Core Organization Profile) Organization where the roles are available
... code SΣ 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.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣC 0..* Reference(Location) 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 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 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 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.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

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