GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build International flag

GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions

Logical Model: Verifiable Health Link Payload (DRAFT)

Official URL: https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload Version: 0.1.0
Draft as of 2025-09-04 Computable Name: VerifiableHealthLinkPayload

Verifiable Health Link Payload (DRAFT)

This logical model constrains the Health Link Payload for a Verifiable Health Link

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
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can 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 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 C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'

This structure is derived from HealthLinkPayload

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can be the target of a Reference
... type C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can 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 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 C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'

This structure is derived from HealthLinkPayload

Summary

Mandatory: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can 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 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 C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'

Differential View

This structure is derived from HealthLinkPayload

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can be the target of a Reference
... type C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerifiableHealthLinkPayload 0..* HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can 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 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 C 1..1 code Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerifiableHealthLinkPayload.typepreferredHL_TYPE(a valid code from HL Type CodeSystem)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
From this IG

Constraints

IdGradePath(s)DetailsRequirements
is-a-verifiable-health-linkerrorVerifiableHealthLinkPayload.typeThe Health Link type is is a verifiable health link
: type = 'vhl'

This structure is derived from HealthLinkPayload

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel