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. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination

Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination.

Usage:

• This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DDCCCoreDataSetVS

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
name	Σ	1..1	string	Name
birthDate	Σ	0..1	date	Date of birth
identifier	Σ	0..1	Identifier	Unique identifier
certificate	Σ	0..1	BackboneElement	Certificate Metadata ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
issuer	Σ	1..1	Reference(DDCC Organization)	Certificate issuer
kid		0..1	string	Key ID used to verify the signature of the certificate
hcid	Σ	1..1	Identifier	Health certificate identifier (HCID)
ddccid	Σ	0..1	Identifier	DDCC Identifier
version	Σ	1..1	string	Certificate schema version
period	C	0..1	Period	Certificate Validity Period ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
start	ΣC	0..1	dateTime	Certificate valid from ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	dateTime	Certificate valid until ele-1: All FHIR elements must have a @value or children
vaccination	ΣC	1..1	BackboneElement	Vaccination Event who-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccine	Σ	1..1	Coding	Vaccine or prophylaxis Binding: WHO Vaccine List (COVID-19) (preferred)
brand	Σ	1..1	Coding	Vaccine brand
manufacturer	Σ	0..1	Coding	Vaccine manufacturer
maholder	Σ	0..1	Coding	Vaccine market authorization holder
lot	Σ	1..1	string	Vaccine lot number
date	Σ	1..1	dateTime	Date of vaccination
validFrom		0..1	date	Vaccination valid from
dose	Σ	1..1	positiveInt	Dose number
totalDoses		0..1	positiveInt	Total doses
country	Σ	1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (preferred)
centre		0..1	string	Administering centre
signature		0..1	Signature	Signature of health worker
practitioner		0..1	Identifier	Health worker identifier
disease		0..1	Coding	Disease or agent targeted Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
nextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DDCCCoreDataSet.vaccination.vaccine	preferred	WHODDCCVaccinesCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG
DDCCCoreDataSet.vaccination.country	preferred	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
DDCCCoreDataSet.vaccination.disease	preferred	WHODDCCDiseaseTargetedCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	DDCCCoreDataSet.certificate.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1	error	DDCCCoreDataSet.vaccination	Manufacturer or Market Authorization Holder SHALL be present : manufacturer.exists() or maholder.exists()

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
name	Σ	1..1	string	Name
birthDate	Σ	0..1	date	Date of birth
identifier	Σ	0..1	Identifier	Unique identifier
certificate	Σ	0..1	BackboneElement	Certificate Metadata
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
issuer	Σ	1..1	Reference(DDCC Organization)	Certificate issuer
kid		0..1	string	Key ID used to verify the signature of the certificate
hcid	Σ	1..1	Identifier	Health certificate identifier (HCID)
ddccid	Σ	0..1	Identifier	DDCC Identifier
version	Σ	1..1	string	Certificate schema version
period	C	0..1	Period	Certificate Validity Period per-1: If present, start SHALL have a lower value than end
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Certificate valid from
end	ΣC	0..1	dateTime	Certificate valid until
vaccination	ΣC	1..1	BackboneElement	Vaccination Event who-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccine	Σ	1..1	Coding	Vaccine or prophylaxis Binding: WHO Vaccine List (COVID-19) (preferred)
brand	Σ	1..1	Coding	Vaccine brand
manufacturer	Σ	0..1	Coding	Vaccine manufacturer
maholder	Σ	0..1	Coding	Vaccine market authorization holder
lot	Σ	1..1	string	Vaccine lot number
date	Σ	1..1	dateTime	Date of vaccination
validFrom		0..1	date	Vaccination valid from
dose	Σ	1..1	positiveInt	Dose number
totalDoses		0..1	positiveInt	Total doses
country	Σ	1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (preferred)
centre		0..1	string	Administering centre
signature		0..1	Signature	Signature of health worker
practitioner		0..1	Identifier	Health worker identifier
disease		0..1	Coding	Disease or agent targeted Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
nextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DDCCCoreDataSet.vaccination.vaccine	preferred	WHODDCCVaccinesCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG
DDCCCoreDataSet.vaccination.country	preferred	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
DDCCCoreDataSet.vaccination.disease	preferred	WHODDCCDiseaseTargetedCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	DDCCCoreDataSet.certificate.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1	error	DDCCCoreDataSet.vaccination	Manufacturer or Market Authorization Holder SHALL be present : manufacturer.exists() or maholder.exists()

This structure is derived from DDCCCoreDataSetVS

Summary

Differential View

This structure is derived from DDCCCoreDataSetVS

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
name	Σ	1..1	string	Name
birthDate	Σ	0..1	date	Date of birth
identifier	Σ	0..1	Identifier	Unique identifier
certificate	Σ	0..1	BackboneElement	Certificate Metadata ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
issuer	Σ	1..1	Reference(DDCC Organization)	Certificate issuer
kid		0..1	string	Key ID used to verify the signature of the certificate
hcid	Σ	1..1	Identifier	Health certificate identifier (HCID)
ddccid	Σ	0..1	Identifier	DDCC Identifier
version	Σ	1..1	string	Certificate schema version
period	C	0..1	Period	Certificate Validity Period ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
start	ΣC	0..1	dateTime	Certificate valid from ele-1: All FHIR elements must have a @value or children
end	ΣC	0..1	dateTime	Certificate valid until ele-1: All FHIR elements must have a @value or children
vaccination	ΣC	1..1	BackboneElement	Vaccination Event who-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
vaccine	Σ	1..1	Coding	Vaccine or prophylaxis Binding: WHO Vaccine List (COVID-19) (preferred)
brand	Σ	1..1	Coding	Vaccine brand
manufacturer	Σ	0..1	Coding	Vaccine manufacturer
maholder	Σ	0..1	Coding	Vaccine market authorization holder
lot	Σ	1..1	string	Vaccine lot number
date	Σ	1..1	dateTime	Date of vaccination
validFrom		0..1	date	Vaccination valid from
dose	Σ	1..1	positiveInt	Dose number
totalDoses		0..1	positiveInt	Total doses
country	Σ	1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (preferred)
centre		0..1	string	Administering centre
signature		0..1	Signature	Signature of health worker
practitioner		0..1	Identifier	Health worker identifier
disease		0..1	Coding	Disease or agent targeted Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
nextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DDCCCoreDataSet.vaccination.vaccine	preferred	WHODDCCVaccinesCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG
DDCCCoreDataSet.vaccination.country	preferred	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
DDCCCoreDataSet.vaccination.disease	preferred	WHODDCCDiseaseTargetedCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	DDCCCoreDataSet.certificate.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1	error	DDCCCoreDataSet.vaccination	Manufacturer or Market Authorization Holder SHALL be present : manufacturer.exists() or maholder.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DDCCCoreDataSet		0..*	DDCCCoreDataSetVS	Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination Instances of this logical model are not marked to be the target of a Reference
name	Σ	1..1	string	Name
birthDate	Σ	0..1	date	Date of birth
identifier	Σ	0..1	Identifier	Unique identifier
certificate	Σ	0..1	BackboneElement	Certificate Metadata
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
issuer	Σ	1..1	Reference(DDCC Organization)	Certificate issuer
kid		0..1	string	Key ID used to verify the signature of the certificate
hcid	Σ	1..1	Identifier	Health certificate identifier (HCID)
ddccid	Σ	0..1	Identifier	DDCC Identifier
version	Σ	1..1	string	Certificate schema version
period	C	0..1	Period	Certificate Validity Period per-1: If present, start SHALL have a lower value than end
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Certificate valid from
end	ΣC	0..1	dateTime	Certificate valid until
vaccination	ΣC	1..1	BackboneElement	Vaccination Event who-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
vaccine	Σ	1..1	Coding	Vaccine or prophylaxis Binding: WHO Vaccine List (COVID-19) (preferred)
brand	Σ	1..1	Coding	Vaccine brand
manufacturer	Σ	0..1	Coding	Vaccine manufacturer
maholder	Σ	0..1	Coding	Vaccine market authorization holder
lot	Σ	1..1	string	Vaccine lot number
date	Σ	1..1	dateTime	Date of vaccination
validFrom		0..1	date	Vaccination valid from
dose	Σ	1..1	positiveInt	Dose number
totalDoses		0..1	positiveInt	Total doses
country	Σ	1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (preferred)
centre		0..1	string	Administering centre
signature		0..1	Signature	Signature of health worker
practitioner		0..1	Identifier	Health worker identifier
disease		0..1	Coding	Disease or agent targeted Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
nextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DDCCCoreDataSet.vaccination.vaccine	preferred	WHODDCCVaccinesCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG
DDCCCoreDataSet.vaccination.country	preferred	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
DDCCCoreDataSet.vaccination.disease	preferred	WHODDCCDiseaseTargetedCOVID19 http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19 from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
per-1	error	DDCCCoreDataSet.certificate.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1	error	DDCCCoreDataSet.vaccination	Manufacturer or Market Authorization Holder SHALL be present : manufacturer.exists() or maholder.exists()

This structure is derived from DDCCCoreDataSetVS

Summary

Other representations of profile: CSV, Excel