| Package | hl7.fhir.uv.smart-health-cards-and-links |
| Type | StructureDefinition |
| Id | ShlPayload |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/smart-health-cards-and-links/https://build.fhir.org/ig/HL7/smart-health-cards-and-links/StructureDefinition-ShlPayload.html |
| URL | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-07-21T13:49:05+00:00 |
| Name | ShlPayload |
| Title | SMART Health Link Payload |
| Realm | uv |
| Authority | hl7 |
| Description | The SMART Health Link Payload object |
| Purpose | 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. |
| Type | http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ShlPayload
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |
| flag | 0..1 | string | Flag indicating link characteristics. Example representing 'Long-term use and requires passcode': LP | |
| 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 | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "ShlPayload",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload",
"version": "1.0.0",
"name": "ShlPayload",
"title": "SMART Health Link Payload",
"status": "active",
"date": "2025-07-21T13:49:05+00:00",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"name": "HL7 International / FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"name": "Frank McKinney",
"telecom": [
{
"system": "email",
"value": "frank.mckinney@pocp.com"
},
{
"system": "email",
"value": "fm@frankmckinney.com"
}
]
}
],
"description": "The SMART Health Link Payload object",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "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.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload",
"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": "ShlPayload",
"path": "ShlPayload",
"short": "SMART Health Link Payload",
"definition": "The SMART Health Link Payload object",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ShlPayload.url",
"path": "ShlPayload.url",
"short": "Manifest URL for the SMART Health Link.",
"definition": "Manifest URL for the SMART Health Link.",
"min": 1,
"max": "1",
"base": {
"path": "ShlPayload.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"example": [
{
"label": "URL\"",
"valueUrl": "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"
}
]
},
{
"id": "ShlPayload.key",
"path": "ShlPayload.key",
"short": "Decryption key",
"definition": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
"min": 1,
"max": "1",
"base": {
"path": "ShlPayload.key",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "key",
"valueString": "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q"
}
]
},
{
"id": "ShlPayload.exp",
"path": "ShlPayload.exp",
"short": "Expiration time",
"definition": "Number representing expiration time in Epoch seconds, as a hint to help the SMART Health Links 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": "ShlPayload.exp",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"example": [
{
"label": "representing January 1, 2026 12:00:00 AM",
"valueString": "1767225600000"
}
]
},
{
"id": "ShlPayload.flag",
"path": "ShlPayload.flag",
"short": "Flag indicating link characteristics.",
"definition": "String created by concatenating single-character flags in alphabetical order. L: long-term use. P: requires a Passcode to resolve. U: url resolves to a single encrypted file (not to be used in combination with P).",
"min": 0,
"max": "1",
"base": {
"path": "ShlPayload.flag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "representing 'Long-term use and requires passcode'",
"valueString": "LP"
}
]
},
{
"id": "ShlPayload.label",
"path": "ShlPayload.label",
"short": "short description of the data behind the SMART Health Link.",
"definition": "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link.",
"min": 0,
"max": "1",
"base": {
"path": "ShlPayload.flag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "label",
"valueString": "Back-to-school immunizations for Oliver Brown"
}
]
},
{
"id": "ShlPayload.v",
"path": "ShlPayload.v",
"short": "Protocol version",
"definition": "SMART Health Links protocol version.",
"min": 0,
"max": "1",
"base": {
"path": "ShlPayload.v",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"example": [
{
"label": "meaning default version",
"valueInteger": 1
}
]
}
]
},
"differential": {
"element": [
{
"id": "ShlPayload",
"path": "ShlPayload",
"short": "SMART Health Link Payload",
"definition": "The SMART Health Link Payload object"
},
{
"id": "ShlPayload.url",
"path": "ShlPayload.url",
"short": "Manifest URL for the SMART Health Link.",
"definition": "Manifest URL for the SMART Health Link.",
"min": 1,
"max": "1",
"type": [
{
"code": "url"
}
],
"example": [
{
"label": "URL\"",
"valueUrl": "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"
}
]
},
{
"id": "ShlPayload.key",
"path": "ShlPayload.key",
"short": "Decryption key",
"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"
}
],
"example": [
{
"label": "key",
"valueString": "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q"
}
]
},
{
"id": "ShlPayload.exp",
"path": "ShlPayload.exp",
"short": "Expiration time",
"definition": "Number representing expiration time in Epoch seconds, as a hint to help the SMART Health Links 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": "decimal"
}
],
"example": [
{
"label": "representing January 1, 2026 12:00:00 AM",
"valueString": "1767225600000"
}
]
},
{
"id": "ShlPayload.flag",
"path": "ShlPayload.flag",
"short": "Flag indicating link characteristics.",
"definition": "String created by concatenating single-character flags in alphabetical order. L: long-term use. P: requires a Passcode to resolve. U: url resolves to a single encrypted file (not to be used in combination with P).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "representing 'Long-term use and requires passcode'",
"valueString": "LP"
}
]
},
{
"id": "ShlPayload.label",
"path": "ShlPayload.label",
"short": "short description of the data behind the SMART Health Link.",
"definition": "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link.",
"min": 0,
"max": "1",
"base": {
"path": "ShlPayload.flag",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "label",
"valueString": "Back-to-school immunizations for Oliver Brown"
}
]
},
{
"id": "ShlPayload.v",
"path": "ShlPayload.v",
"short": "Protocol version",
"definition": "SMART Health Links protocol version.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"example": [
{
"label": "meaning default version",
"valueInteger": 1
}
]
}
]
}
}