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 Person 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/PersonLei Version: 3.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: PersonLei
Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.7

A Person 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 person who has a legal entity identifier, which is typically used for individuals who 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
Person 0..* Person A generic person record
Person.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
Person.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person
Person.active This element is a modifier element. This element is included in summaries. 0..1 boolean This person's record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.id This element is included in summaries. 0..1 id Logical id of this artifact
Person.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Person.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
Person.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Person.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
Person.contained 0..* Resource Contained, inline Resources
Person.extension 0..* Extension Additional content defined by implementations
Person.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person
Person.name This element is included in summaries. 0..* HumanName A name associated with the person
Person.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
Person.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Person.birthDate This element is included in summaries. 0..1 date The date on which the person was born
Person.address 0..* Address One or more addresses for the person
Person.photo 0..1 Attachment Image of the person
Person.managingOrganization This element is included in summaries. 0..1 Reference(Organization) The organization that is the custodian of the person record
Person.active This element is a modifier element. This element is included in summaries. 0..1 boolean This person's record is in active use
Person.link 0..* BackboneElement Link to a resource that concerns the same actual person
Person.link.id 0..1 string Unique id for inter-element referencing
Person.link.extension 0..* Extension Additional content defined by implementations
Person.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Person.link.target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated
Person.link.assurance 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Person

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 Person.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.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
Person.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person
Person.active This element is a modifier element. This element is included in summaries. 0..1 boolean This person's record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.id This element is included in summaries. 0..1 id Logical id of this artifact
Person.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Person.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
Person.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Person.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
Person.contained 0..* Resource Contained, inline Resources
Person.extension 0..* Extension Additional content defined by implementations
Person.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Person.Slices for identifier 1..* Identifier A human identifier for this person
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
Person.Slices for identifier.identifier:lei This element must be supported. 1..* LEI A human identifier for this person
Person.name This element is included in summaries. 0..* HumanName A name associated with the person
Person.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
Person.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Person.birthDate This element is included in summaries. 0..1 date The date on which the person was born
Person.address 0..* Address One or more addresses for the person
Person.photo 0..1 Attachment Image of the person
Person.managingOrganization This element is included in summaries. 0..1 Reference(Organization) The organization that is the custodian of the person record
Person.active This element is a modifier element. This element is included in summaries. 0..1 boolean This person's record is in active use
Person.link 0..* BackboneElement Link to a resource that concerns the same actual person
Person.link.id 0..1 string Unique id for inter-element referencing
Person.link.extension 0..* Extension Additional content defined by implementations
Person.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Person.link.target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated
Person.link.assurance 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Person.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Person.link.assurance Base required IdentityAssuranceLevel 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Person

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 Person.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron