This page is part of the SMART Verifiable IPS for Pilgrimage (v1.0.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Transactions

This page describes the specific transactions that are refereAAnced in the sequence diagrams defined by this implementation guide.

Other transactions utilized by this implementation guide my be found:

Publish Verification Keys

Trigger Events

Message Semantics

The OCHIE SHALL use one of the following transactions:

• Publish Verification Keys - API

  Expected Actions

Retrieve Verification Keys

Trigger Events

Message Semantics

The HCEMR SHALL use one of the following transactions:

• Retrieve Verification Keys - DID
• Retrieve Verification Keys - API

  Expected Actions

  The HCEMR shall use the verificaiton keys to verify the provance of the Verificable Smart Health Link and the Verifable IPS

Sign Smart Health Link

Trigger Events

Once a Smart Health Link has been generated, it SHALL be signed.

Message Semantics

Use the Sign Health Certificate Claim transaction.

Expected Actions

One the Smart Health Link has been signed, it is a Verifiable Smart Health Link which should be provided to the Pilgrim.

Sign IPS

Trigger Events

Once the OCHIE has generated an International Patient Summary (IPS) document.

Message Semantics

The OCHIE SHALL use one of the following:

• the IHE Document Digital Signature (DSG) profile for XML-singatures
• the IHE Document Digital Signature - JSON (DSGj)(forthcoming) profile for JSON-singatures

Expected Actions

Once the IPS has been signed it is now a Verififable Digital Health Certificate and SHALL be available for retrieval via a Smart Health Link.

Retrieve SHL IPS Viewer

Trigger Events

Message Semantics

Expected Actions

Retrieve SHL IPS Manifest

Trigger Events

Initatied by the HCEMR once a Smart Health Link provided by a Pilgrim has been scanned.

Message Semantics

See the Smart Health Link - Manifest specifcation with the following modifications:

• The contentType entry MAY also include the value “application/pdf” in the case that the corresponding location entry of the Smart Health Link is for a PDF rendering of the Verifiable IPS.
• The contentType entry MAY also include the value “text/html” in the case that the corresponding location entry of the Smart Health Link is for an external viewing portal for the Verifiable IPS.
• The contentType entry MAY also include the value “text/html” in the case that the corresponding location entry of the Smart Health Link is a Verifiable IPS

Expected Actions

Record Consent - Post-Counseling

Trigger Events

Consent can be recorded based on a post counseling based on a blanket jurisdictional policy.

Message Semantics

The OCHIE shall support create and update per the IHE PCF Consent Recorder Capability Statement.

Expected Actions

The OCHIE SHALL act as IHE PCF Consent Recorder

Record Consent - Digital Health Wallet

Trigger Events

Consent record based on individual’s interaction with their digital health wallet.

Message Semantics

The OCHIE shall support create and update per the IHE PCF Consent Recorder Capability Statement.

Expected Actions

The OCHIE SHALL act as IHE PCF Consent Recorder