GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build International flag

GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions

Artifact Index

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Requirements: Actor Definitions

The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.

Consent Registry

IHE PCF Consent Registry actor

Holder

Holder (person) of Verifiable Health Certificate or Verifiable Health Link

Issuer

Issuer (system) of Verifiable Health Certificate or Verifiable Health Link

Receiver

Receiver (system) of Verifiable Health Certificate or Verifiable Health Link

Trust Network Anchor

Trust Anchor which receives and distributes PKI-material within a Trust Network

Trust Network Participant

Trust Network Participant which publishes and or receives PKI-material within a Trust Network

Requirements: Formal Requirements

The following artifacts describe the specific requirements to be met by systems compliant with the implementation guide.

Accept mTLS

Accept an mTLS in order to conduct further transactions under a secure channel

Distribute PKI material

Make received trust material available through a distrubution point to a Trust Network Participant

Initiate mTLS

Initiate an mTLS in order to conduct further transactions under a secure channel

Provide VHL or VDHC

Is able to provide a VHL authorization mechanism or a VDHC to a VHL Receiver

Publish PKI material

Publish trust material to a Trust Anchor

Receive PKI material

Receive trust material from a Trust Network Participant, for distribution within the Trust Network

Receive VHL or VDHC

Is able to receive a VHL authorization mechanism or a VDHC from a Holder

Retrieve PKI material

Retrieve PKI material from a distribution point

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

DVC

Data elements for Digital Vaccination Certificate.

DVC - Vaccine Details

Vaccine Data elements for the Digital Vaccination Certificates

DVC HCERT Payload

Mininmial DVC payload for use within an HCERT Payload

DVC HCERT Payload for PreQual DB

DVC payload for a minimal DVC for use within an HCERT Payload using the WHO PreQual Vaccine Database

DVC HCert Vaccine Details (Minimal)

DVC Vaccine Details for a ininmial DVC payload for use within an HCERT Payload

DVC Vaccine Details with Selective Disclosure

DVC Vaccine Details with Selective Disclosure

DVCMinPreQual

DVC payload mininmized for use within an HCERT Payload with the WHO PreQual Vaccine Database

Health Link Payload (DRAFT)

Health Link Payload (DRAFT)

A Health Link URI is generated from this payload according to the algorithm documented here

PreQual

Data elements for the Digital Vaccine Certificate using WHO Vaccine PreQualification database

PreQual - Vaccine Details

Vaccine Data elements from the Pre Qual Database

SMART Health Link Payload (DRAFT)

SMART Health Link Payload (DRAFT)

This logical model constrains the Health Link Payload for a SMART Health Link

A SMART Health Link URI is generated from this payload according to the algorithm documented here

Smart Health Link (DRAFT)

Smart Health Link URI (DRAFT)

Logical Model to represent a SMART Health Link as its URI. It is generated from the content of the SMART Health Link Payload.

Verifiable Health Link Payload (DRAFT)

Verifiable Health Link Payload (DRAFT)

This logical model constrains the Health Link Payload for a Verifiable Health Link

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

DVC Model Questionnaire

Questionnaire for DVC Logical Model with the WHO PreQual DB

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

DVC - Profile for Digitial Vaccination Cards for Immunization for IPS. Note that no Product Catalog has been set

This profile represents an IPS Immunization record that can be mapped onto a Digital Vaccine Certificates using the WHO PreQual Database

DVC - WHO PreQual Immunization for IPS

This profile represents an IPS Immunization record that can be mapped onto a Digital Vaccine Certificates using the WHO PreQual Database

DVC Certificate - DVC Bundle for Digital Vaccine Certificates

Profile of the IPS Bundle for representing digital vaccination certificates

DVC Certificate - IPS Bundle for WHO PreQual Databae

Profile of the IPS Bundle for representing digital vaccination certificates from WHO PreQual Databae

DVC Certificate - IPS Composition

Profile of the IPS Composition for representing digital vaccination certificates with

DVC Certificate - IPS Composition for WHO PreQual Database

Profile of the IPS Composition for representing digital vaccination certificates with WHO PreQual Database

DVC Immunization

This profile represents a vaccination record for Digital Vaccine Certificates

DVC Immunization with Selective Disclosure

DVC Immunization with Selective Disclosure

DVC Patient

DVC Patient

DVC Patient with Selective Disclosure

DVC Patient with Selective Disclosure

DVC document Bundle with Selective Disclosure

DVC document Bundle with Selective Disclosure for each entry

Digital Vaccination Certificate - Bundle

Digital Vaccination Certificate - Bundle

Digital Vaccination Certificate - Composition

Digital Vaccination Certificate - Composition

Digital Vaccination Certificate - Composition

Digital Vaccination Certificate - Composition

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

DoseNumberCodeableConcept

Dose Number

SGActorExt

Smart Guidelines Actor Reference extension

SelectiveDisclosure

Guidance that a document signing service with selective disclosure support (e.g. SD-JWT) should perform a selective disclosure of the content of the containing node of the extension in the JSON representation of the FHIR instance.

The code value should be from a code system containing appropriate disclosure statements for the use case. The disclosure statement should describe the content that is to be disclosed at that node. For example a code such as 'disclose-date-of-birth' or 'disclose-vaccine-history'.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

DVC - Vaccines

This value set includes codes from ICD

Disclosure Statements

Disclosure Statements value set

HL.TYPE ValueSet

ValueSet of HL Type Codes

Relationship Status for Contact in Patient

Relationship Status for Contact in Patient

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Disclosure Statements

Disclosure Statement Code System

HL Type CodeSystem

CodeSystem for Health Link Type that has codes classifying type of Smart Health Link

Relationship Status for Contact in Patient

Relationship Status for Contact in Patient

Smart Guidelines Documentation Section

CodeSystem for Smart Guidelines Documentation Section to autogenerate documentation from artifacts

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

DVCDocExample

Example ICVP Document

DVCDocSDExample

Example ICVP Document

DVCExample

Example DVC model

GenerateVHL

A Holder requests an Issuer to generate a VHL