This page is part of the SMART Health Cards and Links FHIR IG (v1.0.0: STU1) 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
Page standards status: Trial-use | Maturity Level: 4 |
TTL representation of the ShlPayload logical model.
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- a fhir:StructureDefinition ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "ShlPayload"] ; # fhir:text [ fhir:status [ fhir:v "extensions" ] ; fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition ShlPayload</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload\" title=\"The SMART Health Link Payload object\">ShlPayload</a><a name=\"ShlPayload\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/types.html#Base\">Base</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">SMART Health Link Payload</td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.url\" title=\"Manifest URL for the SMART Health Link.\">url</a><a name=\"ShlPayload.url\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#url\">url</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Manifest URL for the SMART Health Link.<br/><span style=\"font-weight:bold\">Example URL\": </span><span style=\"color: darkgreen\">https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m</span></td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.key\" title=\"Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.\">key</a><a name=\"ShlPayload.key\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Decryption key<br/><span style=\"font-weight:bold\">Example key: </span><span style=\"color: darkgreen\">rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q</span></td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.exp\" title=\"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.)\">exp</a><a name=\"ShlPayload.exp\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#decimal\">decimal</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Expiration time<br/><span style=\"font-weight:bold\">Example representing January 1, 2026 12:00:00 AM: </span><span style=\"color: darkgreen\">1767225600000</span></td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.flag\" title=\"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).\">flag</a><a name=\"ShlPayload.flag\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Flag indicating link characteristics.<br/><span style=\"font-weight:bold\">Example representing 'Long-term use and requires passcode': </span><span style=\"color: darkgreen\">LP</span></td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.label\" title=\"String no longer than 80 characters that provides a short description of the data behind the SMART Health Link.\">label</a><a name=\"ShlPayload.label\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">short description of the data behind the SMART Health Link.<br/><span style=\"font-weight:bold\">Example label: </span><span style=\"color: darkgreen\">Back-to-school immunizations for Oliver Brown</span></td></tr>#xD;\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ShlPayload-definitions.html#ShlPayload.v\" title=\"SMART Health Links protocol version.\">v</a><a name=\"ShlPayload.v\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Protocol version<br/><span style=\"font-weight:bold\">Example meaning default version: </span><span style=\"color: darkgreen\">1</span></td></tr>#xD;\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"^^rdf:XMLLiteral ] ; # fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ; fhir:value [ a fhir:code ; fhir:v "fhir" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ; fhir:value [ a fhir:integer ; fhir:v 4 ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ; fhir:value [ a fhir:canonical ; fhir:v "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links> ] ] ) ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ; fhir:value [ a fhir:code ; fhir:v "trial-use" ; ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ; fhir:value [ a fhir:canonical ; fhir:v "http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/uv/smart-health-cards-and-links/ImplementationGuide/hl7.fhir.uv.smart-health-cards-and-links> ] ] ) ] ] ) ; # fhir:url [ fhir:v "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload"^^xsd:anyURI] ; # fhir:version [ fhir:v "1.0.0"] ; # fhir:name [ fhir:v "ShlPayload"] ; # fhir:title [ fhir:v "SMART Health Link Payload"] ; # fhir:status [ fhir:v "active"] ; # fhir:date [ fhir:v "2025-07-22T13:23:29+00:00"^^xsd:dateTime] ; # fhir:publisher [ fhir:v "HL7 International / FHIR Infrastructure"] ; # fhir:contact ( [ fhir:name [ fhir:v "HL7 International / FHIR Infrastructure" ] ; ( fhir:telecom [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ] ] ) ] [ fhir:name [ fhir:v "Frank McKinney" ] ; ( fhir:telecom [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "frank.mckinney@pocp.com" ] ] [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "fm@frankmckinney.com" ] ] ) ] ) ; # fhir:description [ fhir:v "The SMART Health Link Payload object"] ; # fhir:jurisdiction ( [ ( fhir:coding [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] ) ; # fhir:purpose [ fhir:v "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."] ; # fhir:fhirVersion [ fhir:v "4.0.1"] ; # fhir:kind [ fhir:v "logical"] ; # fhir:abstract [ fhir:v false] ; # fhir:type [ fhir:v "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload"^^xsd:anyURI] ; # fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/Base"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/StructureDefinition/Base> ] ; # fhir:derivation [ fhir:v "specialization"] ; # fhir:snapshot [ ( fhir:extension [ fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version"^^xsd:anyURI ] ; fhir:value [ a fhir:string ; fhir:v "4.0.1" ] ] ) ; ( fhir:element [ fhir:id [ fhir:v "ShlPayload" ] ; fhir:path [ fhir:v "ShlPayload" ] ; fhir:short [ fhir:v "SMART Health Link Payload" ] ; fhir:definition [ fhir:v "The SMART Health Link Payload object" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "Base" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "*" ] ] ; fhir:isModifier [ fhir:v false ] ] [ fhir:id [ fhir:v "ShlPayload.url" ] ; fhir:path [ fhir:v "ShlPayload.url" ] ; fhir:short [ fhir:v "Manifest URL for the SMART Health Link." ] ; fhir:definition [ fhir:v "Manifest URL for the SMART Health Link." ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.url" ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "url"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "URL\"" ] ; fhir:value [ a fhir:url ; fhir:v "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"^^xsd:anyURI ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.key" ] ; fhir:path [ fhir:v "ShlPayload.key" ] ; fhir:short [ fhir:v "Decryption key" ] ; fhir:definition [ fhir:v "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded." ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.key" ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "key" ] ; fhir:value [ a fhir:string ; fhir:v "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.exp" ] ; fhir:path [ fhir:v "ShlPayload.exp" ] ; fhir:short [ fhir:v "Expiration time" ] ; fhir:definition [ fhir:v "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.)" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.exp" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "decimal"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "representing January 1, 2026 12:00:00 AM" ] ; fhir:value [ a fhir:string ; fhir:v "1767225600000" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.flag" ] ; fhir:path [ fhir:v "ShlPayload.flag" ] ; fhir:short [ fhir:v "Flag indicating link characteristics." ] ; fhir:definition [ fhir:v "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)." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.flag" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "representing 'Long-term use and requires passcode'" ] ; fhir:value [ a fhir:string ; fhir:v "LP" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.label" ] ; fhir:path [ fhir:v "ShlPayload.label" ] ; fhir:short [ fhir:v "short description of the data behind the SMART Health Link." ] ; fhir:definition [ fhir:v "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.flag" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "label" ] ; fhir:value [ a fhir:string ; fhir:v "Back-to-school immunizations for Oliver Brown" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.v" ] ; fhir:path [ fhir:v "ShlPayload.v" ] ; fhir:short [ fhir:v "Protocol version" ] ; fhir:definition [ fhir:v "SMART Health Links protocol version." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.v" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "integer"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "meaning default version" ] ; fhir:value [ a fhir:integer ; fhir:v 1 ] ] ) ] ) ] ; # fhir:differential [ ( fhir:element [ fhir:id [ fhir:v "ShlPayload" ] ; fhir:path [ fhir:v "ShlPayload" ] ; fhir:short [ fhir:v "SMART Health Link Payload" ] ; fhir:definition [ fhir:v "The SMART Health Link Payload object" ] ] [ fhir:id [ fhir:v "ShlPayload.url" ] ; fhir:path [ fhir:v "ShlPayload.url" ] ; fhir:short [ fhir:v "Manifest URL for the SMART Health Link." ] ; fhir:definition [ fhir:v "Manifest URL for the SMART Health Link." ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; ( fhir:type [ fhir:code [ fhir:v "url"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "URL\"" ] ; fhir:value [ a fhir:url ; fhir:v "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"^^xsd:anyURI ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.key" ] ; fhir:path [ fhir:v "ShlPayload.key" ] ; fhir:short [ fhir:v "Decryption key" ] ; fhir:definition [ fhir:v "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded." ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "key" ] ; fhir:value [ a fhir:string ; fhir:v "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.exp" ] ; fhir:path [ fhir:v "ShlPayload.exp" ] ; fhir:short [ fhir:v "Expiration time" ] ; fhir:definition [ fhir:v "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.)" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; ( fhir:type [ fhir:code [ fhir:v "decimal"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "representing January 1, 2026 12:00:00 AM" ] ; fhir:value [ a fhir:string ; fhir:v "1767225600000" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.flag" ] ; fhir:path [ fhir:v "ShlPayload.flag" ] ; fhir:short [ fhir:v "Flag indicating link characteristics." ] ; fhir:definition [ fhir:v "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)." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "representing 'Long-term use and requires passcode'" ] ; fhir:value [ a fhir:string ; fhir:v "LP" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.label" ] ; fhir:path [ fhir:v "ShlPayload.label" ] ; fhir:short [ fhir:v "short description of the data behind the SMART Health Link." ] ; fhir:definition [ fhir:v "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "ShlPayload.flag" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ] ; ( fhir:type [ fhir:code [ fhir:v "string"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "label" ] ; fhir:value [ a fhir:string ; fhir:v "Back-to-school immunizations for Oliver Brown" ] ] ) ] [ fhir:id [ fhir:v "ShlPayload.v" ] ; fhir:path [ fhir:v "ShlPayload.v" ] ; fhir:short [ fhir:v "Protocol version" ] ; fhir:definition [ fhir:v "SMART Health Links protocol version." ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; ( fhir:type [ fhir:code [ fhir:v "integer"^^xsd:anyURI ] ] ) ; ( fhir:example [ fhir:label [ fhir:v "meaning default version" ] ; fhir:value [ a fhir:integer ; fhir:v 1 ] ] ) ] ) ] . #
IG © 2024+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.smart-health-cards-and-links#1.0.0 based on FHIR 4.0.1. Generated 2025-07-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change