Schema

Status: Draft

Note

It is derived from the European Digital COVID Certificate (DCC) specification.

JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "hcert": {
      "type": "object",
      "properties": {
        "ver": {
          "type": "string"
        },
        "nam": {
          "type": "object",
          "properties": {
            "fn": {
              "type": "string"
            },
            "gn": {
              "type": "string"
            }
          },
          "required": ["fn", "gn"]
        },
        "dob": {
          "type": "string",
          "format": "date"
        },
    "pid": {
      "oid": {
        "type": "string"
      },
      "id": {
        "type": "string"
      },
      "required": ["oid","id"]
    },
        "v": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "reg": {
                "type": "string"
              },
              "rep": {
                "type": "integer"
              },
              "i": {
                "type": "integer"
              },
              "a": {
                "type": "integer"
              },
              "mp": {
                "type": "integer"
              }
            },
            "required": ["reg", "rep", "i", "a", "mp"]
          }
        }
      },
      "required": ["ver", "nam", "dob", "v"]
    }
  },
  "required": ["hcert"]
}

Description:

Field	Type	Example	Comment
ver	string	1.0.0	Version of the structure
nam	struct		Basic identity traits
fnt	string	DOE	Name
gnt	string	John	First or usual given name
dob	date	2017-07-19	Date of birth
pid	struct		Optional person identifier
oid	string	1.2.250.1.213.1.4.8	OID for the identification scheme
id	string	1630777186051	Person identifier within the scheme
v	array		Vaccine administration records
reg	string	FRA	3 letters code for a registry
rep	int	5	Index for a repository in a registry
i	int	1296	Reference within a repository for a given date
a	int	1386	Age in days when the vaccine was administered
mp	int	29	NUVA code for the vaccine (here REPEVAX)

Full exemple:

{
  "iss": "LU",
  "exp:": "1954404675",
  "iat": "1638871875",
  "hcert": {
    "ver": "1.0.0",
    "nam": {
      "fn": "DOE",
      "gn": "John"
    },
    "dob": "2020-10-06",
    "v": [
      {"reg":"LUX","rep":1,"i": 9432,"a": 45,"mp": 514},
      {"reg":"LUX","rep":1,"i": 6260,"a": 75,"mp": 514},
      {"reg":"LUX","rep":1,"i": 9070,"a": 90,"mp": 14},
      {"reg":"LUX","rep":1,"i": 1723,"a": 149,"mp": 510},
      {"reg":"LUX","rep":1,"i": 88,"a": 164,"mp": 123},
      {"reg":"LUX","rep":1,"i": 1115,"a": 331,"mp": 510},
      {"reg":"LUX","rep":1,"i": 6428,"a": 359,"mp": 123}
    ]
  }
}