Official URL: Version: 2.1.0
DraftComputable Name: SMART_WHO_INT_IPS_Pilgrimage

The story in one sentence
Kamal, 61, falls ill in Nalemi on his first pilgrimage, and a Taifafeki doctor reads his medicines and allergies from his Onesan health summary, checked as genuine through WHO GDHCN.

One pilgrim and the people around him, eight moments, one pilgrimage season. Follow the people first; the technology is what makes each hand-off possible.

▷ Start the walkthroughSee the whole journey map →Overview, people and policy questions

This Implementation Guide is intended to support the utilization of verifiable International Patient Summary (IPS) documents during pilgrimage, leveraging WHO Global Digital Health Certification Network (GDHCN) global public health infrastructure.

This implementation guide and set of artifacts are still undergoing development.


Eight moments that matter

P0 · Before the season — keys and codes are shared
Before the season — keys and codes are shared
Before the pilgrimage season · Lomaru and WHO GDHCN · P0

Before anyone travels, Onesa's signing keys and code systems reach the trust network, so a Taifafeki clinic can trust and read an Onesan record months later.

Walk through it · ArchiMate view
P1 · The health check and the choice to share
The health check and the choice to share
Three months before the pilgrimage · A GP clinic in Tanavu · P1

Kamal is found fit to travel, hears who can see his Pilgrimage Health Record and for how long, and agrees on his wallet to share it.

Walk through it · ArchiMate view
P2 · His summary is assembled and signed
His summary is assembled and signed
Before departure · Onesa's HIE; Kamal's home · P2

Onesa's HIE turns Kamal's care history into a signed patient summary and puts the link to it in his wallet as a QR code.

Walk through it · ArchiMate view
P3 · Taken ill in Nalemi
Taken ill in Nalemi
Second day in Nalemi · A pilgrimage health facility in Nalemi · P3

Dizzy in the heat of Nalemi, Kamal is brought to the pilgrimage health facility by Salmah and shows his QR code at registration.

Walk through it · ArchiMate view
P4 · Scanned and checked
Scanned and checked
Second day in Nalemi · Registration, pilgrimage health facility, Nalemi · P4

Nurse Reem scans the code and enters the passcode; the EMR checks the signature with Onesa's key from GDHCN.

Walk through it · ArchiMate view
P5 · His record is read and he is treated
His record is read and he is treated
Second day in Nalemi · Treatment bay, pilgrimage health facility, Nalemi · P5

The EMR retrieves Kamal's summary from Onesa; Dr Faisal sees the insulin and the penicillin allergy before he treats him.

Walk through it · ArchiMate view
P6 · When he cannot show the code (break the glass)
When he cannot show the code (break the glass)
The day of Toreva · A health tent at Toreva · P6

Kamal is brought in unconscious with no one to show his code; Dr Hafiz gives his pilgrimage registration number and the facility reaches his summary through it.

Walk through it · ArchiMate view
P7 · Back home
Back home
After the season · A GP clinic in Tanavu · P7

Kamal is home and well, but his GP does not know he was treated in Nalemi.

Walk through it · ArchiMate view


The user scenarios of this guide told as one pilgrim’s story, step by step along the overview of key process flows (the numbered steps 1–5 and A–B of the figure below). Click a picture to walk through that moment in the journeys viewer, which names who takes part, what in this guide specifies it, and the policy question it raises.

Every person in this story, and both countries, are fictional. Kamal comes from Onesa (code XXK) and goes on pilgrimage in Taifafeki (code XXR): two fictional countries shared with the SMART Trust demo, whose codes are ISO 3166-1 user-assigned codes, so they never name a real country. The steps follow this guide’s real Malaysian reference implementation, Malaysia’s Hajj Health Card, as a policy precedent.

Overview of key process flows Home Country: the ArchiMate view of these flowsHomeCountry Host Country: the ArchiMate view of these flowsHostCountry Origin Country Wallet (IG system actor OCHW): role origin-walletOrigin Country Wallet Origin Country HIE (IG system actor OCHIE): role origin-hieHealth Information ExchangeOrigin Country HIE Host Country Health Worker (IG persona): role host-health-workerHost Country HealthWorker Host Country EMR (IG system actor HCEMR): role host-emrHost Country EMR Pilgrim (IG persona): role pilgrimPilgrim WHO GDHCN: role trust-networkWHO GDHCN Step 2: its moment of the pilgrim's journey2 Transaction doc-sign (IPS.HAJJ.TRANSACTION)IPS generated from patient carehistory in Home country Step 5: its moment of the pilgrim's journey5 Transaction doc-get (IPS.HAJJ.TRANSACTION)EMR retrieves IPS from Homecountry HIE Step A: its moment of the pilgrim's journeyA Transaction keys-put (IPS.HAJJ.TRANSACTION)IPS verification keys published toGDHCN Step 4: its moment of the pilgrim's journey4 Transaction shl-get-manifest (IPS.HAJJ.TRANSACTION)Health worker scans IPS QR code intheir EMR Step 1: its moment of the pilgrim's journey1 Transaction consent-wallet (IPS.HAJJ.TRANSACTION)Pilgrim configures access to IPSvia QR code on national healthwallet Step 3: its moment of the pilgrim's journey3 Step 3: its moment of the pilgrim's journeyPilgrim seeks care and shows IPSQR code to health worker Step B: its moment of the pilgrim's journeyB Transaction keys-get (IPS.HAJJ.TRANSACTION)Verification keys retrieved by EMRto ensure provenance of IPS
Overview of key process flows, from this guide's ArchiMate model. Each picture is a role of the guide (its actor or persona), and each numbered flow is a moment of the pilgrim's journey.

Each numbered flow in the figure names its moment above, and each moment has its own ArchiMate view.

The people

Person Who they are Generic persona
Kamal 61, from Tanavu, Onesa, going on pilgrimage for the first time. Has type 2 diabetes and high blood pressure; takes insulin and two tablets a day; allergic to penicillin. Carries one phone. Pilgrim
Salmah Kamal’s wife, travelling with him. Speaks for him when he cannot. Accompanying family member (not yet a persona here)
Dr Aisyah General practitioner in Tanavu, empanelled by the national pilgrimage authority for pre-pilgrimage health examinations. Counsellor
Dr Hafiz Doctor of the Onesan pilgrimage medical team, travelling with the pilgrims. Accompanying Clinician from Origin Country
Nurse Reem Registration nurse at a pilgrimage health facility in Nalemi. Host Country Health Worker
Dr Faisal Emergency physician at the same facility. Host Country Health Worker

And the systems: Kamal’s national health wallet (Origin Country Wallet), Onesa’s health information exchange (Origin Country HIE), the facility’s EMR (Host Country EMR), and WHO GDHCN, the trust network both countries take part in.

What the story shows the guide still needs

  1. Business processes for P0 (keys and terminologies), P2 (assembling the IPS) and P6 (break the glass).
  2. The two pilgrim forms named in P1, and a page for the pilgrim and counsellor actors: their actor files exist but no page includes them.
  3. One passcode policy (P4), stated once.
  4. An account of access back to the home country (P5, P7), and of language (P5).
  5. Example patients that are pilgrims: today’s examples are a resident of the Netherlands.
  6. The data dictionary, decision logic, indicators and functional requirements, which are still placeholders.

Summary

This implementation guide includes a machine-readable representation of WHO guidelines for verifiable IPS during pilgrimage. It explicitly encodes computer-interoperable logic, including data models, terminologies, and logic expressions, in a computable language to support implementation of IPS during pilgrimage usage scenario. This Implementation Guide leverages the WHO Global Digital Health Certification Network (GDHCN).

The guide is part of the WHO SMART Guidelines approach to support countries to integrate WHO global health and data recommendations into digital systems accurately and consistently. It defines a series of FHIR Resources, Profiles, Extensions, and Terminology.

Supporting guidance, recommendations, resources, and standards are included in the Bibliography and Dependencies.

Eligible Participants may request to join through the The Letter of Application

About this implementation guide

This implementation guide is broken into the following levels of knowledge representation:

This guide assumes use of the following resources:


Disclaimer

The specification herewith documented is a demo working specification and may not be used for any implementation purposes. This draft is provided without warranty of completeness or consistency and the official publication supersedes this draft. No liability can be inferred from the use or misuse of this specification or its consequences.

IP statements

⟦not rendered: ip-statements.xhtml⟧ — the IG Publisher renders it from a source this build does not hold; no renderer was given to this build.

Cross-version analysis

⟦not rendered: cross-version-analysis.xhtml⟧ — the IG Publisher renders it from a source this build does not hold; no renderer was given to this build.

Dependencies

IGPackageFHIRComment
hl7.terminology.r4 hl7.terminology.r4#7.5.0 not in the package cache this build read, so what it depends on is not shown
hl7.fhir.uv.extensions.r4 hl7.fhir.uv.extensions.r4#5.4.0 not in the package cache this build read, so what it depends on is not shown
smart.who.int.base smart.who.int.base#0.1.0 not in the package cache this build read, so what it depends on is not shown
ihe.iti.mcsd ihe.iti.mcsd#3.8.0 not in the package cache this build read, so what it depends on is not shown
hl7.fhir.uv.ips hl7.fhir.uv.ips#1.1.0 not in the package cache this build read, so what it depends on is not shown
hl7.fhir.uv.sdc hl7.fhir.uv.sdc#3.0.0 not in the package cache this build read, so what it depends on is not shown
hl7.fhir.uv.cpg hl7.fhir.uv.cpg#2.0.0 not in the package cache this build read, so what it depends on is not shown
ihe.iti.pcf ihe.iti.pcf#1.1.0 not in the package cache this build read, so what it depends on is not shown
ihe.iti.mhd ihe.iti.mhd#4.2.2 not in the package cache this build read, so what it depends on is not shown

Globals

There are no Global profiles defined.

Edit this page on GitHub