FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/VerifiableHealthLinkPayload

Packagesmart.who.int.trust-phw
TypeStructureDefinition
IdVerifiableHealthLinkPayload
FHIR VersionR4
Sourcehttp://smart.who.int/trust-phw/https://build.fhir.org/ig/WorldHealthOrganization/smart-trust-phw/StructureDefinition-VerifiableHealthLinkPayload.html
URLhttps://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload
Version0.1.0
Statusdraft
Date2025-07-08T11:27:10+00:00
NameVerifiableHealthLinkPayload
TitleVerifiable Health Link Payload (DRAFT)
Realmuv
Authoritywho
DescriptionVerifiable Health Link Payload (DRAFT) This logical model constrains the Health Link Payload for a Verifiable Health Link
Typehttps://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
HealthLinkPayloadHealth Link Payload (DRAFT)
ValueSet
HL.TYPEHL.TYPE ValueSet

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition VerifiableHealthLinkPayload

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerifiableHealthLinkPayload 0..*HealthLinkPayload
Elements defined in Ancestors:url, key, exp, flag, label, v, type
Verifiable Health Link Payload (DRAFT)
Instances of this logical model can be the target of a Reference
... type C1..1codeClassifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.
Binding: HL.TYPE ValueSet (preferred)
Constraints: is-a-verifiable-health-link

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "VerifiableHealthLinkPayload",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    }
  ],
  "url": "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload",
  "version": "0.1.0",
  "name": "VerifiableHealthLinkPayload",
  "title": "Verifiable 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": "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\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": "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload",
  "baseDefinition": "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "element": [
      {
        "id": "VerifiableHealthLinkPayload",
        "path": "VerifiableHealthLinkPayload",
        "short": "Verifiable Health Link Payload (DRAFT)",
        "definition": "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "VerifiableHealthLinkPayload.url",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.key",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.exp",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.flag",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.label",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.v",
        "path": "VerifiableHealthLinkPayload.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": "VerifiableHealthLinkPayload.type",
        "path": "VerifiableHealthLinkPayload.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": 1,
        "max": "1",
        "base": {
          "path": "HealthLinkPayload.type",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "constraint": [
          {
            "key": "is-a-verifiable-health-link",
            "severity": "error",
            "human": "The Health Link type is is a verifiable health link",
            "expression": "type = 'vhl'",
            "source": "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload"
          }
        ],
        "binding": {
          "strength": "preferred",
          "valueSet": "http://smart.who.int/trust-phw/ValueSet/HL.TYPE"
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "VerifiableHealthLinkPayload",
        "path": "VerifiableHealthLinkPayload",
        "short": "Verifiable Health Link Payload (DRAFT)",
        "definition": "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n"
      },
      {
        "id": "VerifiableHealthLinkPayload.type",
        "path": "VerifiableHealthLinkPayload.type",
        "min": 1,
        "constraint": [
          {
            "key": "is-a-verifiable-health-link",
            "severity": "error",
            "human": "The Health Link type is is a verifiable health link",
            "expression": "type = 'vhl'",
            "source": "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload"
          }
        ],
        "binding": {
          "strength": "preferred",
          "valueSet": "http://smart.who.int/trust-phw/ValueSet/HL.TYPE"
        }
      }
    ]
  }
}