SMART Health Cards and Links IG
1.0.0 - STU 1
SMART Health Cards and Links IG
1.0.0 - STU 1
This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 4 |
Definitions for the ShlPayload logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlPayload | |
| Definition | The SMART Health Link Payload object |
| Short | SMART Health Link Payload |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlPayload.url | |
| Definition | Manifest URL for the SMART Health Link. |
| Short | Manifest URL for the SMART Health Link. |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>URL"</b>:https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m |
| 4. ShlPayload.key | |
| Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
| Short | Decryption key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>key</b>:rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q |
| 6. ShlPayload.exp | |
| Definition | Number representing expiration time in Epoch seconds, as a hint to help the SMART Health Links Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.) |
| Short | Expiration time |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing January 1, 2026 12:00:00 AM</b>:1767225600000 |
| 8. ShlPayload.flag | |
| Definition | String created by concatenating single-character flags in alphabetical order. L: long-term use. P: requires a Passcode to resolve. U: url resolves to a single encrypted file (not to be used in combination with P). |
| Short | Flag indicating link characteristics. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing 'Long-term use and requires passcode'</b>:LP |
| 10. ShlPayload.label | |
| Definition | String no longer than 80 characters that provides a short description of the data behind the SMART Health Link. |
| Short | short description of the data behind the SMART Health Link. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>label</b>:Back-to-school immunizations for Oliver Brown |
| 12. ShlPayload.v | |
| Definition | SMART Health Links protocol version. |
| Short | Protocol version |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>meaning default version</b>:1 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlPayload | |
| Definition | The SMART Health Link Payload object |
| Short | SMART Health Link Payload |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlPayload.url | |
| Definition | Manifest URL for the SMART Health Link. |
| Short | Manifest URL for the SMART Health Link. |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>URL"</b>:https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m |
| 4. ShlPayload.key | |
| Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
| Short | Decryption key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>key</b>:rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q |
| 6. ShlPayload.exp | |
| Definition | Number representing expiration time in Epoch seconds, as a hint to help the SMART Health Links Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.) |
| Short | Expiration time |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing January 1, 2026 12:00:00 AM</b>:1767225600000 |
| 8. ShlPayload.flag | |
| Definition | String created by concatenating single-character flags in alphabetical order. L: long-term use. P: requires a Passcode to resolve. U: url resolves to a single encrypted file (not to be used in combination with P). |
| Short | Flag indicating link characteristics. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing 'Long-term use and requires passcode'</b>:LP |
| 10. ShlPayload.label | |
| Definition | String no longer than 80 characters that provides a short description of the data behind the SMART Health Link. |
| Short | short description of the data behind the SMART Health Link. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>label</b>:Back-to-school immunizations for Oliver Brown |
| 12. ShlPayload.v | |
| Definition | SMART Health Links protocol version. |
| Short | Protocol version |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>meaning default version</b>:1 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ShlPayload | |
| Definition | The SMART Health Link Payload object |
| Short | SMART Health Link Payload |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ShlPayload.url | |
| Definition | Manifest URL for the SMART Health Link. |
| Short | Manifest URL for the SMART Health Link. |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>URL"</b>:https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m |
| 4. ShlPayload.key | |
| Definition | Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded. |
| Short | Decryption key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>key</b>:rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q |
| 6. ShlPayload.exp | |
| Definition | Number representing expiration time in Epoch seconds, as a hint to help the SMART Health Links Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.) |
| Short | Expiration time |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing January 1, 2026 12:00:00 AM</b>:1767225600000 |
| 8. ShlPayload.flag | |
| Definition | String created by concatenating single-character flags in alphabetical order. L: long-term use. P: requires a Passcode to resolve. U: url resolves to a single encrypted file (not to be used in combination with P). |
| Short | Flag indicating link characteristics. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>representing 'Long-term use and requires passcode'</b>:LP |
| 10. ShlPayload.label | |
| Definition | String no longer than 80 characters that provides a short description of the data behind the SMART Health Link. |
| Short | short description of the data behind the SMART Health Link. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>label</b>:Back-to-school immunizations for Oliver Brown |
| 12. ShlPayload.v | |
| Definition | SMART Health Links protocol version. |
| Short | Protocol version |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | <br/><b>meaning default version</b>:1 |
IG © 2024+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.smart-health-cards-and-links#1.0.0 based on FHIR 4.0.1. Generated 2025-07-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change