WHO Digital Documentation of COVID-19 Certificates: Vaccination Status (DDCC:VS)
0.2.1 - CI Build

This is the continuous build for version 0.2.1. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.

Transactions

Submit Health Event

The Submit Health Event transaction is initiated by a Digital Health Solution system against the DDCC:VS Generation Service.

Transaction: Submit Health EventDigitalHealthSolutionDDCC:VSGenerationService1.1.1Submit Health Event Request1.1.2Return Submit Health Event Response

Trigger Event

The Submit Health Event transaction may be initiated in any of the following ways:

Message Semantics

Message Semantics Request

The message semantics for the Register Health Certificate transaction utilizes a DDCC Submit Health Event Request which is a batch Bundle of Parameters for the Generate Health Certificate Operation which include DDCC Questionnaire Response resources for the request message. The specific DDCC Questionnaire Response resource is determined by the health event that is the subject of the transaction

Message Semantics Response

The response to a Register Health Certificate transaction is a DDCC Submit Health Event Response which consists of a Bundle of type batch-response following the FHIR specification for transaction responses.

Pre-conditions

The DDCC:VS Generation Service should have a Document Signing Certificate (DSC) issued by the Public Health Authority and registered with an approved Public Key Directory such as the National Public Key Directory.

When a jurisdiction participates in the Digital-Online scenario, the DSC should be registered with an approved Public Key Directory.

Expected Actions

The following are the expected actions for the actors participating in this transaction:

Store Health Certificate

The Store Health Certificagte transaction is initiated by a DDCC:VS Generation Service against the DDCC:VS Repository Service.

Transaction: Store Health CertificateDDCC:VSGenerationServiceDDCC:VSRepositoryService1.1.1Store Health Certificate Request1.1.2Return Store Health Certificate Response

Trigger Event

The Submit Health Event transaction may be initiated when a DDCC:VS Generation Service has received a Submit Health Event and needs to store the resulting DDCC Document in the DDCC:VS Repository Service.

Message Semantics

Message Semantics Request

The message semantics for the Store Health Certificate transaction utilizes a FHIR Create interaction to create a DDCC Document.

Message Semantics Response

The response to a Store Health Certificate transaction is documented in the FHIR create interaction.

Expected Actions

The following are the expected actions for the DDCC:VS Repository Service in this transaction:

  1. shall store the DDCC Document
  2. shall return the location of the DDCC Document

Register Health Certificate

The Register Health Certiciate transaction is initiated by a DDCC:VS Generation Service against the DDCC:VS Registry Service. This is based off of the Provide Document Bundle [ITI-65] transaction from the MHD profile.

Transaction: Register Health CertificateDDCC:VSGenerationServiceDDCC:VSRegistryService1.1.1Register Health Certificate Request1.1.2Register Health Certificate Response

Trigger Event

The Register Health Certificate transaction is initiated when a DDCC:VS Generation Service receives a valid Submit Health Event request from a Digital Health Solution system in a Digital-Online scenario.

Message Semantics

The DDCC:VS Generation Service will follow the message semantics from MHD's Provide Document Bundle transaction [ITI-65].

The DDCC:VS Generation Service will compose a DDCC Provide Document Bundle to submit to the DDCC:VS Registry Service.

Expected Actions

The actors will follow the expected actions from MHD's ITI-65.

Retrieve Health Certificate Reference

The Retrieve Health Certiciate transaction is used in the Digital-Online context and is used for the retrieval and optional verification of a single line of a DDCC.

The Retrieve Health Certificate transaction may be initiated by a Verifier against the DDCC:VS Registry Service in a jursidicition particpating in the Digital-Online scenario.

The Retrieve Health Certificate Reference transaction is based on MHD's Find Document References transaction [ITI-67]. It can be used to verify the existence of the Document Reference for the Immunization event. All message semantics and expected actions are the same as documented by MHD.

Transaction: Retrieve Health Certificate ReferenceVerifierDDCC:VSRegistryService1.1.1Retrieve Health Certificate Reference Request1.1.2Retrieve Health Certificate Reference Response

Trigger Event

The Retrieve Health Certificate Reference may be initiated by:

  1. a Verifier wishing to validate and verify a DDCC

Retrieve Health Certificate

The Retrieve Health Certiciate transaction is used in the Digital-Online context and is used for the retrieval and optional verification of a single line of a DDCC.

The Retrieve Health Certificate transaction may be initiated by a Verifier or Digital Health Solution against the DDCC:VS Repository Service in a jursidicition particpating in the Digital-Online scenario after retrieving the location from the Retrieve Health Certificate Reference or Retrieve Health Folder transactions.

The Retrieve Health Certificate transaction is based on MHD's Retrieve Document transaction [ITI-68]. It can be used to verify the contents of a DDCC Immunization event.

Transaction: Retrieve Health CertificateDigitalHealthSolutionVerifierDDCC:VSRepositoryServicealt[Digital Health Solution]1.1.1Retrieve Health Certificate Request1.1.2Retrieve Health Certificate Response[Verifier]1.1.3Retrieve Health Certificate Request1.1.4Retrieve Health Certificate Response

Trigger Event

The Retrieve Health Certificate may be initiated by:

  1. a Verifier wishing to validate and verify a DDCC
  2. a Digital Health Solution wishing to retrieve a DDCC for continuity of care

Retrieve Health Folder

The Retrieve Health Folder transaction is used in the Digital-Online context and is used for the retrieval and optional verification of DDCC contained in the DDCC Folder.

The Retrieve Health Folder transaction may be initiated by a Verifier or Digital Health Solution against the DDCC:VS Registry Service in a jursidicition particpating in the Digital-Online scenario.

The Retrieve Health Folder transaction is based on MHD's Find Document Lists transaction [ITI-66]. It can be used to find a DDCC Folder for a DDCC Patient with all the Immunization events.

Transaction: Retrieve Health FolderDigitalHealthSolutionVerifierDDCC:VSRegistryServicealt[Digital Health Solution]1.1.1Retrieve Health Folder Request1.1.2Retrieve Health Folder Response[Verifier]1.1.3Retrieve Health Folder Request1.1.4Retrieve Health Folder Response

Trigger Event

The Retrieve Health Folder may be initiated by:

  1. a Verifier wishing to validate and verify content of a DDCC
  2. a Digital Health Solution wishing to find a DDCC to update during a Submit Health Event transaction