This page is part of the SMART Verifiable IPS for Pilgrimage (v2.0.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Home

Official URL: http://smart.who.int/ips-pilgrimage/ImplementationGuide/smart.who.int.ips-pilgrimage				Version: 2.0.2
Active as of 2025-02-13				Computable Name: SMART_WHO_INT_IPS_Pilgrimage

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

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 References 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:

• Home - contains references to the guidance, guidelines, policies and recommendations underpinning this implementation guide.
• Business Requirements - contains the requirements for this implementation guide including the definition of key concepts, use cases, and a data dictionary.
• Data Models and Exchange - contains the data models and data exchange protocols with actors and transactions defined.
• Deployment Guidance - contains relevant technical specifications and guidance, testing resources, reference implementation materials, and supporting guidance for adaptation to local contexts.

This guide assumes use of the following resources:

• MHD Folder
• IPS Patient
• IPS Immunization

• CPG ActivityDefinitions

• For a complete listing of the artifacts defined in this implementation guide, refer to the Artifact Index.
• A complete offline copy of this implementation guide can be found on the Downloads page.
• This guide utilizes the International Patient Summary(IPS) as a base for defining immunizations and expects that most data captured will be presented in conformance with the resources defined as part of that implementation guide.
• This Implementation Guide makes use of Clinical Quality Language for the decision support artifacts including the PlanDefinitions and Measures. They are used to express how a calculation should occur and can be used with a CQL engine in order to process the decision or indicator directly from the applicable FHIR resources. Links to this specification, the FHIR Clinical Practice Guidelines Specification, and other helpful resources can be found in the Support dropdown.

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

This publication includes IP covered under the following statements.

• Copyright HL7. Licensed under creative commons public domain
  Show Usage
  • degreeLicenseCertificate: Bundle/MyIPS and Practitioner/1c616b24-3895-48c4-9a02-9a64110351ee
• Some content from IHE® Copyright © 2015 IHE International, Inc .
  Show Usage
  • IHE Format Code set for use with Document Sharing: DocumentReference/FHIRIPSSignedDocumentReference, DocumentReference/IPSPDFDocumentReference and DocumentReference/IPSSignedPDFDocumentReference
• The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  • Unified Code for Units of Measure (UCUM): Bundle/MyIPS, MedicationStatement/c220e36c-eb67-4fc4-9ba1-2fabc52acec5 and Observation/cc354e00-a419-47ea-8b6c-1768b2a01645
• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: Bundle/MyIPS, Composition/ExampleComposition... Show 13 more, Condition/c4597aa2-688a-401b-a658-70acc6de28c5, Condition/c64139e7-f02d-409c-bf34-75e8bf23bc89, DocumentReference/FHIRIPSDocumentReference, DocumentReference/IPSPDFDocumentReference, DocumentReference/ex-documentreference, DocumentReference/ex-documentreference1, HajjIPSComposition, Observation/26bee0a9-5997-4557-ab9d-c6adbb05b571, Observation/6e39ccf3-f997-4a2b-8f28-b4b71c778c79, Observation/a6a5a1d5-c896-4c7e-b922-888fcc7e6ae3, Observation/aa11a2be-3e36-4be7-b58a-6fc3dace2740, Observation/b4916505-a06b-460c-9be8-011609282456 and Observation/cc354e00-a419-47ea-8b6c-1768b2a01645
• This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): AllergyIntolerance/72884cad-ebe6-4f43-a51a-2f978275f131, Bundle/MyIPS... Show 9 more, Condition/c4597aa2-688a-401b-a658-70acc6de28c5, Condition/c64139e7-f02d-409c-bf34-75e8bf23bc89, Medication/8adc0999-9468-4ac9-9557-680fa133d625, Medication/976d0804-cae0-45ae-afe3-a19f3ceba6bb, Observation/26bee0a9-5997-4557-ab9d-c6adbb05b571, Observation/6e39ccf3-f997-4a2b-8f28-b4b71c778c79, Observation/a6a5a1d5-c896-4c7e-b922-888fcc7e6ae3, Observation/aa11a2be-3e36-4be7-b58a-6fc3dace2740 and Observation/b4916505-a06b-460c-9be8-011609282456
• This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  • AllergyIntolerance Clinical Status Codes: AllergyIntolerance/72884cad-ebe6-4f43-a51a-2f978275f131 and Bundle/MyIPS
  • AllergyIntolerance Verification Status: AllergyIntolerance/72884cad-ebe6-4f43-a51a-2f978275f131 and Bundle/MyIPS
  • Condition Clinical Status Codes: Bundle/MyIPS, Condition/c4597aa2-688a-401b-a658-70acc6de28c5 and Condition/c64139e7-f02d-409c-bf34-75e8bf23bc89
  • ConditionVerificationStatus: Bundle/MyIPS, Condition/c4597aa2-688a-401b-a658-70acc6de28c5 and Condition/c64139e7-f02d-409c-bf34-75e8bf23bc89
  • Consent Scope Codes: Bundle/MyIPS, Consent/c7781f44-6df8-4a8b-9e06-0b34263a47c6 and HajjConsent
  • DoseAndRateType: Bundle/MyIPS and MedicationStatement/c220e36c-eb67-4fc4-9ba1-2fabc52acec5
  • Observation Category Codes: Bundle/MyIPS, Observation/2639657a-c19a-48e2-82cc-471e13b8ad93... Show 6 more, Observation/26bee0a9-5997-4557-ab9d-c6adbb05b571, Observation/6e39ccf3-f997-4a2b-8f28-b4b71c778c79, Observation/a6a5a1d5-c896-4c7e-b922-888fcc7e6ae3, Observation/aa11a2be-3e36-4be7-b58a-6fc3dace2740, Observation/b4916505-a06b-460c-9be8-011609282456 and Observation/cc354e00-a419-47ea-8b6c-1768b2a01645
  • Organization type: Bundle/MyIPS and Laboratoire de charme
  • ActClass: Bundle/MyIPS, Composition/ExampleComposition and HajjIPSComposition
  • ActReason: DocumentReference/FHIRIPSDocumentReference, DocumentReference/FHIRIPSSignedDocumentReference... Show 5 more, DocumentReference/IPSPDFDocumentReference, DocumentReference/IPSSignedPDFDocumentReference, DocumentReference/ex-documentreference, DocumentReference/ex-documentreference1 and List/PilgrimFolder
  • ParticipationType: HajjConsent
  • RoleCode: Bundle/MyIPS and Patient/2b90dd2b-2dab-4c75-9bb9-a355e07401e7

Cross-version analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (smart.who.int.ips-pilgrimage.r4) and R4B (smart.who.int.ips-pilgrimage.r4b) are available.

Dependencies

Package hl7.fhir.uv.extensions.r4#5.2.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Package hl7.fhir.uv.extensions.r4#1.0.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.uv.cql#1.0.0 This implementation guide defines profiles, operations and guidance for the use of CQL with FHIR, both as a mechanism for querying, as well as inline and integrated usage as part of knowledge artifacts. (built Fri, May 31, 2024 14:18+0000+00:00)

Package hl7.fhir.uv.crmi#1.0.0 This implementation guide defines profiles, operations, capability statements and guidance to facilitate the content management lifecycle for authoring, publishing, distribution, and implementation of FHIR knowledge artifacts such as value sets, profiles, libraries, rules, and measures. The guide is intended to be used by specification and content implementation guide authors as both a dependency for validation of published artifacts, and a guide for construction and publication of content. (built Fri, May 31, 2024 16:38+0000+00:00)

Package hl7.fhir.uv.sdc#3.0.0 The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. This includes two components: * Support more sophisticated questionnaire/form use-cases such as those needed for research, oncology, pathology and other clinical domains. *Support pre-population and auto-population of EHR data into forms/questionnaires for uses outside direct clinical care (patient safety, adverse event reporting, public health reporting, etc.). (built Tue, Mar 8, 2022 18:32+0000+00:00)

Package smart.who.int.base#0.1.0 Base SMART Guidelines implementation guide to be used as the base dependency for all SMART Guidelines IGs (built Fri, Sep 20, 2024 13:43+0000+00:00)

Package ihe.iti.balp#1.1.0 The Basic Audit Log Patterns (BALP) Implementation Guide is a Content Profile that defines some basic and reusable AuditEvent patterns. This includes basic audit log profiles for FHIR RESTful operations to be used when there is not a more specific audit event defined. A focus is enabling Privacy centric AuditEvent logs that hold well formed indication of the Patient when they are the subject of the activity being recorded in the log. Where a more specific audit event can be defined it should be derived off of these basic patterns. (built Wed, May 4, 2022 10:07-0500-05:00)

Package ihe.iti.mcsd#3.8.0 The IHE Mobile Care Services Discovery (mCSD) IG provides a transaction for mobile and lightweight browser-based applications to find and update care services resources. (built Fri, Aug 12, 2022 09:41-0500-05:00)

Package hl7.fhir.uv.ips#1.1.0 International Patient Summary (IPS) FHIR Implementation Guide (built Tue, Nov 22, 2022 03:24+0000+00:00)

Package hl7.fhir.uv.cpg#2.0.0 Implementation guidance for creating Clinical Practice Guidelines with formal artifacts to facilitate sharing and implementation of the guideline (built Tue, Nov 26, 2024 16:14+0000+00:00)

Package ihe.iti.pcf#1.1.0 The Privacy Consent on FHIR (PCF) Profile provides support for patient privacy consents and access control where a FHIR API is used to access Document Sharing Health Information Exchanges. (built Thu, Feb 22, 2024 13:50-0600-06:00)

Package ihe.iti.mhd#4.2.2 ImplementationGuide for IHE IT Infrastructure Technical Framework Supplement Mobile access to Health Documents (MHD) (built Sat, May 18, 2024 12:30-0500-05:00)

Globals

There are no Global profiles defined