| Package | ihe.iti.vhl |
| Type | ImplementationGuide |
| Id | ihe.iti.vhl |
| FHIR Version | R4 |
| Source | https://profiles.ihe.net/ITI/VHL/https://build.fhir.org/ig/IHE/ITI.VHL/index.html |
| URL | https://profiles.ihe.net/ITI/VHL/ImplementationGuide/ihe.iti.vhl |
| Version | 0.0.2-current |
| Status | draft |
| Date | 2025-03-07 |
| Name | IHE_ITI_VHL |
| Title | Verifiable Health Link |
| Realm | uv |
| Authority | ihe |
| Description | Patient Mediated sharing of their health information using internet accessible verifiable health link. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide ihe.iti.vhl
The official URL for this implementation guide is:
https://profiles.ihe.net/ITI/VHL/ImplementationGuide/ihe.iti.vhl
Patient Mediated sharing of their health information using internet accessible verifiable health link.
FHIR{
"resourceType": "ImplementationGuide",
"id": "ihe.iti.vhl",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "https://profiles.ihe.net/ITI/VHL/ImplementationGuide/ihe.iti.vhl",
"version": "0.0.2-current",
"name": "IHE_ITI_VHL",
"title": "Verifiable Health Link",
"status": "draft",
"date": "2025-03-07",
"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": "Patient Mediated sharing of their health information using internet accessible verifiable health link.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"packageId": "ihe.iti.vhl",
"license": "CC-BY-4.0",
"fhirVersion": [
"4.0.1"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r4",
"version": "6.4.0"
},
{
"id": "hl7ext",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"
}
],
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r4",
"version": "5.2.0"
}
],
"definition": {
"extension": [
{
"extension": [
{
"url": "code",
"valueString": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "releaselabel"
},
{
"url": "value",
"valueString": "ci-build"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "show-inherited-invariants"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "usage-stats-opt-out"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "logging"
},
{
"url": "value",
"valueString": "progress"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "shownav"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "active-tables"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "produce-jekyll-data"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "path-history"
},
{
"url": "value",
"valueString": "https://profiles.ihe.net/ITI/VHL/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueString": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r4#0.5.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "copyrightyear"
},
{
"url": "value",
"valueString": "2024+"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "releaselabel"
},
{
"url": "value",
"valueString": "ci-build"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "show-inherited-invariants"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "usage-stats-opt-out"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "logging"
},
{
"url": "value",
"valueString": "progress"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "shownav"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "active-tables"
},
{
"url": "value",
"valueString": "false"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-contact"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-jurisdiction"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-publisher"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-version"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "produce-jekyll-data"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "autoload-resources"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "template/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-liquid"
},
{
"url": "value",
"valueString": "input/liquid"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-qa"
},
{
"url": "value",
"valueString": "temp/qa"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-temp"
},
{
"url": "value",
"valueString": "temp/pages"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-output"
},
{
"url": "value",
"valueString": "output"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-suppressed-warnings"
},
{
"url": "value",
"valueString": "input/ignoreWarnings.txt"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "path-history"
},
{
"url": "value",
"valueString": "https://profiles.ihe.net/ITI/VHL/history.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-html"
},
{
"url": "value",
"valueString": "template-page.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "template-md"
},
{
"url": "value",
"valueString": "template-page-md.html"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-context"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-copyright"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-license"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "apply-wg"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "fmm-definition"
},
{
"url": "value",
"valueString": "http://hl7.org/fhir/versions.html#maturity"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "propagate-status"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "excludelogbinaryformat"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension": [
{
"url": "code",
"valueCode": "tabbed-snapshots"
},
{
"url": "value",
"valueString": "true"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/AcceptMTLSConnection"
},
"name": "Accept mTLS",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html), when acting as a server in a Verified Health Link (VHL) transaction, SHALL accept a mutually authenticated TLS (mTLS) connection initiated by a [VHL Receiver](ActorDefinition-VHLReceiver.html).\n\nDuring the TLS handshake, the Sharer SHALL:\n* Present a valid X.509 server certificate that is anchored to a recognized Trust Anchor\n* Validate the client certificate presented by the Receiver against the same trust framework\n* Establish a secure channel over which all subsequent VHL-related transactions are conducted\n\nSuccessful completion of the mTLS handshake is a prerequisite for all VHL operations involving sensitive data exchange. This requirement refines the bilateral obligations described in [Create Trusted Channel](Requirements-CreateTrustedChannel.html).",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/AuditEventAccess"
},
"name": "Audit Event - Accessed Health Data",
"description": "**Purpose:** \nEnsure that the VHL Sharer records audit events when health documents are accessed or retrieved using a Verified Health Link (VHL).\n\n**Description:** \nThe [VHL Sharer](ActorDefinition-VHLSharer.html) MAY record audit events for critical events involving document access. These MAY include:\n* A request from a [VHL Holder](ActorDefinition-VHLHolder.html) to generate a VHL\n* A request from a [VHL Receiver](ActorDefinition-VHLReceiver.html) to retrieve one or more health documents using a valid VHL\n* Any access to protected health content triggered by the use of a VHL",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/AuditEventReceived"
},
"name": "Audit Event - Received Health Data",
"description": "**Purpose:** \nEnsure that the VHL Receiver generates audit records when receiving and using a Verified Health Link (VHL) to retrieve health information, in support of accountability and traceability.\n\n**Description:** \nThe [VHL Receiver](ActorDefinition-VHLReceiver.html) MAY record audit events for critical events during its handling of a VHL. These MAY include:\n* Receipt of a VHL from a [VHL Holder](ActorDefinition-VHLHolder.html)\n* Verification of the VHL's digital signature and trust chain\n* Use of the VHL to retrieve referenced health documents from a [VHL Sharer](ActorDefinition-VHLSharer.html)\n* Access, rendering, or internal processing of the retrieved documents",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/CreateTrustedChannel"
},
"name": "Create Trusted Channel",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html) and [VHL Receiver](ActorDefinition-VHLReceiver.html) SHALL jointly establish a mutually authenticated TLS (mTLS) connection prior to executing any Verified Health Link (VHL) transactions involving the exchange of sensitive data.\n\nThis requirement entails:\n* The VHL Receiver initiating the mTLS handshake as the client and presenting a valid X.509 certificate\n* The VHL Sharer responding as the server, presenting its own certificate and validating the client's certificate against a trusted Certificate Authority or Trust Anchor\n\nEstablishing this trusted channel ensures confidentiality, integrity, and bilateral authentication of all subsequent communications, and fulfills the trust obligations defined in the [Establish Trust](Requirements-EstablishTrust.html) requirement.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/DistributePKIMaterial"
},
"name": "Distribute PKI Material",
"description": "Upon receipt of public key material from a [VHL Sharer](ActorDefinition-VHLSharer.html) or [VHL Receiver](ActorDefinition-VHLReceiver.html), the [Trust Anchor](ActorDefinition-TrustAnchor.html) SHALL validate, organize, sign, and expose the PKI material as part of a trusted, canonical trust list.\n\nThis signed trust list enables all participants in the VHL trust network to verify digital signatures and establish secure connections in accordance with the governance policies of the Trust Anchor.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/EstablishTrust"
},
"name": "Establish Trust",
"description": "Before participating in any Verified Health Link (VHL) transactions, the [VHL Sharer](ActorDefinition-VHLSharer.html) and [VHL Receiver](ActorDefinition-VHLReceiver.html) SHALL establish a trust relationship based on shared acceptance of a designated [Trust Anchor](ActorDefinition-TrustAnchor.html).\n\nTrust is established by referencing and accepting public key material published and distributed in accordance with this specification (e.g., via [Distribute PKI Material](Requirements-DistributePKIMaterial.html) and [Receive PKI Material](Requirements-ReceivePKIMaterial.html) transactions).\n\nAll participants MUST validate digital signatures using keys that are anchored in the agreed trust framework.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/GenerateVHL"
},
"name": "Generate a VHL Authorization Mechanism Based on Query Parameters",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html) SHALL generate a Verified Health Link (VHL) to be issued to a [VHL Holder](ActorDefinition-VHLHolder.html).\n\nThe 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:\n* Generation of new documents;\n* Querying for existing documents associated with the VHL Holder; or\n* Creation of digital signatures on one or more documents.\n\nOnce content preparation is complete, the Sharer SHALL construct the VHL payload and sign it to produce a cryptographically verifiable authorization mechanism.\n\n**Optional behaviors:**\n* The Sharer MAY record consent in accordance with the [Record Consent](Requirements-RecordConsent.html) requirement.\n* The Sharer MAY log an audit event describing the VHL issuance, in accordance with the [Audit Event – Accessed Health Data](Requirements-AuditEventAccess.html) requirement.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/InitiateMTLSConnection"
},
"name": "Initiate mTLS",
"description": "The [VHL Receiver](ActorDefinition-VHLReceiver.html), when acting as a client in a Verified Health Link (VHL) transaction, SHALL initiate a mutually authenticated TLS (mTLS) connection to the [VHL Sharer](ActorDefinition-VHLSharer.html).\n\nThis initiation includes:\n* Presenting a valid X.509 client certificate\n* Validating the Sharer's server certificate against an accepted Trust Anchor\n\nSuccessful completion of the mTLS handshake is a prerequisite for all subsequent transactions involving sensitive data exchange, including the retrieval of VHLs or associated health documents.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/ProvidePKIMaterial"
},
"name": "Provide PKI material",
"description": "Upon receiving a Retrieve PKI Material request, the [Trust Anchor](ActorDefinition-TrustAnchor.html) SHALL validate the request and respond with appropriate public key material.\n\nThis MAY include:\n* Public key certificates, trust chains, or JWKS structures\n* Revocation data (CRL or OCSP)\n* Usage metadata (e.g., key type, scope, intended usage)\n\nThe Trust Anchor SHALL only respond with validated and trustworthy material in accordance with the governance policies of the VHL trust framework.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/ProvideVHL"
},
"name": "Provide VHL",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html) SHALL generate a Verified Health Link (VHL) to be issued to a [VHL Holder](ActorDefinition-VHLHolder.html). This includes preparing or retrieving the referenced health content, constructing the VHL payload, and digitally signing it to ensure authenticity and integrity.\n\nThe Sharer SHALL perform all necessary steps to assemble the content for sharing. These steps MAY include:\n* Querying for existing health documents (e.g., IPS, CDA, FHIR Bundles)\n* Generating new content in real time\n* Applying digital signatures to selected documents or bundles\n\nThe Sharer SHALL construct the VHL payload in accordance with the applicable VHL content profile, and SHALL cryptographically sign the VHL to make it verifiable.\n\n**Optional behaviors:**\n* The Sharer MAY record consent in accordance with the [Record Consent](Requirements-RecordConsent.html) requirement.\n* The Sharer MAY log an audit event describing the creation of the VHL, as defined in the [Audit Event – Accessed Health Data](Requirements-AuditEventAccess.html) requirement.\n\nDepending on the use case, the VHL MAY be rendered or transmitted using formats such as QR code, Verifiable Credentials, Bluetooth, or NFC. Supported mechanisms are defined in [Volume 3](volume-3.html).",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/ReceivePKIMaterial"
},
"name": "Receive PKI material",
"description": "A [VHL Sharer](ActorDefinition-VHLSharer.html) or [VHL Receiver](ActorDefinition-VHLReceiver.html), after receiving PKI material from a [Trust Anchor](ActorDefinition-TrustAnchor.html), SHALL validate and process the trust information for subsequent cryptographic operations.\n\nParticipants SHOULD:\n* Cache the received trust list or certificate material to reduce network and server load\n* Validate digital signatures or trust paths before use in VHL validation or mTLS sessions\n* Monitor certificate expiration or revocation status where applicable",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/ReceiveVHL"
},
"name": "Receive VHL authorization mechanism",
"description": "The [VHL Receiver](ActorDefinition-VHLReceiver.html) SHALL be capable of receiving a Verified Health Link (VHL) from a [VHL Holder](ActorDefinition-VHLHolder.html) through a supported transport mechanism (e.g., QR code scan, direct URL, or digital message).\n\nUpon receipt, the Receiver SHALL:\n* Parse the VHL\n* Validate its digital signature against a trusted key published by a recognized Trust Anchor\n* Prepare to retrieve the associated health documents\n\nReceipt of the VHL may occur through direct user interaction (e.g., scanning a QR code) or automated channels, depending on the implementation context.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RecordAccessToHealthData"
},
"name": "Record Access to Health Data",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html) MAY record audit events when health data is accessed through a Verified Health Link (VHL). These events support accountability, traceability, and compliance with applicable security and privacy regulations.\n\nAudit records MAY include the following metadata:\n* Timestamp of the access event\n* Identity of the accessing actor (e.g., person or system)\n* Type and identifier of the accessed resource (e.g., DocumentReference)\n* Purpose of access, where available (e.g., treatment, consent verification)\n* Outcome of the event (e.g., success, failure)\n\nAudit events SHALL be represented using the FHIR `AuditEvent` resource, and SHOULD conform to applicable IHE profiles such as ATNA where appropriate. Implementers MAY define additional audit logging behavior to meet jurisdictional or organizational policies.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RecordConsent"
},
"name": "Record Consent",
"description": "The [VHL Sharer](ActorDefinition-VHLSharer.html) SHALL record the consent granted by a [VHL Holder](ActorDefinition-VHLHolder.html) to authorize the sharing of their health data via a Verified Health Link (VHL). This consent confirms that the Holder agrees to the creation of a VHL and its use by authorized [VHL Receivers](ActorDefinition-VHLReceiver.html) to access specific health documents.\n\nIn this requirement, the VHL Sharer acts as a Consent Recorder, as defined in the [Privacy Consent on FHIR (PCF)](https://profiles.ihe.net/ITI/PCF/index.html) profile. Specifically, the Sharer SHALL initiate the [Access Consent - ITI-108](https://profiles.ihe.net/ITI/PCF/ITI-108.html) transaction to formally capture the Holder's consent.\n\nThe resulting `Consent` resource SHALL document:\n* The data subject (VHL Holder)\n* The purpose of use\n* The authorized data recipients (i.e., permitted VHL Receivers)\n* The scope of data (e.g., specific documents or resource types)\n* The duration or validity period of the consent\n\nThe ITI-108 transaction SHOULD be invoked as part of the actions triggered by a Generate VHL request, particularly when legal, jurisdictional, or organizational policy requires explicit, recorded consent prior to enabling document sharing.\n\nThis requirement enables lawful, transparent sharing of personal health information across organizations and trust domains.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RequestPKIMaterial"
},
"name": "Request PKI material",
"description": "A [VHL Sharer](ActorDefinition-VHLSharer.html) or [VHL Receiver](ActorDefinition-VHLReceiver.html), as a participant in the trust network, SHALL be capable of requesting public key infrastructure (PKI) material from a designated [Trust Anchor](ActorDefinition-TrustAnchor.html).\n\nThe retrieved material MAY include:\n* Public key certificates and associated trust lists\n* Certificate revocation data (e.g., CRLs, OCSP responses)\n* Metadata used to:\n - Validate digital signatures on VHLs and related resources\n - Establish mutually authenticated TLS (mTLS) connections\n - Decrypt content protected via asymmetric encryption\n\nParticipants SHOULD cache the received trust list to reduce network and server load.\n\n**Preconditions:**\n* The requesting participant knows in advance the endpoint from which to retrieve PKI material, as published or distributed by the Trust Anchor.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RequestVHL"
},
"name": "Request that a VHL authorization mechanism be issued",
"description": "A [VHL Holder](ActorDefinition-VHLHolder.html) initiates a request to a [VHL Sharer](ActorDefinition-VHLSharer.html) to generate a Verified Health Link (VHL) that references one or more health documents. The resulting VHL allows the Holder to subsequently share access to those documents with a [VHL Receiver](ActorDefinition-VHLReceiver.html).\nThe Holder MAY include optional parameters to constrain or protect the issued VHL-such as defining an expiration period, scoping which documents are included, or requiring a passcode for retrieval. These parameters guide the Sharer's issuance of the VHL and influence the conditions under which the associated documents may be accessed.\n\n**Preconditions:**\n * The [VHL Holder](ActorDefinition-VHLHolder.html) SHALL trust that the [VHL Sharer](ActorDefinition-VHLSharer.html) has been authorized by its jurisdiction to generate VHLs and to provide access to the corresponding health documents.\n * Optionally, the [VHL Holder](ActorDefinition-VHLHolder.html) has selected consent directives or selective disclosure preferences, as permitted by the applicable content profile.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RequestVHLDocument"
},
"name": "Request VHL Document",
"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.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/RequestVHLDocuments"
},
"name": "Request VHL Documents",
"description": "The [VHL Receiver](ActorDefinition-VHLReceiver.html) SHALL initiate a request to retrieve a set of health documents 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 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.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/SubmitPKIMaterial"
},
"name": "Submit PKI Material",
"description": "When a [VHL Sharer](ActorDefinition-VHLSharer.html) or [VHL Receiver](ActorDefinition-VHLReceiver.html) generates a new public-private key pair for use within the VHL trust network, they SHALL submit the corresponding public key material to the [Trust Anchor](ActorDefinition-TrustAnchor.html) for validation and inclusion in the trust list.\n\nThe submission MAY include metadata to support categorization of key usage (e.g., digital signatures, encryption, mTLS) and business or operational context.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/TrustAnchor"
},
"name": "Trust Anchor",
"description": "An authorized organization in the trust framework that manages and distributes PKI material—such as public key certificates and revocation lists—to participants in the network. It ensures that this material is trustworthy and available, enabling VHL Sharers and VHL Receivers to verify digital signatures and authenticate the origin of shared data.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
}
],
"reference": {
"reference": "CapabilityStatement/IHE.VHL.TrustAnchor"
},
"name": "Trust Anchor",
"description": "CapabilityStatement for Trust Anchor Actor in the IHE IT Infrastructure Technical Framework Supplement IHE VHL. An authorized organization in the trust framework that manages and distributes PKI material—such as public key certificates and revocation lists—to participants in the network. It ensures that this material is trustworthy and available, enabling VHL Sharers and VHL Receivers to verify digital signatures and authenticate the origin of shared data.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ExampleScenario"
}
],
"reference": {
"reference": "ExampleScenario/UseCaseEVC"
},
"name": "UseCaseEVC",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Requirements"
}
],
"reference": {
"reference": "Requirements/VerifyDocumentSignature"
},
"name": "Verify Document Signature",
"description": "The [VHL Receiver](ActorDefinition-VHLReceiver.html), upon receiving a digitally signed health document from a [VHL Sharer](ActorDefinition-VHLSharer.html), MAY verify the document's digital signature using previously retrieved PKI material.\n\nThis verification process confirms the authenticity, integrity, and provenance of the document independently of the Verified Health Link (VHL) itself.\n\nThe public key used for this verification MAY:\n* Originate from a different trust network than the one used to validate the VHL\n* Be unrelated to the key used to validate the VHL signature\n\nImplementers SHOULD consult cross-profile guidance regarding interoperability with the [IHE Document Digital Signature (DSG) profile](https://profiles.ihe.net/ITI/TF/Volume1/ch-37.html), particularly in cases where additional attestation, long-term non-repudiation, or multi-party signatures are involved.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/VHLHolder"
},
"name": "VHL Holder",
"description": "An individual—typically the patient or their delegate—who possesses a Verified Health Link (VHL), a signed data artifact that enables a VHL Receiver to verify its authenticity and access one or more health documents made available by a VHL Sharer.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/VHLReceiver"
},
"name": "VHL Receiver",
"description": "A system or organization that receives a Verified Health Link (VHL) from a VHL Holder and uses it to retrieve health documents from a VHL Sharer, after verifying the authenticity and integrity of the VHL.",
"exampleBoolean": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ActorDefinition"
}
],
"reference": {
"reference": "ActorDefinition/VHLSharer"
},
"name": "VHL Sharer",
"description": "The VHL Sharer generates a VHL, provides the VHL to a VHL Holder, and responds to requests from a VHL Sharer to utilize the VHL.",
"exampleBoolean": false
}
],
"page": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "toc.html"
}
],
"nameUrl": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "index.html"
}
],
"nameUrl": "index.html",
"title": "ToDo Home",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "volume-1.html"
}
],
"nameUrl": "volume-1.html",
"title": "1:XX Verifiable Health Links (VHL) - Volume 1",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "volume-2.html"
}
],
"nameUrl": "volume-2.html",
"title": "2: Verifiable Health Links (VHL) - Volume 2",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "volume-3.html"
}
],
"nameUrl": "volume-3.html",
"title": "3:3 Verifiable Health Links (VHL) - Volume 3",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "testplan.html"
}
],
"nameUrl": "testplan.html",
"title": "Test Plan",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "other.html"
}
],
"nameUrl": "other.html",
"title": "Changes to Other IHE Specifications",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "vhl_vs_shl.html"
}
],
"nameUrl": "vhl_vs_shl.html",
"title": "Appendix A: Comparision of health links",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "download.html"
}
],
"nameUrl": "download.html",
"title": "Download and Analysis",
"generation": "markdown"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name",
"valueUrl": "issues.html"
}
],
"nameUrl": "issues.html",
"title": "Significant Changes and Issues",
"generation": "markdown"
}
]
},
"parameter": [
{
"code": "path-resource",
"value": "input/resources"
},
{
"code": "path-resource",
"value": "fsh-generated/resources"
},
{
"code": "path-resource",
"value": "input/examples"
},
{
"code": "path-resource",
"value": "input/capabilities"
},
{
"code": "path-resource",
"value": "input/extensions"
},
{
"code": "path-resource",
"value": "input/models"
},
{
"code": "path-resource",
"value": "input/operations"
},
{
"code": "path-resource",
"value": "input/profiles"
},
{
"code": "path-resource",
"value": "input/vocabulary"
},
{
"code": "path-resource",
"value": "input/testing"
},
{
"code": "path-resource",
"value": "input/history"
},
{
"code": "path-pages",
"value": "template/config"
},
{
"code": "path-pages",
"value": "input/images"
},
{
"code": "path-tx-cache",
"value": "input-cache/txcache"
}
]
}
}