| Package | smart.who.int.trust-phw |
| Resource Type | StructureDefinition |
| Id | HealthLinkPayload |
| FHIR Version | R4 |
| Source | http://smart.who.int/trust-phw/https://build.fhir.org/ig/WorldHealthOrganization/smart-trust-phw/StructureDefinition-HealthLinkPayload.html |
| URL | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload |
| Version | 0.1.0 |
| Status | draft |
| Date | 2025-07-08T11:27:10+00:00 |
| Name | HealthLinkPayload |
| Title | Health Link Payload (DRAFT) |
| Realm | uv |
| Authority | who |
| Description | Health Link Payload (DRAFT) A Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri) |
| Type | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload |
| Kind | logical |
| StructureDefinition | |
| SMARTHealthLinkPayload | SMART Health Link Payload (DRAFT) |
| VerifiableHealthLinkPayload | Verifiable Health Link Payload (DRAFT) |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition HealthLinkPayload
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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.) | |
| flag | 0..1 | string | Optional. String created by concatenating single-character flags in alphabetical order: 'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; 'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P. | |
| 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. | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "HealthLinkPayload",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload",
"version": "0.1.0",
"name": "HealthLinkPayload",
"title": "Health Link Payload (DRAFT)",
"status": "draft",
"date": "2025-07-08T11:27:10+00:00",
"publisher": "WHO",
"contact": [
{
"name": "WHO",
"telecom": [
{
"system": "url",
"value": "http://who.int"
}
]
}
],
"description": "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n\n",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "HealthLinkPayload",
"path": "HealthLinkPayload",
"short": "Health Link Payload (DRAFT)",
"definition": "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n\n",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "HealthLinkPayload.url",
"path": "HealthLinkPayload.url",
"short": "url",
"definition": "Manifest URL for this Health Link",
"min": 1,
"max": "1",
"base": {
"path": "HealthLinkPayload.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.key",
"path": "HealthLinkPayload.key",
"short": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
"definition": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
"min": 1,
"max": "1",
"base": {
"path": "HealthLinkPayload.key",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.exp",
"path": "HealthLinkPayload.exp",
"short": "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.)",
"definition": "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.)",
"min": 0,
"max": "1",
"base": {
"path": "HealthLinkPayload.exp",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.flag",
"path": "HealthLinkPayload.flag",
"short": "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ",
"definition": "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.",
"min": 0,
"max": "1",
"base": {
"path": "HealthLinkPayload.flag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.label",
"path": "HealthLinkPayload.label",
"short": "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
"definition": "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
"min": 0,
"max": "1",
"base": {
"path": "HealthLinkPayload.label",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.v",
"path": "HealthLinkPayload.v",
"short": "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
"definition": "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
"min": 0,
"max": "1",
"base": {
"path": "HealthLinkPayload.v",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.type",
"path": "HealthLinkPayload.type",
"short": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.",
"definition": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.",
"min": 0,
"max": "1",
"base": {
"path": "HealthLinkPayload.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
}
]
},
"differential": {
"element": [
{
"id": "HealthLinkPayload",
"path": "HealthLinkPayload",
"short": "Health Link Payload (DRAFT)",
"definition": "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n\n"
},
{
"id": "HealthLinkPayload.url",
"path": "HealthLinkPayload.url",
"short": "url",
"definition": "Manifest URL for this Health Link",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.key",
"path": "HealthLinkPayload.key",
"short": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
"definition": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.exp",
"path": "HealthLinkPayload.exp",
"short": "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.)",
"definition": "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.)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.flag",
"path": "HealthLinkPayload.flag",
"short": "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ",
"definition": "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.label",
"path": "HealthLinkPayload.label",
"short": "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
"definition": "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.v",
"path": "HealthLinkPayload.v",
"short": "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
"definition": "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "HealthLinkPayload.type",
"path": "HealthLinkPayload.type",
"short": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.",
"definition": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
}
]
}
}