GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build
GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build
GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/trust-phw/StructureDefinition/SMARTHealthLinkPayload | Version: 0.1.0 | |||
| Active as of 2025-09-23 | Computable Name: SMARTHealthLinkPayload | |||
SMART Health Link Payload (DRAFT)
This logical model constrains the Health Link Payload for a SMART Health Link
A SMART Health Link URI is generated from this payload according to the algorithm documented here
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:   |
|---|---|---|---|---|
  SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
  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. | |
| 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. | |
| Documentation for this format | ||||
This structure is derived from HealthLinkPayload
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
| type |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
| 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. | |
| 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. | |
| Documentation for this format | ||||
This structure is derived from HealthLinkPayload
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
| 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. | |
| 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. | |
| Documentation for this format | ||||
Differential View
This structure is derived from HealthLinkPayload
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
| type |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SMARTHealthLinkPayload |
0..* | HealthLinkPayload | Elements defined in Ancestors:url, key, exp, flag, label, v, type SMART Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference | |
| 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. | |
| 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. | |
| Documentation for this format | ||||
This structure is derived from HealthLinkPayload