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/organization-vlei | Version: 3.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: OrganizationVLEI | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.15 | |||||
A verifiable LEI (vLEI) credential attesting the organization's LEI. Carries the content-addressed credential identifier (SAID) and a resolvable source (OOBI / .well-known) for discovery. Verification is cryptographic against the GLEIF chain of trust, not the hosting domain.
Context of Use
This extension may be used on the following element(s)
Organization
Usage info
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:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Organization vLEI | |
  extension |
2..* | Extension | Extension | |
 Slices for extension |
Content/Rules for all slices | |||
   extension:leiCode |
S | 0..1 | Extension | The LEI this vLEI attests (links to Organization.identifier[lei]) |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "leiCode" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:credentialSAID |
S | 1..1 | Extension | Self-Addressing IDentifier (SAID) of the ACDC vLEI credential |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "credentialSAID" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:source |
S | 1..1 | Extension | Resolvable OOBI or .well-known URL for discovery/retrieval of the vLEI |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "source" | |
| value[x] |
0..1 | url | Value of extension | |
| extension:issuer |
S | 0..1 | Extension | Qualified vLEI Issuer (QVI) that issued the credential |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "issuer" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:verificationDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "verificationDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
 extension:status |
S | 0..1 | Extension | Extension |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: vLEI Credential Status Value Set (required) | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/organization-vlei" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:status.value[x] | Base | required | vLEI Credential Status Value Set | 📦3.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 Extension |
0..* | Extension | Organization vLEI | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:leiCode |
S | 0..1 | Extension | The LEI this vLEI attests (links to Organization.identifier[lei]) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "leiCode" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:credentialSAID |
S | 1..1 | Extension | Self-Addressing IDentifier (SAID) of the ACDC vLEI credential |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "credentialSAID" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:source |
S | 1..1 | Extension | Resolvable OOBI or .well-known URL for discovery/retrieval of the vLEI |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "source" | |
| value[x] |
0..1 | url | Value of extension | |
| extension:issuer |
S | 0..1 | Extension | Qualified vLEI Issuer (QVI) that issued the credential |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "issuer" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:verificationDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "verificationDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:status |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: vLEI Credential Status Value Set (required) | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/organization-vlei" | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:status.value[x] | Base | required | vLEI Credential Status Value Set | 📦3.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
Summary
Complex Extension: A verifiable LEI (vLEI) credential attesting the organization's LEI. Carries the content-addressed credential identifier (SAID) and a resolvable source (OOBI / .well-known) for discovery. Verification is cryptographic against the GLEIF chain of trust, not the hosting domain.
Maturity: 2
Differential ViewDifferential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Organization vLEI | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:leiCode |
S | 0..1 | Extension | The LEI this vLEI attests (links to Organization.identifier[lei]) |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "leiCode" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:credentialSAID |
S | 1..1 | Extension | Self-Addressing IDentifier (SAID) of the ACDC vLEI credential |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "credentialSAID" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:source |
S | 1..1 | Extension | Resolvable OOBI or .well-known URL for discovery/retrieval of the vLEI |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "source" | |
| value[x] |
0..1 | url | Value of extension | |
| extension:issuer |
S | 0..1 | Extension | Qualified vLEI Issuer (QVI) that issued the credential |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "issuer" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:verificationDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "verificationDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:status |
S | 0..1 | Extension | Extension |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: vLEI Credential Status Value Set (required) | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/organization-vlei" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:status.value[x] | Base | required | vLEI Credential Status Value Set | 📦3.0.0-current | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Organization vLEI | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:leiCode |
S | 0..1 | Extension | The LEI this vLEI attests (links to Organization.identifier[lei]) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "leiCode" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:credentialSAID |
S | 1..1 | Extension | Self-Addressing IDentifier (SAID) of the ACDC vLEI credential |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "credentialSAID" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:source |
S | 1..1 | Extension | Resolvable OOBI or .well-known URL for discovery/retrieval of the vLEI |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "source" | |
| value[x] |
0..1 | url | Value of extension | |
| extension:issuer |
S | 0..1 | Extension | Qualified vLEI Issuer (QVI) that issued the credential |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "issuer" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:verificationDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "verificationDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:status |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | code | Value of extension Binding: vLEI Credential Status Value Set (required) | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/identity-matching/StructureDefinition/organization-vlei" | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:status.value[x] | Base | required | vLEI Credential Status Value Set | 📦3.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
Summary
Complex Extension: A verifiable LEI (vLEI) credential attesting the organization's LEI. Carries the content-addressed credential identifier (SAID) and a resolvable source (OOBI / .well-known) for discovery. Verification is cryptographic against the GLEIF chain of trust, not the hosting domain.
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-08-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change