GDHCN Trust Network - Personal Health Wallet
0.1.0 - release International flag

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

Logical Model: Health Link Payload (DRAFT)

Official URL: http://smart.who.int/trust-phw/StructureDefinition/HealthLinkPayload Version: 0.1.0
Active as of 2025-10-07 Computable Name: HealthLinkPayload

Health Link Payload (DRAFT)

A 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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

doco Documentation for this format

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthLinkPayload 0..* Base Health Link Payload (DRAFT)
... 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.)
... 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.
... type 0..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

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