{
  "description": "The SMART Health Link Payload object",
  "_filename": "StructureDefinition-ShlPayload.json",
  "package_name": "hl7.fhir.uv.smart-health-cards-and-links",
  "date": "2025-07-22T13:19:59+00:00",
  "derivation": "specialization",
  "publisher": "HL7 International / FHIR Infrastructure",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "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.",
  "name": "ShlPayload",
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "SMART Health Link Payload",
  "package_version": "1.0.0",
  "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"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "id": "ShlPayload",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      },
      "path": "ShlPayload",
      "short": "SMART Health Link Payload",
      "definition": "The SMART Health Link Payload object",
      "isModifier": false
    }, {
      "path": "ShlPayload.url",
      "min": 1,
      "definition": "Manifest URL for the SMART Health Link.",
      "short": "Manifest URL for the SMART Health Link.",
      "type": [ {
        "code": "url"
      } ],
      "max": "1",
      "id": "ShlPayload.url",
      "example": [ {
        "label": "URL\"",
        "valueUrl": "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"
      } ],
      "base": {
        "max": "1",
        "min": 1,
        "path": "ShlPayload.url"
      }
    }, {
      "path": "ShlPayload.key",
      "min": 1,
      "definition": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
      "short": "Decryption key",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "ShlPayload.key",
      "example": [ {
        "label": "key",
        "valueString": "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q"
      } ],
      "base": {
        "max": "1",
        "min": 1,
        "path": "ShlPayload.key"
      }
    }, {
      "path": "ShlPayload.exp",
      "min": 0,
      "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.)",
      "short": "Expiration time",
      "type": [ {
        "code": "decimal"
      } ],
      "max": "1",
      "id": "ShlPayload.exp",
      "example": [ {
        "label": "representing January 1, 2026 12:00:00 AM",
        "valueString": "1767225600000"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "ShlPayload.exp"
      }
    }, {
      "path": "ShlPayload.flag",
      "min": 0,
      "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).",
      "short": "Flag indicating link characteristics.",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "ShlPayload.flag",
      "example": [ {
        "label": "representing 'Long-term use and requires passcode'",
        "valueString": "LP"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "ShlPayload.flag"
      }
    }, {
      "path": "ShlPayload.label",
      "min": 0,
      "definition": "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link.",
      "short": "short description of the data behind the SMART Health Link.",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "ShlPayload.label",
      "example": [ {
        "label": "label",
        "valueString": "Back-to-school immunizations for Oliver Brown"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "ShlPayload.flag"
      }
    }, {
      "path": "ShlPayload.v",
      "min": 0,
      "definition": "SMART Health Links protocol version.",
      "short": "Protocol version",
      "type": [ {
        "code": "integer"
      } ],
      "max": "1",
      "id": "ShlPayload.v",
      "example": [ {
        "label": "meaning default version",
        "valueInteger": 1
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "ShlPayload.v"
      }
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "4.0.1"
    } ]
  },
  "status": "active",
  "id": "baf35718-574e-49f1-bf0b-559c129a7d58",
  "kind": "logical",
  "url": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/ShlPayload",
  "version": "1.0.0",
  "differential": {
    "element": [ {
      "id": "ShlPayload",
      "path": "ShlPayload",
      "short": "SMART Health Link Payload",
      "definition": "The SMART Health Link Payload object"
    }, {
      "id": "ShlPayload.url",
      "max": "1",
      "min": 1,
      "path": "ShlPayload.url",
      "type": [ {
        "code": "url"
      } ],
      "short": "Manifest URL for the SMART Health Link.",
      "example": [ {
        "label": "URL\"",
        "valueUrl": "https://ehr.example.org/qr/Y9xwkUdtmN9wwoJoN3ffJIhX2UGvCL1JnlPVNL3kDWM/m"
      } ],
      "definition": "Manifest URL for the SMART Health Link."
    }, {
      "id": "ShlPayload.key",
      "max": "1",
      "min": 1,
      "path": "ShlPayload.key",
      "type": [ {
        "code": "string"
      } ],
      "short": "Decryption key",
      "example": [ {
        "label": "key",
        "valueString": "rxTgYlOaKJPFtcEd0qcceN8wEU4p94SqAwIWQe6uX7Q"
      } ],
      "definition": "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded."
    }, {
      "id": "ShlPayload.exp",
      "max": "1",
      "min": 0,
      "path": "ShlPayload.exp",
      "type": [ {
        "code": "decimal"
      } ],
      "short": "Expiration time",
      "example": [ {
        "label": "representing January 1, 2026 12:00:00 AM",
        "valueString": "1767225600000"
      } ],
      "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.)"
    }, {
      "id": "ShlPayload.flag",
      "max": "1",
      "min": 0,
      "path": "ShlPayload.flag",
      "type": [ {
        "code": "string"
      } ],
      "short": "Flag indicating link characteristics.",
      "example": [ {
        "label": "representing 'Long-term use and requires passcode'",
        "valueString": "LP"
      } ],
      "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)."
    }, {
      "path": "ShlPayload.label",
      "min": 0,
      "definition": "String no longer than 80 characters that provides a short description of the data behind the SMART Health Link.",
      "short": "short description of the data behind the SMART Health Link.",
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "ShlPayload.label",
      "example": [ {
        "label": "label",
        "valueString": "Back-to-school immunizations for Oliver Brown"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "ShlPayload.flag"
      }
    }, {
      "id": "ShlPayload.v",
      "max": "1",
      "min": 0,
      "path": "ShlPayload.v",
      "type": [ {
        "code": "integer"
      } ],
      "short": "Protocol version",
      "example": [ {
        "label": "meaning default version",
        "valueInteger": 1
      } ],
      "definition": "SMART Health Links protocol version."
    } ]
  },
  "contact": [ {
    "name": "HL7 International / FHIR Infrastructure",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    } ]
  }, {
    "name": "Frank McKinney",
    "telecom": [ {
      "value": "frank.mckinney@pocp.com",
      "system": "email"
    }, {
      "value": "fm@frankmckinney.com",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}