{
  "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",
  "_filename": "StructureDefinition-HealthLinkPayload.json",
  "package_name": "smart.who.int.trust-phw",
  "date": "2025-10-07T06:40:24+00:00",
  "derivation": "specialization",
  "publisher": "WHO",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "World"
    } ]
  } ],
  "name": "HealthLinkPayload",
  "abstract": false,
  "type": "http://smart.who.int/trust-phw/StructureDefinition/HealthLinkPayload",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Health Link Payload (DRAFT)",
  "package_version": "0.1.0",
  "snapshot": {
    "element": [ {
      "id": "HealthLinkPayload",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      },
      "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",
      "isModifier": false
    }, {
      "id": "HealthLinkPayload.url",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "HealthLinkPayload.url"
      },
      "path": "HealthLinkPayload.url",
      "type": [ {
        "code": "string"
      } ],
      "short": "url",
      "definition": "Manifest URL for this Health Link"
    }, {
      "id": "HealthLinkPayload.key",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "HealthLinkPayload.key"
      },
      "path": "HealthLinkPayload.key",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.exp",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "HealthLinkPayload.exp"
      },
      "path": "HealthLinkPayload.exp",
      "type": [ {
        "code": "string"
      } ],
      "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.)"
    }, {
      "id": "HealthLinkPayload.flag",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "HealthLinkPayload.flag"
      },
      "path": "HealthLinkPayload.flag",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.label",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "HealthLinkPayload.label"
      },
      "path": "HealthLinkPayload.label",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.v",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "HealthLinkPayload.v"
      },
      "path": "HealthLinkPayload.v",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.type",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "HealthLinkPayload.type"
      },
      "path": "HealthLinkPayload.type",
      "type": [ {
        "code": "code"
      } ],
      "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."
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "4.0.1"
    } ]
  },
  "status": "active",
  "id": "0cac1a2b-0a51-4c94-864d-3c90f9f78e6b",
  "kind": "logical",
  "url": "http://smart.who.int/trust-phw/StructureDefinition/HealthLinkPayload",
  "version": "0.1.0",
  "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",
      "max": "1",
      "min": 1,
      "path": "HealthLinkPayload.url",
      "type": [ {
        "code": "string"
      } ],
      "short": "url",
      "definition": "Manifest URL for this Health Link"
    }, {
      "id": "HealthLinkPayload.key",
      "max": "1",
      "min": 1,
      "path": "HealthLinkPayload.key",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.exp",
      "max": "1",
      "min": 0,
      "path": "HealthLinkPayload.exp",
      "type": [ {
        "code": "string"
      } ],
      "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.)"
    }, {
      "id": "HealthLinkPayload.flag",
      "max": "1",
      "min": 0,
      "path": "HealthLinkPayload.flag",
      "type": [ {
        "code": "string"
      } ],
      "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  "
    }, {
      "id": "HealthLinkPayload.label",
      "max": "1",
      "min": 0,
      "path": "HealthLinkPayload.label",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.v",
      "max": "1",
      "min": 0,
      "path": "HealthLinkPayload.v",
      "type": [ {
        "code": "string"
      } ],
      "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."
    }, {
      "id": "HealthLinkPayload.type",
      "max": "1",
      "min": 0,
      "path": "HealthLinkPayload.type",
      "type": [ {
        "code": "code"
      } ],
      "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."
    } ]
  },
  "contact": [ {
    "name": "WHO",
    "telecom": [ {
      "value": "http://who.int",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}