These are the transactions defined for ips-pilgrimage

The Record Consent Request Event transaction is initiated by a Origin Country Health Solution against the Origin Country HIE. This transaction shall follow the IHE PCF record consent (ITI-108) transaction. The Origin Country Health Wallet acts as the Consent Record actor role and the Origin Country HIE acts as the Consent Registry actor role.

⟦not rendered: send_consent_request.svg⟧ — the IG Publisher renders it from input/images-source/send_consent_request.plantuml; no renderer was given to this build.

Trigger Events

Message Semantics

Message Semantics Request
Message Semantics Response

Expected Actions

issue VHL - request

The issue VHL Request Event transaction is initiated by a Origin Country Health Wallet against the Origin Country HIE.

⟦not rendered: issue_shl_request.svg⟧ — the IG Publisher renders it from input/images-source/issue_shl_request.plantuml; no renderer was given to this build.

Trigger Events

Message Semantics Request
Message Semantics Response

Expected Actions

The following are the expected actions for the Origin Country HIE once it receives the privacy configuration:

retrieve VHL folder docs - request

The Retrieve VHL folder docs Request Event transaction is initiated by the Host Country EMR against the Origin Country HIE.

⟦not rendered: retrieve_MHD_folder_request.svg⟧ — the IG Publisher renders it from input/images-source/retrieve_MHD_folder_request.plantuml; no renderer was given to this build.

Trigger Events

Message Semantics

Message Semantics Request
Message Semantics Response
Authentication of the Host Country EMR

The retrieve VHL folder docs request corresponds to the IHE Verifiable Health Link (VHL) Retrieve Manifest transaction [ITI-YY5]. VHL is cited here at version 1.0.0-comment, which is a public-comment ballot, not a final or trial-implementation publication; its text and section numbers may change. The sections cited below were read from the IHE/ITI.VHL source (commit 48201473), not from the published ballot pages.

VHL [ITI-YY5] names three options by which the VHL Receiver (here, the Host Country EMR) authenticates to the VHL Sharer (here, the Origin Country HIE):

This guide currently shows the Host Country EMR authenticating to the Origin Country HIE with mTLS node authentication ([ITI-19]) (see the unplanned care encounter sequence diagram). mTLS node authentication is not one of the three VHL authentication options. VHL still requires secure transport: ITI-YY5 §2:3.YY5.5.1 requires compliance with the IHE ATNA Profile for transport security, and VHL Volume 1 §1:XX.3 requires the VHL Receiver and the VHL Sharer to be grouped with an ATNA Secure Node or Secure Application. A TLS channel is therefore still expected, but on its own it does not satisfy any of the VHL authentication options.

It is recommended that the Host Country EMR authenticate with the OAuth with SSRAA Option. Like the current mTLS approach it is based on X.509 certificates: the Host Country EMR’s certificate chains to an anchor accepted in the ips-pilgrimage trust domain, so the Origin Country HIE identifies the receiver by that trust, not by looking up a separate agreement. Under that option, SSRAA discovery and registration are completed before an access token is requested (ITI-YY5 §2:3.YY5.4.1.4). How the Host Country EMR’s certificate or key is published in the ips-pilgrimage trust domain is not yet specified by this guide.

Expected Actions

Deciding the request: the pilgrim’s consents are the policy

For the pilgrimage there is no separate data sharing agreement to look up. The pilgrim’s two HajjConsent resources are the policy, and each one binds the party it names:

Which consent a Consent is, and the consent text the pilgrim was shown, are carried in Consent.policyRule: a code from the IPS.HAJJ.CONSENT CodeSystem, with coding.version set to the CodeSystem version.

The Host Country EMR is identified by trust in the ips-pilgrimage trust domain (see the authentication note in the message semantics). The Origin Country HIE releases the documents only when the passcode is valid, the VHL has not expired, the origin-release consent is active in its registry, the verified receiver matches Consent.provision.actor, the purpose is treatment, and the request falls within Consent.provision.period. If any of these cannot be established, the request is not permitted.

Audit event

The Origin Country HIE records an audit event with Record Audit Event [ITI-20] for each request, whether documents are released or refused. VHL Volume 1 §1:XX.3 requires the VHL Sharer and the VHL Receiver to be grouped with an ATNA Secure Node or Secure Application, and ITI-YY5 §2:3.YY5.5.6 says both SHOULD log document access requests, the authentication method used, the receiver identity, the VHL folder ID and the authorization decision. In this guide the audit event recorded by the Origin Country HIE shall also cite:

This guide uses no separate data sharing agreement for the pilgrimage, so the consents themselves are the policy the audit event cites. The Host Country EMR, as an ATNA Secure Node or Secure Application, should also audit what it receives.

retrieve IPS - request

The Retrieve IPS Request Event transaction is initiated by the Host Country EMR against the Origin Country HIE.

⟦not rendered: retrieve_IPS_request.svg⟧ — the IG Publisher renders it from input/images-source/retrieve_IPS_request.plantuml; no renderer was given to this build.

Trigger Events

Message Semantics

Message Semantics Request
Message Semantics Response

Expected Actions

Edit this page on GitHub