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

: Generate a VHL Authorization Mechanism Based on Query Parameters - XML Representation

Active as of 2025-09-19

Raw xml | Download


<Requirements xmlns="http://hl7.org/fhir">
  <id value="GenerateVHL"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Requirements GenerateVHL</b></p><a name="GenerateVHL"> </a><a name="hcGenerateVHL"> </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="collect-content"> </a></b>Collect Content</td><td>SHALL</td><td><div><p>Collect any pre-existing content and/or generate any necessary content that will be referenced as part of the VHL.</p>
</div></td></tr><tr><td><b><a name="generate-vhl-payload"> </a></b>Generate VHL Payload</td><td>SHALL</td><td><div><p>Generate the payload for the VHL in accordance with the applicable content profile.</p>
</div></td></tr><tr><td><b><a name="sign-VHL"> </a></b>Sign VHL</td><td>SHALL</td><td><div><p>Sign the VHL payload to produce a verifiable and cryptographically bound artifact.</p>
</div></td></tr></table></div>
  </text>
  <url value="https://profiles.ihe.net/ITI/VHL/Requirements/GenerateVHL"/>
  <version value="0.0.2-current"/>
  <name value="GenerateVHL"/>
  <title
         value="Generate a VHL Authorization Mechanism Based on Query Parameters"/>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2025-09-19T17:04:40+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 Sharer](ActorDefinition-VHLSharer.html) SHALL generate a Verified Health Link (VHL) to be issued to a [VHL Holder](ActorDefinition-VHLHolder.html).

The Sharer SHALL conduct all necessary tasks to prepare the content referenced by the VHL. These tasks MAY be further defined by applicable content profiles or implementation guides, and MAY include:
* Generation of new documents;
* Querying for existing documents associated with the VHL Holder; or
* Creation of digital signatures on one or more documents.

Once content preparation is complete, the Sharer SHALL construct the VHL payload and sign it to produce a cryptographically verifiable authorization mechanism.

**Optional behaviors:**
* The Sharer MAY record consent in accordance with the [Record Consent](Requirements-RecordConsent.html) requirement.
* The Sharer MAY log an audit event describing the VHL issuance, in accordance with the [Audit Event – Accessed Health Data](Requirements-AuditEventAccess.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/VHLSharer"/>
  <statement>
    <key value="collect-content"/>
    <label value="Collect Content"/>
    <conformance value="SHALL"/>
    <requirement
                 value="Collect any pre-existing content and/or generate any necessary content that will be referenced as part of the VHL."/>
  </statement>
  <statement>
    <key value="generate-vhl-payload"/>
    <label value="Generate VHL Payload"/>
    <conformance value="SHALL"/>
    <requirement
                 value="Generate the payload for the VHL in accordance with the applicable content profile."/>
  </statement>
  <statement>
    <key value="sign-VHL"/>
    <label value="Sign VHL"/>
    <conformance value="SHALL"/>
    <requirement
                 value="Sign the VHL payload to produce a verifiable and cryptographically bound artifact."/>
  </statement>
</Requirements>