Verifiable Health Link, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.2-current 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

• Narrative Content
• XML
• JSON
• TTL

: Request VHL Document - JSON Representation

Active as of 2025-06-16

Raw json | Download

{
  "resourceType" : "Requirements",
  "id" : "RequestVHLDocument",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements RequestVHLDocument</b></p><a name=\"RequestVHLDocument\"> </a><a name=\"hcRequestVHLDocument\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-VHLReceiver.html\">VHL Receiver</a></p><table class=\"grid\"><tr><td><b><a name=\"retrieve-health-document\"> </a></b>Retrieve single health document</td><td>SHALL</td><td><div><p>Initiate a request to retrieve a single health document from a <a href=\"ActorDefinition-VHLSharer.html\">VHL Sharer</a>, using a previously received and validated Verified Health Link (VHL)</p>\n</div></td></tr><tr><td><b><a name=\"verify-digital-signature\"> </a></b>Verify digital signature</td><td>MAY</td><td><div><p>Verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the <a href=\"Requirements-VerifyDocumentSignature.html\">Verify Document Signature</a> requirement</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 request by the Receiver, in accordance with the <a href=\"Requirements-AuditEventReceived.html\">Audit Event – Received Health Data</a> requirement</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/VHL/Requirements/RequestVHLDocument",
  "version" : "0.0.2-current",
  "name" : "RequestVHLDocument",
  "title" : "Request VHL Document",
  "status" : "active",
  "date" : "2025-06-16T13:14:26+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 Receiver](ActorDefinition-VHLReceiver.html) SHALL initiate a request to retrieve a single health document from a [VHL Sharer](ActorDefinition-VHLSharer.html), using a previously received and validated Verified Health Link (VHL).\n\nThis transaction SHALL be conducted over a mutually authenticated TLS (mTLS) channel. Both the Receiver and Sharer SHALL validate each other's participation in the trust network using PKI material published by the [Trust Anchor](ActorDefinition-TrustAnchor.html).\n\n**Optional behaviors:**\n* The VHL Receiver MAY verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the [Verify Document Signature](Requirements-VerifyDocumentSignature.html) requirement.\n* The VHL Sharer MAY record an audit event documenting the access request by the Receiver, in accordance with the [Audit Event – Received Health Data](Requirements-AuditEventReceived.html) requirement.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "actor" : [
    🔗 "https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLReceiver"
  ],
  "statement" : [
    {
      "key" : "retrieve-health-document",
      "label" : "Retrieve single health document",
      "conformance" : [
        "SHALL"
      ],
      "requirement" : "Initiate a request to retrieve a single health document from a [VHL Sharer](ActorDefinition-VHLSharer.html), using a previously received and validated Verified Health Link (VHL)"
    },
    {
      "key" : "verify-digital-signature",
      "label" : "Verify digital signature",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "Verify the digital signature of the returned health document to confirm its authenticity, integrity, and provenance, as defined in the [Verify Document Signature](Requirements-VerifyDocumentSignature.html) requirement"
    },
    {
      "key" : "record-audit-event",
      "label" : "Record audit event",
      "conformance" : [
        "MAY"
      ],
      "requirement" : "Record an audit event documenting the access request by the Receiver, in accordance with the [Audit Event – Received Health Data](Requirements-AuditEventReceived.html) requirement"
    }
  ]
}