GDHCN Trust Network - Personal Health Wallet
0.1.0 - release
This page is part of the GDHCN Trust Network - Personal Health Wallet (v0.1.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2025-10-07 |
Definitions for the HealthLinkPayload logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. HealthLinkPayload | |
Definition | Health Link Payload (DRAFT) A Health Link URI is generated from this payload according to the algorithm documented here |
Short | Health Link Payload (DRAFT) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HealthLinkPayload.url | |
Definition | Manifest URL for this Health Link |
Short | url |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthLinkPayload.key | |
Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Short | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. HealthLinkPayload.exp | |
Definition | 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.) |
Short | 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.) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. HealthLinkPayload.flag | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. HealthLinkPayload.label | |
Definition | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Short | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. HealthLinkPayload.v | |
Definition | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Short | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthLinkPayload.type | |
Definition | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Short | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
0. HealthLinkPayload | |
Definition | Health Link Payload (DRAFT) A Health Link URI is generated from this payload according to the algorithm documented here |
Short | Health Link Payload (DRAFT) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HealthLinkPayload.url | |
Definition | Manifest URL for this Health Link |
Short | url |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthLinkPayload.key | |
Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Short | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. HealthLinkPayload.exp | |
Definition | 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.) |
Short | 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.) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. HealthLinkPayload.flag | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. HealthLinkPayload.label | |
Definition | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Short | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. HealthLinkPayload.v | |
Definition | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Short | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthLinkPayload.type | |
Definition | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Short | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
0. HealthLinkPayload | |
Definition | Health Link Payload (DRAFT) A Health Link URI is generated from this payload according to the algorithm documented here |
Short | Health Link Payload (DRAFT) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HealthLinkPayload.url | |
Definition | Manifest URL for this Health Link |
Short | url |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthLinkPayload.key | |
Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Short | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. HealthLinkPayload.exp | |
Definition | 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.) |
Short | 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.) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. HealthLinkPayload.flag | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. HealthLinkPayload.label | |
Definition | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Short | Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. HealthLinkPayload.v | |
Definition | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Short | Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthLinkPayload.type | |
Definition | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Short | Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |