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

Verified 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

ActorDefinition: VHL Holder

Official URL: https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLHolder Version: 0.0.2-current
Active as of 2025-04-15 Computable Name: VHLHolder

The VHL Holder is an individual that is holding an authorization mechanism, a VHL, which allows a VHL Receiver to access a (set of) health document(s) held by a VHL Sharer.

Publisher No publisher has been registered.
Contact Email No contact email has been registered.
Jurisdiction 001
Requirements This actor fulfills the following requirements:
  • Provide VHL:

    This transacation is initiated by a VHL Holder to transmit a VHL to the VHL Receiver. Depending on the use case and context, the payload comprising the VHL may be rendered/serialized and transmitted through various mechanisms, for example as a QR-code, Verifiable Credentials, bluetooth or near-field communication protocols. These mechanisms are described in Volume 3.

    {"resourceType"=>"Basic", "id"=>"ProvideVHL", "text"=>{"status"=>"generated", "div"=>"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements ProvideVHL</b></p><a name=\"ProvideVHL\"> </a><a name=\"hcProvideVHL\"> </a><a name=\"ProvideVHL-en-US\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-VHLHolder.html\">VHL Holder</a></p><table class=\"grid\"/></div>"}, "extension"=>[{"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.url", "valueUri"=>"https://profiles.ihe.net/ITI/VHL/Requirements/ProvideVHL"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.version", "valueString"=>"0.0.2-current"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.name", "valueString"=>"ProvideVHL"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title", "valueString"=>"Provide VHL"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.status", "valueCode"=>"active"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.date", "valueDateTime"=>"2025-04-15T11:34:20+00:00"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.publisher", "valueString"=>"IHE IT Infrastructure Technical Committee"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"telecom"=>[{"system"=>"url", "value"=>"https://www.ihe.net/ihe_domains/it_infrastructure/"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"telecom"=>[{"system"=>"email", "value"=>"iti@ihe.net"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"name"=>"IHE IT Infrastructure Technical Committee", "telecom"=>[{"system"=>"email", "value"=>"iti@ihe.net"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.description", "valueMarkdown"=>"This transacation is initiated by a VHL Holder to transmit a VHL to the VHL Receiver.   Depending on the use case and context, the payload comprising the VHL may be rendered/serialized and transmitted through various mechanisms, for example as a QR-code, Verifiable Credentials, bluetooth or near-field communication protocols.  These mechanisms are described in [Volume 3](volume-3.html). "}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.jurisdiction", "valueCodeableConcept"=>{"coding"=>[{"system"=>"http://unstats.un.org/unsd/methods/m49/m49.htm", "code"=>"001"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor", "valueCanonical"=>"https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLHolder"}], "code"=>{"coding"=>[{"system"=>"http://hl7.org/fhir/fhir-types", "code"=>"Requirements"}]}}
  • Request that a VHL authorization mechanism be issued:

    ​A VHL Holder triggers a request for a VHL authorization mechanism to be generated from a Sharer in order to share health documents with a VHL Receiver.

    The VHL Holder requests that a VHL authorization mechanism be issued to provide access to one or more health documents.

    The [VHL Holder]((ActorDefinition-VHLHolder.html) MAY provide optional parameters. The parameters may be to protect or constrain the scope of the authorization (e.g. configure a pass code, set the time period for which these documents should be made available).

    Preconditions:

    • The Holder SHALL trust that Sharer has been authorized by its jurisidiction to authorize and provide access to health documents.
    • (optional) the Holder has selected consent and selective disclosure directives.
    {"resourceType"=>"Basic", "id"=>"RequestVHL", "text"=>{"status"=>"generated", "div"=>"<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Requirements RequestVHL</b></p><a name=\"RequestVHL\"> </a><a name=\"hcRequestVHL\"> </a><a name=\"RequestVHL-en-US\"> </a><p>These requirements apply to the actor <a href=\"ActorDefinition-VHLHolder.html\">VHL Holder</a></p><table class=\"grid\"/></div>"}, "extension"=>[{"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.url", "valueUri"=>"https://profiles.ihe.net/ITI/VHL/Requirements/RequestVHL"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.version", "valueString"=>"0.0.2-current"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.name", "valueString"=>"RquestVHL"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.title", "valueString"=>"Request that a VHL authorization mechanism be issued"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.status", "valueCode"=>"active"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.date", "valueDateTime"=>"2025-04-15T11:34:20+00:00"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.publisher", "valueString"=>"IHE IT Infrastructure Technical Committee"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"telecom"=>[{"system"=>"url", "value"=>"https://www.ihe.net/ihe_domains/it_infrastructure/"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"telecom"=>[{"system"=>"email", "value"=>"iti@ihe.net"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.contact", "valueContactDetail"=>{"name"=>"IHE IT Infrastructure Technical Committee", "telecom"=>[{"system"=>"email", "value"=>"iti@ihe.net"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.description", "valueMarkdown"=>"A [VHL Holder](ActorDefinition-VHLHolder.html) triggers a request for a VHL authorization mechanism to be generated from a [Sharer](ActorDefinition-VHLSharer.html) in order to share health documents with a [VHL Receiver](ActorDefinition-VHLReceiever.html). \n\nThe [VHL Holder](ActorDefinition-VHLHolder.html) requests that a VHL authorization mechanism be issued to provide access to one or more health documents.\n\nThe [VHL Holder]((ActorDefinition-VHLHolder.html) MAY provide optional parameters.  The parameters may be to protect or constrain the scope of the authorization (e.g. configure a pass code, set the time period for which these documents should be made available).\n\n\nPreconditions:\n  * The [Holder](ActorDefinition-VHLHolder.html) SHALL trust that [Sharer](ActorDefinition-VHLSharer.html) has been authorized by its jurisidiction to authorize and provide access to health documents.\n  * (optional) the [Holder](ActorDefinition-VHLHolder.html) has selected consent and selective disclosure directives. \n"}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.jurisdiction", "valueCodeableConcept"=>{"coding"=>[{"system"=>"http://unstats.un.org/unsd/methods/m49/m49.htm", "code"=>"001"}]}}, {"url"=>"http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.actor", "valueCanonical"=>"https://profiles.ihe.net/ITI/VHL/ActorDefinition/VHLHolder"}], "code"=>{"coding"=>[{"system"=>"http://hl7.org/fhir/fhir-types", "code"=>"Requirements"}]}}