WHO SMART Trust
1.1.4 - CI Build International flag

This page is part of the Trust (v1.1.4: Release) 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

Logical Model: Smart Health Link Payload (DRAFT)

Official URL: http://smart.who.int/trust/StructureDefinition/SmartHealthLinkPayload Version: 1.1.4
Draft as of 2024-11-04 Computable Name: SmartHealthLinkPayload

Smart Health Link Payload (DRAFT)

This logical model was taken from the SMART Health Link documentation https://docs.smarthealthit.org/smart-health-links/spec#construct-a-shlink-payload as if 30 November 2023.

A [[ SMART Health Link]] is generated from this payload according to the algorithm documented here https://docs.smarthealthit.org/smart-health-links/spec#example-shlink-generation to create a

It is generated

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SmartHealthLinkPayload 0..* Base Smart Health Link Payload (DRAFT)
Instances of this logical model are not marked to 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 SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
... label 0..1 string Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink.
... v 0..1 string Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies.

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel