WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.1 - release International flag

This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.1: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: ExampleEnglish - JSON Representation

Raw json | Download

{
  "resourceType" : "Bundle",
  "id" : "ExampleEnglish",
  "meta" : {
    "profile" : [
      🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCVSDocument"
    ]
  },
  "identifier" : {
    "system" : "urn:EXAMPLE-who-:ddcc:bundle:ids",
    "value" : "9990123012301230123"
  },
  "type" : "document",
  "timestamp" : "2021-06-03T13:28:17-05:00",
  "link" : [
    {
      "relation" : "publication",
      "url" : "urn:HCID:1234567890"
    }
  ],
  "entry" : [
    {
      "fullUrl" : "http://www.example.org/fhir/Composition/DDCCCompositionExampleEnglish",
      "resource" : {
        "resourceType" : "Composition",
        "id" : "DDCCCompositionExampleEnglish",
        "meta" : {
          "profile" : [
            🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCVSComposition"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Composition_DDCCCompositionExampleEnglish\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Composition DDCCCompositionExampleEnglish</b></p><a name=\"DDCCCompositionExampleEnglish\"> </a><a name=\"hcDDCCCompositionExampleEnglish\"> </a><a name=\"DDCCCompositionExampleEnglish-en-US\"> </a><p><b>identifier</b>: <code>urn:EXAMPLE-who-:ddcc:composition:ids</code>/999123456123456123456\u00a0(use:\u00a0official,\u00a0)</p><p><b>status</b>: Final</p><p><b>type</b>: <span title=\"Codes:{http://loinc.org 82593-5}\">Immunization summary report</span></p><p><b>date</b>: 2020-05-06</p><p><b>author</b>: <a href=\"Organization-DDCCOrganizationEnglish.html\">Organization Government Hospital</a></p><p><b>title</b>: Digital Documentation of COVID-19 Certificate (DDCC)</p><h3>Attesters</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Mode</b></td><td><b>Party</b></td></tr><tr><td style=\"display: none\">*</td><td>Official</td><td><a href=\"Organization-DDCCOrganizationEnglish.html\">Organization Government Hospital</a></td></tr></table></div>"
        },
        "identifier" : {
          "use" : "official",
          "system" : "urn:EXAMPLE-who-:ddcc:composition:ids",
          "value" : "999123456123456123456"
        },
        "status" : "final",
        "type" : {
          "coding" : [
            {
              "system" : "http://loinc.org",
              "code" : "82593-5"
            }
          ]
        },
        "subject" : {
          🔗 "reference" : "Patient/DDCCPatientEnglish"
        },
        "date" : "2020-05-06",
        "author" : [
          {
            🔗 "reference" : "Organization/DDCCOrganizationEnglish"
          }
        ],
        "title" : "Digital Documentation of COVID-19 Certificate (DDCC)",
        "attester" : [
          {
            "mode" : "official",
            "party" : {
              🔗 "reference" : "Organization/DDCCOrganizationEnglish"
            }
          }
        ],
        "section" : [
          {
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "11369-6"
                }
              ]
            },
            "focus" : {
              🔗 "reference" : "Immunization/DDCCImmunizationEnglish"
            },
            "entry" : [
              {
                🔗 "reference" : "Immunization/DDCCImmunizationEnglish"
              },
              {
                🔗 "reference" : "ImmunizationRecommendation/DDCCImmunizationRecommendationEnglish"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl" : "http://www.example.org/fhir/Patient/DDCCPatientEnglish",
      "resource" : {
        "resourceType" : "Patient",
        "id" : "DDCCPatientEnglish",
        "meta" : {
          "profile" : [
            🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCPatient"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Patient_DDCCPatientEnglish\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Patient DDCCPatientEnglish</b></p><a name=\"DDCCPatientEnglish\"> </a><a name=\"hcDDCCPatientEnglish\"> </a><a name=\"DDCCPatientEnglish-en-US\"> </a><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">Aulus Agerius(official) (no stated gender), DoB: 2003-03-03</p><hr/></div>"
        },
        "name" : [
          {
            "use" : "official",
            "text" : "Aulus Agerius"
          }
        ],
        "birthDate" : "2003-03-03"
      }
    },
    {
      "fullUrl" : "http://www.example.org/fhir/Organization/DDCCOrganizationEnglish",
      "resource" : {
        "resourceType" : "Organization",
        "id" : "DDCCOrganizationEnglish",
        "meta" : {
          "profile" : [
            🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCOrganization"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Organization_DDCCOrganizationEnglish\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Organization DDCCOrganizationEnglish</b></p><a name=\"DDCCOrganizationEnglish\"> </a><a name=\"hcDDCCOrganizationEnglish\"> </a><a name=\"DDCCOrganizationEnglish-en-US\"> </a><p><b>name</b>: Government Hospital</p></div>"
        },
        "name" : "Government Hospital"
      }
    },
    {
      "fullUrl" : "http://www.example.org/fhir/Immunization/DDCCImmunizationEnglish",
      "resource" : {
        "resourceType" : "Immunization",
        "id" : "DDCCImmunizationEnglish",
        "meta" : {
          "profile" : [
            🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCImmunization"
          ]
        },
        "text" : {
          "status" : "extensions",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Immunization_DDCCImmunizationEnglish\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Immunization DDCCImmunizationEnglish</b></p><a name=\"DDCCImmunizationEnglish\"> </a><a name=\"hcDDCCImmunizationEnglish\"> </a><a name=\"DDCCImmunizationEnglish-en-US\"> </a><p><b>DDCC Event Brand for Immunization</b>: mms XM3DT5: XM3DT5</p><p><b>DDCC Country Of Event for Immunization</b>: CHE</p><p><b>DDCC Vaccine Market Authorization for Immunization</b>: <a href=\"CodeSystem-DDCCExampleTestCodeSystem.html#DDCCExampleTestCodeSystem-TEST\">DDCC Codes for examples TEST</a>: Test</p><p><b>DDCC Vaccine Valid From</b>: 2021-05-30</p><p><b>status</b>: Completed</p><p><b>vaccineCode</b>: <span title=\"Codes:{http://id.who.int/icd11/mms XM0GQ8}\">XM0GQ8</span></p><p><b>patient</b>: <a href=\"Patient-DDCCPatientEnglish.html\">Aulus Agerius(official) (no stated gender), DoB: 2003-03-03</a></p><p><b>occurrence</b>: 2021-05-06</p><p><b>location</b>: Vaccination Site</p><p><b>lotNumber</b>: 123</p><p><b>expirationDate</b>: 2021-06-30</p><h3>Performers</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Actor</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Organization-DDCCOrganizationEnglish.html\">Organization Government Hospital</a></td></tr></table><h3>ProtocolApplieds</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Authority</b></td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td><td><b>SeriesDoses[x]</b></td></tr><tr><td style=\"display: none\">*</td><td><a href=\"Organization-DDCCOrganizationEnglish.html\">Organization Government Hospital</a></td><td><span title=\"Codes:{http://id.who.int/icd11/mms RA01}\">RA01</span></td><td>1</td><td>2</td></tr></table></div>"
        },
        "extension" : [
          {
            "url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCEventBrand",
            "valueCoding" : {
              "system" : "http://id.who.int/icd11/mms",
              "code" : "XM3DT5"
            }
          },
          {
            "url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCountryOfEvent",
            "valueCode" : "CHE"
          },
          {
            "url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization",
            "valueCoding" : {
              "system" : "http://smart.who.int/ddcc/CodeSystem/DDCCExampleTestCodeSystem",
              "code" : "TEST"
            }
          },
          {
            "url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCVaccineValidFrom",
            "valueDate" : "2021-05-30"
          }
        ],
        "status" : "completed",
        "vaccineCode" : {
          "coding" : [
            {
              "system" : "http://id.who.int/icd11/mms",
              "code" : "XM0GQ8"
            }
          ]
        },
        "patient" : {
          🔗 "reference" : "Patient/DDCCPatientEnglish"
        },
        "occurrenceDateTime" : "2021-05-06",
        "location" : {
          "display" : "Vaccination Site"
        },
        "lotNumber" : "123",
        "expirationDate" : "2021-06-30",
        "performer" : [
          {
            "actor" : {
              🔗 "reference" : "Organization/DDCCOrganizationEnglish"
            }
          }
        ],
        "protocolApplied" : [
          {
            "authority" : {
              🔗 "reference" : "Organization/DDCCOrganizationEnglish"
            },
            "targetDisease" : [
              {
                "coding" : [
                  {
                    "system" : "http://id.who.int/icd11/mms",
                    "code" : "RA01"
                  }
                ]
              }
            ],
            "doseNumberPositiveInt" : 1,
            "seriesDosesPositiveInt" : 2
          }
        ]
      }
    },
    {
      "fullUrl" : "http://www.example.org/fhir/ImmunizationRecommendation/DDCCImmunizationRecommendationEnglish",
      "resource" : {
        "resourceType" : "ImmunizationRecommendation",
        "id" : "DDCCImmunizationRecommendationEnglish",
        "meta" : {
          "profile" : [
            🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCImmunizationRecommendation"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"ImmunizationRecommendation_DDCCImmunizationRecommendationEnglish\"> </a><p class=\"res-header-id\"><b>Generated Narrative: ImmunizationRecommendation DDCCImmunizationRecommendationEnglish</b></p><a name=\"DDCCImmunizationRecommendationEnglish\"> </a><a name=\"hcDDCCImmunizationRecommendationEnglish\"> </a><a name=\"DDCCImmunizationRecommendationEnglish-en-US\"> </a><p><b>patient</b>: <a href=\"Patient-DDCCPatientEnglish.html\">Aulus Agerius(official) (no stated gender), DoB: 2003-03-03</a></p><p><b>date</b>: 2021-05-06</p><blockquote><p><b>recommendation</b></p><p><b>vaccineCode</b>: <span title=\"Codes:{http://id.who.int/icd11/mms XM0GQ8}\">XM0GQ8</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/immunization-recommendation-status due}\">Due</span></p><h3>DateCriterions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://loinc.org 30980-7}\">Date vaccine due</span></td><td>2021-05-20</td></tr></table><p><b>supportingImmunization</b>: <a href=\"Immunization-DDCCImmunizationEnglish.html\">Immunization: extension = XM3DT5 (mms#XM3DT5),CHE,Test (DDCC Codes for examples#TEST),2021-05-30; status = completed; vaccineCode = XM0GQ8; occurrence[x] = 2021-05-06; lotNumber = 123; expirationDate = 2021-06-30</a></p></blockquote></div>"
        },
        "patient" : {
          🔗 "reference" : "Patient/DDCCPatientEnglish"
        },
        "date" : "2021-05-06",
        "recommendation" : [
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://id.who.int/icd11/mms",
                    "code" : "XM0GQ8"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status",
                  "code" : "due"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7"
                    }
                  ]
                },
                "value" : "2021-05-20"
              }
            ],
            "supportingImmunization" : [
              {
                🔗 "reference" : "Immunization/DDCCImmunizationEnglish"
              }
            ]
          }
        ]
      }
    }
  ]
}