Verifiable Health Link
0.0.2-current - ci-build International flag

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

: Request VHL Document - XML Representation

Active as of 2025-06-16

Raw xml | Download


<Requirements xmlns="http://hl7.org/fhir">
  <id value="RequestVHLDocument"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://profiles.ihe.net/ITI/VHL/Requirements/RequestVHLDocument"/>
  <version value="0.0.2-current"/>
  <name value="RequestVHLDocument"/>
  <title value="Request VHL Document"/>
  <status value="active"/>
  <date value="2025-06-16T13:14:26+00:00"/>
  <publisher value="IHE IT Infrastructure Technical Committee"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <contact>
    <name value="IHE IT Infrastructure Technical Committee"/>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <description
               value="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).

This 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).

**Optional behaviors:**
* 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.
* 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 value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <actor
         value="https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLReceiver"/>
  <statement>
    <key value="retrieve-health-document"/>
    <label value="Retrieve single health document"/>
    <conformance value="SHALL"/>
    <requirement
                 value="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)"/>
  </statement>
  <statement>
    <key value="verify-digital-signature"/>
    <label value="Verify digital signature"/>
    <conformance value="MAY"/>
    <requirement
                 value="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"/>
  </statement>
  <statement>
    <key value="record-audit-event"/>
    <label value="Record audit event"/>
    <conformance value="MAY"/>
    <requirement
                 value="Record an audit event documenting the access request by the Receiver, in accordance with the [Audit Event – Received Health Data](Requirements-AuditEventReceived.html) requirement"/>
  </statement>
</Requirements>