SMART Health Cards and Links IG
1.0.0 - STU 1 International flag

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 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

Logical Model: SMART Health Link Payload

Official URL: http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload Version: 1.0.0
Standards status: Trial-use Maturity Level: 4 Computable Name: ShlPayload

The SMART Health Link Payload object

This is a logical model reflecting the structure of a SMART Health Link (SHL) payload. Its intent is to provide a means for understanding SHL payload content.

Extensibility on SHL payload JSON

The SMART Health Links payload specification enables extensions to its content according to the following:

  • The specification reserves the name, extension, and will never define an element with that name.
  • In addition, property names beginning with an underscore ("_") are reserved for extensions defined by downstream implementation guides or specific implementations.
  • Extension property names SHOULD be kept short due to payload size constraints, especially when SMART Health Links are represented as QR codes.
  • SMART Health Link Receiving Applications SHALL ignore extension properties they do not understand.

Payload examples

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ShlPayload 0..* Base SMART Health Link Payload
... url 1..1 url Manifest URL for the SMART Health Link.
Example URL": https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m
... key 1..1 string Decryption key
Example key: rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q
... exp 0..1 decimal Expiration time
Example representing January 1, 2026 12:00:00 AM: 1767225600000
... label 0..1 string short description of the data behind the SMART Health Link.
Example label: Back-to-school immunizations for Oliver Brown
... v 0..1 integer Protocol version
Example meaning default version: 1

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Maturity: 4

 

Other representations of profile: CSV, Excel