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/VLEI | Version: 3.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: VLEI | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.11 | |||||
An extension to hold the verified LEI (vLEI) indicating that the LEI has been verified and is valid. Note that the vLEI is not further decomposed into the Attachment elements, as pulling these values outside of the vLEI leaves them unprotected. Thus any access to the vLEI elements should go through the proper vLEI validation process and use the values in the then validated vLEI.
Context of Use
This extension may be used on the following element(s)
Identifier
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Extension |
0..* | Extension | vLEI | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI" | |
  value[x] |
1..1 | Attachment | Value of extension | |
 contentType |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/json (extensions allowed) | |
| language |
0..0 | Human language of the content (BCP-47) | ||
| data |
1..1 | base64Binary | Data inline, base64ed | |
| url |
0..1 | url | Uri where the data can be found | |
| size |
0..0 | Number of bytes of content (if url provided) | ||
| hash |
0..0 | Hash of the data (sha-1, base64ed) | ||
| title |
0..0 | Label to display in place of the data | ||
| creation |
0..0 | Date attachment was first created | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 Extension |
0..* | Extension | vLEI | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI" | |
| value[x] |
1..1 | Attachment | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json (extensions allowed) | |
| data |
1..1 | base64Binary | Data inline, base64ed | |
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x].contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Extension
Summary
Simple Extension with the type Attachment: An extension to hold the verified LEI (vLEI) indicating that the LEI has been verified and is valid. Note that the vLEI is not further decomposed into the Attachment elements, as pulling these values outside of the vLEI leaves them unprotected. Thus any access to the vLEI elements should go through the proper vLEI validation process and use the values in the then validated vLEI.
Maturity: 2
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | vLEI | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI" | |
| value[x] |
1..1 | Attachment | Value of extension | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/json (extensions allowed) | |
| language |
0..0 | Human language of the content (BCP-47) | ||
| data |
1..1 | base64Binary | Data inline, base64ed | |
| url |
0..1 | url | Uri where the data can be found | |
| size |
0..0 | Number of bytes of content (if url provided) | ||
| hash |
0..0 | Hash of the data (sha-1, base64ed) | ||
| title |
0..0 | Label to display in place of the data | ||
| creation |
0..0 | Date attachment was first created | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | vLEI | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/VLEI" | |
| value[x] |
1..1 | Attachment | Value of extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json (extensions allowed) | |
| data |
1..1 | base64Binary | Data inline, base64ed | |
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x].contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Extension
Summary
Simple Extension with the type Attachment: An extension to hold the verified LEI (vLEI) indicating that the LEI has been verified and is valid. Note that the vLEI is not further decomposed into the Attachment elements, as pulling these values outside of the vLEI leaves them unprotected. Thus any access to the vLEI elements should go through the proper vLEI validation process and use the values in the then validated vLEI.
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