{"id":13492058,"url":"https://github.com/ehn-dcc-development/eu-dcc-schema","last_synced_at":"2025-03-28T09:33:43.099Z","repository":{"id":37965009,"uuid":"360015288","full_name":"ehn-dcc-development/eu-dcc-schema","owner":"ehn-dcc-development","description":"Schema for the ehn DCC payload","archived":true,"fork":false,"pushed_at":"2023-07-26T07:52:42.000Z","size":464,"stargazers_count":164,"open_issues_count":0,"forks_count":59,"subscribers_count":40,"default_branch":"main","last_synced_at":"2024-10-31T06:34:40.752Z","etag":null,"topics":["specification"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ehn-dcc-development.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-04-21T02:59:24.000Z","updated_at":"2024-08-28T15:07:48.000Z","dependencies_parsed_at":"2022-07-10T00:46:17.667Z","dependency_job_id":"53531a71-2d03-4526-9c46-fed40e622311","html_url":"https://github.com/ehn-dcc-development/eu-dcc-schema","commit_stats":null,"previous_names":["ehn-dcc-development/ehn-dcc-schema"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehn-dcc-development%2Feu-dcc-schema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehn-dcc-development%2Feu-dcc-schema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehn-dcc-development%2Feu-dcc-schema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehn-dcc-development%2Feu-dcc-schema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehn-dcc-development","download_url":"https://codeload.github.com/ehn-dcc-development/eu-dcc-schema/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246004105,"owners_count":20708133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["specification"],"created_at":"2024-07-31T19:01:02.732Z","updated_at":"2025-03-28T09:33:42.763Z","avatar_url":"https://github.com/ehn-dcc-development.png","language":"Makefile","funding_links":[],"categories":["Makefile"],"sub_categories":[],"readme":"# Digital Covid Certificate Schema\n\nThis repository contains a JSON schema for the EU Digital Covid Certificate.\n\n**Schema version:** 1.3.3\n\n**Release date:** 2023-05-24 (tentative, dependent on eHN Coordinated Actions meeting)\n\n## IMPORTANT NOTICE\n\nAs of July 1st 2023 the EU DCC project has been handed over to the [WHO](https://github.com/WorldHealthOrganization/smart-trust-network-gateway). The project has therefore been frozen. This repository will be placed into archival mode and will remain available for the foreseeable future, however it will no longer be actively maintained.\n\n## Introduction\n\nThe Digital Covid Certificate (DCC) JSON schema is provided as a mechanism for supporting the serialization and  deserialization of the DCC payload, initially with focus on generation of a 2D barcode (QR Code).\n\nThe schema is intended to support different use cases that EU Member States require. The schema shall also support conformity to the [EU legislation](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:52021PC0130) regarding  what shall present in a certificate to ensure freedom of movement within EU Member States and also to allow interoperability with countries outside of the EU zone.\n\nThe schema in conjunction with business rules (which may also be specific to a Member State) shall ensure conformity to the EU legislation, whereby the burden of conformity lies with the business rules and the DCC JSON schema plays a supporting role in allowing the data to be serialized and deserialized in a flexible, yet structured, manner.\n\n\n## Schema files\n\nThe main schema file is:\n\n- [DCC.schema.json](./DCC.schema.json)\n\nWith the definitions in:\n\n- [DCC.Core.Types.schema.json](./DCC.Core.Types.schema.json)\n- [DCC.Types.schema.json](./DCC.Types.schema.json)\n- [DCC.ValueSets.schema.json](./DCC.ValueSets.schema.json)\n\nFor easy testing, they are combined in:\n\n- [DCC.combined-schema.json](./DCC.combined-schema.json)\n\nThe rule labeled as `$(MERGED_SCHEMA)` in the [Makefile](./Makefile) makes this target by combining the 4 schema files (“schemata”) mentioned above into one schema file, and also reformatting and validating it.\nThe [`merge.sh` script](./merge.sh) does the same, but without reformatting and validating the resulting JSON.\nThis can be useful for development purposes, but make sure to run `make` prior to committing.\n\n_Note:_ the first 4, non-combined schema files are always leading.\n\n\n### Value sets\n\nSee https://github.com/ehn-dcc-development/ehn-dcc-valuesets\n\n\n## Implementation Notes\n\nA list of Frequently Asked Questions (FAQ) for implementors can be found [here](wiki/FAQ.md).\n\n\n## Prerequisites\n\nThe Makefile assumes that the following tools are installed, and are available on the shell's path:\n\n* [Python (version 3)](https://www.python.org/downloads/)\n* A(ny) Make (such as [GNU Make](https://www.gnu.org/software/make/)) to execute the [Makefile](./Makefile).\n* [Node.js](https://nodejs.org/en/download/): installing Node.js also installs the [NPM package manager](https://www.npmjs.com/) which is used to install a couple of dependencies.\n* [jq](https://stedolan.github.io/jq/)\n\n\nThe Makefile also relies on the [`ajv` JSON Schema validator](https://ajv.js.org/), which is installed by the `install-ajv` rule in the Makefile:\n\n    $ make install-ajv\n\n\n## Examples and test cases\n\nThe examples and the test cases can be validated with `ajv` by using the following commands.\n\nTo validate all of the examples:\n\n\tmake validate-examples\n\t\n...and all of expected valid tests:\n\n\tmake validate-valid-tests\n\n...and all of the expected invalid tests:\n\n\tmake validate-invalid-tests\n\n\n## Committing: Git hooks\n\nThis project uses Git hooks to validate the JSON files and the above test cases.\nTo use the hooks, configure Git to use the hooks we provide, as follows:\n\n```\ngit config core.hooksPath hooks\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehn-dcc-development%2Feu-dcc-schema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehn-dcc-development%2Feu-dcc-schema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehn-dcc-development%2Feu-dcc-schema/lists"}