Verifiable Health Links
1.0.0-comment - ballot
Verifiable Health Links, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.0-comment built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.VHL/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/VHL/StructureDefinition/VHLPayload | Version: 1.0.0-comment | |||
| Active as of 2026-11-13 | Computable Name: VHLPayload | |||
The payload carried by a Verifiable Health Link.
This model specializes the SMART Health Link Payload.
Two things distinguish this model from its parent: the U flag is not used, and extension.fhirBaseUrl is defined for the Sign Manifest Request Option (OAuth with SSRAA). See Generate VHL [ITI-YY3] for the construction steps.
Carriers. This model defines the payload's fields, not its serialization, and the two carriers in this profile encode it differently:
exp and v are integers. The map is the payload; it is neither base64url-encoded nor prefixed. Claim key 5 identifies the content as a VHL, so no type discriminator is carried in the payload. A vhlink:/ string at claim key 5, as earlier drafts specified, SHOULD still be accepted on decode.vhlink:/ to form the credentialSubject.id URI, because a JSON-LD id cannot be a map.The WHO SMART Trust HCERT specification types claim key 5 against this model; see WorldHealthOrganization/smart-trust#130.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m | |
![]() ![]() |
1..1 | string | Decryption key Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q | |
![]() ![]() |
0..1 | decimal | Expiration time Example representing January 1, 2026 12:00:00 AM: 1767225600000 | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. Example representing 'Long-term use and requires passcode': LP | |
![]() ![]() |
0..1 | string | short description of the data behind the SMART Health Link. Example label: Back-to-school immunizations for Oliver Brown | |
![]() ![]() |
0..1 | integer | Protocol version Example meaning default version: 1 | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ShlPayload
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. | |
![]() ![]() |
1..1 | string | Decryption key | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m | |
![]() ![]() |
1..1 | string | Decryption key Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q | |
![]() ![]() |
0..1 | decimal | Expiration time Example representing January 1, 2026 12:00:00 AM: 1767225600000 | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. Example representing 'Long-term use and requires passcode': LP | |
![]() ![]() |
0..1 | string | short description of the data behind the SMART Health Link. Example label: Back-to-school immunizations for Oliver Brown | |
![]() ![]() |
0..1 | integer | Protocol version Example meaning default version: 1 | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ShlPayload
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m | |
![]() ![]() |
1..1 | string | Decryption key Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q | |
![]() ![]() |
0..1 | decimal | Expiration time Example representing January 1, 2026 12:00:00 AM: 1767225600000 | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. Example representing 'Long-term use and requires passcode': LP | |
![]() ![]() |
0..1 | string | short description of the data behind the SMART Health Link. Example label: Back-to-school immunizations for Oliver Brown | |
![]() ![]() |
0..1 | integer | Protocol version Example meaning default version: 1 | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from ShlPayload
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. | |
![]() ![]() |
1..1 | string | Decryption key | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ShlPayload | VHL Payload Elements defined in Ancestors:url, key, exp, flag, label, v | |
![]() ![]() |
1..1 | url | Manifest URL for the SMART Health Link. Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m | |
![]() ![]() |
1..1 | string | Decryption key Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q | |
![]() ![]() |
0..1 | decimal | Expiration time Example representing January 1, 2026 12:00:00 AM: 1767225600000 | |
![]() ![]() |
0..1 | string | Flag indicating link characteristics. Example representing 'Long-term use and requires passcode': LP | |
![]() ![]() |
0..1 | string | short description of the data behind the SMART Health Link. Example label: Back-to-school immunizations for Oliver Brown | |
![]() ![]() |
0..1 | integer | Protocol version Example meaning default version: 1 | |
![]() ![]() |
0..1 | BackboneElement | Implementation-defined extensions | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | string | FHIR base URL of the VHL Sharer | |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ShlPayload