Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3
Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3
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
| Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/LEI | Version: 3.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: LEI | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.4 | |||||
An Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI)
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Identifier |
0..* | Identifier | An identifier intended for computation | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
 use |
0..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 | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format 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) | |
 reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 Identifier |
0..* | Identifier | An identifier intended for computation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format |
| 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) | |
| reference |
0..1 | string | Literal reference, Relative, internal or absolute URL | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
| use |
0..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 | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format 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) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| display |
0..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Must-Support: 8 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
| use |
0..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 | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format 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) | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format |
| 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) | |
| reference |
0..1 | string | Literal reference, Relative, internal or absolute URL | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:vlei |
0..* | Attachment | vLEI URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI | |
| use |
0..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 | The namespace for the identifier value Required Pattern: https://www.gleif.org/lei (extensions allowed) | |
| value |
C | 1..1 | string | The value that is unique Constraints: lei-format 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) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| display |
0..1 | string | Text alternative for the resource | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| lei-format | error | Identifier.value | The value of the identifier must be a valid Legal Entity Identifier (LEI) as defined in ISO 17442. The LEI is a 20-character alphanumeric code that uniquely identifies legal entities participating in financial transactions. The vLEI may be used to indicate that the LEI has been verified and is valid. |
value.matches('^[0-9A-Z]{20}$')
|
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Must-Support: 8 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Administration.
Package hl7.fhir.us.identity-matching#3.0.0-current based on FHIR 4.0.1.
Generated
2026-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change