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

CapabilityStatement: VHL Sharer Server Capability Statement

Official URL: http://profiles.ihe.net/ITI/VHL/CapabilityStatement/vhl-sharer-server Version: 0.0.2-current
Active as of 2024-01-15 Computable Name: VHLSharerCapabilityStatement

Capability Statement for a VHL Sharer implementing the Retrieve Manifest [ITI-YY5] transaction as a server. This server supports FHIR search on List resources with _include parameter to retrieve document manifests authorized by Verified Health Links.

Raw OpenAPI-Swagger Definition file | Download

VHL Sharer Server Capability Statement

  • Implementation Guide Version: 0.0.2-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Published on: 2024-01-15
  • Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

VHL Sharer provides access to document manifests (List resources) and references (DocumentReference resources) authorized by Verified Health Links (VHLs). Authorization is based on validated VHL tokens containing manifest URLs with folder IDs.

Security

Implementations SHALL support ATNA Authenticate Node [ITI-19] for mutual TLS authentication. VHL-based authorization is required (folder ID in _id parameter), optionally supplemented by OAuth 2.0 or other token-based authentication.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Listhttp://hl7.org/fhir/StructureDefinition/Listy_id, identifier, patient, code, statusList:item
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReferencey
Base System Profile
List
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    search-type

    Search for List resources by folder ID, identifier, patient, code, or status. Used to retrieve document manifests authorized by VHLs. This transaction uses HTTP POST to the _search endpoint to securely transmit authorization parameters.

Documentation

The List resource represents a folder or collection of documents authorized by a VHL. The List.id (folder ID) has 256-bit entropy and serves as the authorization token. List.entry.item contains references to DocumentReference resources.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Folder ID with 256-bit entropy from the VHL. This is the primary authorization mechanism. SHALL be supported.

SHALLidentifiertoken

Business identifier for the List/folder. SHOULD be supported.

SHALLpatientreference

The patient whose documents are referenced in the List. SHOULD be supported. The VHL Sharer SHALL accept chained searches on patient.identifier (e.g., patient.identifier=system|value) for List searches.

SHALLcodetoken

The type of List, typically 'folder' from MHD CodeSystem. SHOULD be supported.

SHALLstatustoken

The status of the List (current, retired, etc.). SHOULD be supported.

 
Base System Profile
DocumentReference
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read DocumentReference by ID. May be used after Retrieve Manifest to get updated metadata.

Documentation

DocumentReference resources are included in search results via the _include parameter. They are not directly searchable in this transaction but are returned as part of the List search response.