Verifiable Health Links
1.0.0-comment - ballot International flag

Verifiable Health Links, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.0-comment built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.VHL/ and changes regularly. See the Directory of published versions

: Respond to Request VHL Documents - JSON Representation

Active as of 2026-11-20

Raw json | Download

{
  "resourceType" : "Requirements",
  "id" : "RespondtoRequestVHLDocuments",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements RespondtoRequestVHLDocuments</b></p><a name=\"RespondtoRequestVHLDocuments\"> </a><a name=\"hcRespondtoRequestVHLDocuments\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-VHLSharer.html\">VHL Sharer</a></p><table class=\"grid\"><tr><td><b><a name=\"authenticate-receiver\"> </a></b>Authenticate the Receiver</td><td>MAY</td><td><div><p>Where one of the Sign Manifest Request Options is supported, authenticate the requesting <a href=\"ActorDefinition-VHLReceiver.html\">VHL Receiver</a> against the trust network before releasing any manifest content, and reject the request where the Receiver cannot be authenticated</p>\n</div></td></tr><tr><td><b><a name=\"authorize-request\"> </a></b>Authorize the request</td><td>SHALL</td><td><div><p>Confirm that the presented VHL is valid, unexpired and not revoked, that any required passcode is satisfied, and that the VHL authorizes the documents requested</p>\n</div></td></tr><tr><td><b><a name=\"return-manifest\"> </a></b>Return the manifest</td><td>SHALL</td><td><div><p>Return a FHIR searchset Bundle containing only those documents the VHL authorizes, applying any consent-based filtering in force</p>\n</div></td></tr><tr><td><b><a name=\"record-audit-event\"> </a></b>Record audit event</td><td>MAY</td><td><div><p>Record an audit event documenting the access, in accordance with the <a href=\"Requirements-AuditEventAccess.html\">Audit Event – Accessed Health Data</a> requirement</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/VHL/Requirements/RespondtoRequestVHLDocuments",
  "version" : "1.0.0-comment",
  "name" : "RespondtoRequestVHLDocuments",
  "title" : "Respond to Request VHL Documents",
  "status" : "active",
  "date" : "2026-11-20T09:11:02+00:00",
  "publisher" : "IHE IT Infrastructure Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE IT Infrastructure Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "The [VHL Sharer](ActorDefinition-VHLSharer.html) SHALL respond to a manifest request from a [VHL Receiver](ActorDefinition-VHLReceiver.html) that presents a previously issued Verifiable Health Link (VHL), returning only those documents the VHL authorizes.\n\nBefore any manifest content is released, the Sharer SHALL establish that the VHL presented is valid and authorizes what is being requested.\n\nAuthentication of the requesting Receiver is a separate and optional control, provided by the three Sign Manifest Request Options. Where the Sharer claims one of them it authenticates the Receiver against the trust network using PKI material published by the [Trust Anchor](ActorDefinition-TrustAnchor.html) before releasing any manifest content. Where it does not, release of the manifest follows from a valid VHL and, where the `P` flag is set, the correct passcode.\n\n**Optional behaviors:**\n* The VHL Sharer MAY record an audit event documenting the access, in accordance with the [Audit Event – Accessed Health Data](Requirements-AuditEventAccess.html) requirement.\n* The VHL Sharer MAY apply rate limiting per Receiver or per folder ID, and log failed authentication and authorization attempts.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "statement" : [
    {
      "key" : "authenticate-receiver",
      "label" : "Authenticate the Receiver",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "Where one of the Sign Manifest Request Options is supported, authenticate the requesting [VHL Receiver](ActorDefinition-VHLReceiver.html) against the trust network before releasing any manifest content, and reject the request where the Receiver cannot be authenticated"
    },
    {
      "key" : "authorize-request",
      "label" : "Authorize the request",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "Confirm that the presented VHL is valid, unexpired and not revoked, that any required passcode is satisfied, and that the VHL authorizes the documents requested"
    },
    {
      "key" : "return-manifest",
      "label" : "Return the manifest",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "Return a FHIR searchset Bundle containing only those documents the VHL authorizes, applying any consent-based filtering in force"
    },
    {
      "key" : "record-audit-event",
      "label" : "Record audit event",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "Record an audit event documenting the access, in accordance with the [Audit Event – Accessed Health Data](Requirements-AuditEventAccess.html) requirement"
    }
  ]
}