WHO SMART Trust
1.1.6 - CI Build

WHO SMART Trust, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust/tree/VHLPayload and changes regularly. See the Directory of published versions

## Logical Model: Health Link Payload (DRAFT)

Official URL: http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload | Version: 1.1.6
Draft as of 2025-02-21 | Computable Name: HealthLinkPayload

Health Link Payload (DRAFT)

A Health Link URI is generated from this payload according to the algorithm documented here

Usage:

- Derived from this Logical Model Profile: SMART Health Link Payload (DRAFT) and Verifiable Health Link Payload (DRAFT)

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

This structure is derived from Base

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

Differential View

This structure is derived from Base

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthLinkPayload |  | 0..* | Base | Health Link Payload (DRAFT)
url |  | 1..1 | string | url
key |  | 1..1 | string | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
exp |  | 0..1 | string | Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
flag |  | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. </ul>
label |  | 0..1 | string | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
v |  | 0..1 | string | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
type |  | 0..1 | code | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Other representations of profile: CSV, Excel