WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build International flag

This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.0: 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

Logical Model: CertDIVOC - Detailed Descriptions

Draft as of 2024-10-15

Definitions for the CertDIVOC logical model.

Guidance on how to interpret the contents of this table can be found here

0. CertDIVOC
Definition

Data elements for the DIVOC Core Data Set.

The official DIVOC documentation appears to be at https://divoc.digit.org. However, this does not include a full list of elements included in DIVOC certificates.

There is a JSON-LD context referenced in DIVOC certificate examples (https://cowin.gov.in/credentials/vaccination/v1), which would provide some element-level information, but this URL does not resolve. There is a copy of this JSON-LD context at https://github.com/egovernments/DIVOC/blob/main/vaccination-context/vaccination-context.js.

It was not possible to find any online documentation regarding DIVOC proof of testing. Information on this was provided by the DIVOC team via email.

Some element descriptions in this logical model provide details that are not in publicly available DIVOC documentation.

ShortCertificate - DIVOC Verifiable Credential Logical Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CertDIVOC.context
Definition

Context (JSON-LD) - should actually be @context but this name isn't supported by FHIR.

ShortContext (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CertDIVOC.type
Definition

JSON-LD Type

ShortType
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CertDIVOC.issuer
Definition

Issuer identifier URI. generally a DID

ShortIssuer identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CertDIVOC.issuanceDate
Definition

Date and time when a credential becomes valid

ShortissuanceDate
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CertDIVOC.nonTransferable
Definition

indicates that a verifiable credential must only be encapsulated into a verifiable presentation whose proof was issued by the credentialSubject

ShortNon Trasnferability
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CertDIVOC.credentialSubject
Definition

Contains claims about one or more objects (Patients)

ShortCredentialSubject
Control1..1
TypeBackboneElement
14. CertDIVOC.credentialSubject.type
Definition

Type of credential. Generally 'Person'

Shorttype
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CertDIVOC.credentialSubject.uhid
Definition

another id

Shortanother id
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. CertDIVOC.credentialSubject.refId
Definition

reference id

Shortreference id
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CertDIVOC.credentialSubject.name
Definition

A name associated with the patient

ShortA name associated with the patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. CertDIVOC.credentialSubject.gender
Definition

Gender (Male or Female; unknown if there are other options)

ShortGender (`Male` or `Female`; unknown if there are other options)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CertDIVOC.credentialSubject.sex
Definition

Sex (not used in examples; presumably Male or Female; unknown if there are other options)

ShortSex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. CertDIVOC.credentialSubject.age
Definition

Age

ShortAge
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. CertDIVOC.credentialSubject.dob
Definition

The date of birth for the individual (V2 only)

ShortThe date of birth for the individual (V2 only)
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. CertDIVOC.credentialSubject.nationality
Definition

Nationality

ShortNationality
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. CertDIVOC.credentialSubject.address
Definition

Address

ShortAddress
Control0..1
TypeBackboneElement
34. CertDIVOC.credentialSubject.address.streetAddress
Definition

Line 1 of the address

ShortLine 1 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. CertDIVOC.credentialSubject.address.streetAddress2
Definition

Line 2 of the address

ShortLine 2 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. CertDIVOC.credentialSubject.address.district
Definition

District name (aka county)

ShortDistrict name (aka county)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. CertDIVOC.credentialSubject.address.city
Definition

Name of city, town etc.

ShortName of city, town etc.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. CertDIVOC.credentialSubject.address.addressRegion
Definition

Sub-unit of country (abbreviations ok)

ShortSub-unit of country (abbreviations ok)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. CertDIVOC.credentialSubject.address.addressCountry
Definition

Country (e.g. may be ISO 3166 2 or 3 letter code)

ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. CertDIVOC.credentialSubject.address.postalCode
Definition

Postal code for area

ShortPostal code for area
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. CertDIVOC.evidence
Definition

Vaccination Information

ShortEvidence
Control0..*
TypeBackboneElement
50. CertDIVOC.evidence.feedbackUrl
Definition

URL for feedback

ShortURL for feedback
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. CertDIVOC.evidence.infoUrl
Definition

URL for more information on this record

ShortURL for more information on this record
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. CertDIVOC.evidence.certificateId
Definition

Certificate Unique Identifier

ShortCertificate Unique Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
56. CertDIVOC.evidence.type
Definition

Type of evidence record. Generally Vaccination or TestDetails

Shorttype
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. CertDIVOC.evidence.batch
Definition

Vaccine lot number

ShortVaccine lot number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. CertDIVOC.evidence.vaccine
Definition

Vaccine description. Might include vaccine type and brand

ShortVaccine description. Might include vaccine type and brand
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. CertDIVOC.evidence.manufacturer
Definition

Name of the Vaccine/Test Manufacturer

ShortName of the Vaccine/Test Manufacturer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. CertDIVOC.evidence.date
Definition

Date of immunization

ShortDate of immunization
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. CertDIVOC.evidence.effectiveStart
Definition

Effective immunization start date

ShortEffective immunization start date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
68. CertDIVOC.evidence.effectiveUntil
Definition

Effective immunization end date

ShortEffective immunization end date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. CertDIVOC.evidence.dose
Definition

Dose Number

ShortDose Number
Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. CertDIVOC.evidence.totalDoses
Definition

Total doses for this vaccine protocol regimen

ShortTotal doses for this vaccine protocol regimen
Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
74. CertDIVOC.evidence.verifier
Definition

Practitioner that oversaw the application

ShortVerifier
Control0..1
TypeBackboneElement
76. CertDIVOC.evidence.verifier.name
Definition

Name of the practitioner

ShortName of the practitioner
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
78. CertDIVOC.evidence.facility
Definition

Facility where the immunization took place

ShortFacility
Control0..1
TypeBackboneElement
80. CertDIVOC.evidence.facility.name
Definition

Name of the facility/entity

ShortName of the facility/entity
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. CertDIVOC.evidence.facility.address
Definition

Address of the facility

ShortAddress of the facility
Control0..1
TypeAddress
84. CertDIVOC.evidence.facility.address.streetAddress
Definition

Line 1 of the address

ShortLine 1 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. CertDIVOC.evidence.facility.address.streetAddress2
Definition

Line 2 of the address

ShortLine 2 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
88. CertDIVOC.evidence.facility.address.district
Definition

District name (aka county)

ShortDistrict name (aka county)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
90. CertDIVOC.evidence.facility.address.city
Definition

Name of city, town etc.

ShortName of city, town etc.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
92. CertDIVOC.evidence.facility.address.addressRegion
Definition

Sub-unit of country (abbreviations ok)

ShortSub-unit of country (abbreviations ok)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
94. CertDIVOC.evidence.facility.address.addressCountry
Definition

Country (e.g. may be ISO 3166 2 or 3 letter code)

ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
Control0..1
BindingThe codes SHOULD be taken from Iso3166-1-3
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
96. CertDIVOC.evidence.facility.address.postalCode
Definition

Postal code for area

ShortPostal code for area
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
98. CertDIVOC.evidence.icd11Code
Definition

The specification for DIVOC does not provide any information beyond that this is an ICD-11 code, so correspondingly there is no required binding to a specific ValueSet in this logical model.

ShortICD-11 code of this vaccine type (no binding information in spec)
Control0..1
BindingThe codes SHOULD be taken from WHO Vaccine List (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
100. CertDIVOC.evidence.prophylaxis
Definition

Descriptive details of the vaccine type

ShortDescriptive details of the vaccine type
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
102. CertDIVOC.evidence.testName
Definition

Lab test results: Test name

ShortLab test results: Test name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
104. CertDIVOC.evidence.testType
Definition

Lab test results: Type of test, either RT-PCR or Rapid Antigen Test (RAT)

ShortLab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Control0..1
BindingThe codes SHALL be taken from Lab Test - Type - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
106. CertDIVOC.evidence.sampleOrigin
Definition

Lab test results: Type of sample that was taken (e.g., nasal swab

ShortLab test results: Type of sample that was taken (e.g., `nasal swab`
Control0..1
BindingThe codes SHALL be taken from Lab Test - Sample Origin - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
108. CertDIVOC.evidence.disease
Definition

Lab test results: Disease or agent targeted

ShortLab test results: Disease or agent targeted
Control0..1
BindingThe codes SHALL be taken from Lab Test - Pathogen - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
110. CertDIVOC.evidence.sampleCollectionTimestamp
Definition

Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601

ShortLab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
112. CertDIVOC.evidence.resultTimestamp
Definition

Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601

ShortLab test results: Results date and time; complete date, with time and time zone, following ISO 8601
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
114. CertDIVOC.evidence.result
Definition

Lab test results: result of test

ShortLab test results: result of test
Control0..1
BindingThe codes SHALL be taken from Lab Test - Qualitative Result - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
116. CertDIVOC.proof
Definition

One or more cryptographic proofs that can be used to detect tampering and verify the authorship of a credential or presentation

ShortProof
Control1..*
TypeBackboneElement
118. CertDIVOC.proof.type
Definition

Type of proof

ShortType of proof
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
120. CertDIVOC.proof.created
Definition

Signature date and time

ShortSignature date and time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
122. CertDIVOC.proof.verificationMethod
Definition

Resolvable issuer identifier

ShortResolvable issuer identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. CertDIVOC.proof.proofPurpose
Definition

Clearly expresses the purpose for the proof and ensures this information is protected by the signature

ShortPurpose of the signature
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
126. CertDIVOC.proof.jws
Definition

Signature

ShortSignature
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. CertDIVOC
Definition

Data elements for the DIVOC Core Data Set.

The official DIVOC documentation appears to be at https://divoc.digit.org. However, this does not include a full list of elements included in DIVOC certificates.

There is a JSON-LD context referenced in DIVOC certificate examples (https://cowin.gov.in/credentials/vaccination/v1), which would provide some element-level information, but this URL does not resolve. There is a copy of this JSON-LD context at https://github.com/egovernments/DIVOC/blob/main/vaccination-context/vaccination-context.js.

It was not possible to find any online documentation regarding DIVOC proof of testing. Information on this was provided by the DIVOC team via email.

Some element descriptions in this logical model provide details that are not in publicly available DIVOC documentation.

ShortCertificate - DIVOC Verifiable Credential Logical Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CertDIVOC.context
Definition

Context (JSON-LD) - should actually be @context but this name isn't supported by FHIR.

ShortContext (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CertDIVOC.type
Definition

JSON-LD Type

ShortType
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CertDIVOC.issuer
Definition

Issuer identifier URI. generally a DID

ShortIssuer identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CertDIVOC.issuanceDate
Definition

Date and time when a credential becomes valid

ShortissuanceDate
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CertDIVOC.nonTransferable
Definition

indicates that a verifiable credential must only be encapsulated into a verifiable presentation whose proof was issued by the credentialSubject

ShortNon Trasnferability
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CertDIVOC.credentialSubject
Definition

Contains claims about one or more objects (Patients)

ShortCredentialSubject
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. CertDIVOC.credentialSubject.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. CertDIVOC.credentialSubject.type
Definition

Type of credential. Generally 'Person'

Shorttype
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. CertDIVOC.credentialSubject.uhid
Definition

another id

Shortanother id
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CertDIVOC.credentialSubject.refId
Definition

reference id

Shortreference id
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. CertDIVOC.credentialSubject.name
Definition

A name associated with the patient

ShortA name associated with the patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CertDIVOC.credentialSubject.gender
Definition

Gender (Male or Female; unknown if there are other options)

ShortGender (`Male` or `Female`; unknown if there are other options)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. CertDIVOC.credentialSubject.sex
Definition

Sex (not used in examples; presumably Male or Female; unknown if there are other options)

ShortSex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. CertDIVOC.credentialSubject.age
Definition

Age

ShortAge
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. CertDIVOC.credentialSubject.dob
Definition

The date of birth for the individual (V2 only)

ShortThe date of birth for the individual (V2 only)
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. CertDIVOC.credentialSubject.nationality
Definition

Nationality

ShortNationality
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. CertDIVOC.credentialSubject.address
Definition

Address

ShortAddress
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. CertDIVOC.credentialSubject.address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. CertDIVOC.credentialSubject.address.streetAddress
Definition

Line 1 of the address

ShortLine 1 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. CertDIVOC.credentialSubject.address.streetAddress2
Definition

Line 2 of the address

ShortLine 2 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. CertDIVOC.credentialSubject.address.district
Definition

District name (aka county)

ShortDistrict name (aka county)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. CertDIVOC.credentialSubject.address.city
Definition

Name of city, town etc.

ShortName of city, town etc.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. CertDIVOC.credentialSubject.address.addressRegion
Definition

Sub-unit of country (abbreviations ok)

ShortSub-unit of country (abbreviations ok)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. CertDIVOC.credentialSubject.address.addressCountry
Definition

Country (e.g. may be ISO 3166 2 or 3 letter code)

ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. CertDIVOC.credentialSubject.address.postalCode
Definition

Postal code for area

ShortPostal code for area
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. CertDIVOC.evidence
Definition

Vaccination Information

ShortEvidence
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. CertDIVOC.evidence.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. CertDIVOC.evidence.feedbackUrl
Definition

URL for feedback

ShortURL for feedback
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. CertDIVOC.evidence.infoUrl
Definition

URL for more information on this record

ShortURL for more information on this record
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. CertDIVOC.evidence.certificateId
Definition

Certificate Unique Identifier

ShortCertificate Unique Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. CertDIVOC.evidence.type
Definition

Type of evidence record. Generally Vaccination or TestDetails

Shorttype
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. CertDIVOC.evidence.batch
Definition

Vaccine lot number

ShortVaccine lot number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. CertDIVOC.evidence.vaccine
Definition

Vaccine description. Might include vaccine type and brand

ShortVaccine description. Might include vaccine type and brand
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
68. CertDIVOC.evidence.manufacturer
Definition

Name of the Vaccine/Test Manufacturer

ShortName of the Vaccine/Test Manufacturer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. CertDIVOC.evidence.date
Definition

Date of immunization

ShortDate of immunization
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. CertDIVOC.evidence.effectiveStart
Definition

Effective immunization start date

ShortEffective immunization start date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
74. CertDIVOC.evidence.effectiveUntil
Definition

Effective immunization end date

ShortEffective immunization end date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. CertDIVOC.evidence.dose
Definition

Dose Number

ShortDose Number
Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
78. CertDIVOC.evidence.totalDoses
Definition

Total doses for this vaccine protocol regimen

ShortTotal doses for this vaccine protocol regimen
Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
80. CertDIVOC.evidence.verifier
Definition

Practitioner that oversaw the application

ShortVerifier
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. CertDIVOC.evidence.verifier.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
84. CertDIVOC.evidence.verifier.name
Definition

Name of the practitioner

ShortName of the practitioner
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. CertDIVOC.evidence.facility
Definition

Facility where the immunization took place

ShortFacility
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. CertDIVOC.evidence.facility.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
90. CertDIVOC.evidence.facility.name
Definition

Name of the facility/entity

ShortName of the facility/entity
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
92. CertDIVOC.evidence.facility.address
Definition

Address of the facility

ShortAddress of the facility
Control0..1
TypeAddress
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. CertDIVOC.evidence.facility.address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. CertDIVOC.evidence.facility.address.city
Definition

Name of city, town etc.


The name of the city, town, suburb, village or other community or delivery center.

ShortName of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesMunicpality
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. CertDIVOC.evidence.facility.address.district
Definition

District name (aka county)


The name of the administrative area (county).

ShortDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesCounty
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. CertDIVOC.evidence.facility.address.postalCode
Definition

Postal code for area


A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. CertDIVOC.evidence.facility.address.streetAddress
Definition

Line 1 of the address

ShortLine 1 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
104. CertDIVOC.evidence.facility.address.streetAddress2
Definition

Line 2 of the address

ShortLine 2 of the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
106. CertDIVOC.evidence.facility.address.addressRegion
Definition

Sub-unit of country (abbreviations ok)

ShortSub-unit of country (abbreviations ok)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
108. CertDIVOC.evidence.facility.address.addressCountry
Definition

Country (e.g. may be ISO 3166 2 or 3 letter code)

ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
Control0..1
BindingThe codes SHOULD be taken from Iso3166-1-3
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
110. CertDIVOC.evidence.icd11Code
Definition

The specification for DIVOC does not provide any information beyond that this is an ICD-11 code, so correspondingly there is no required binding to a specific ValueSet in this logical model.

ShortICD-11 code of this vaccine type (no binding information in spec)
Control0..1
BindingThe codes SHOULD be taken from WHO Vaccine List (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
112. CertDIVOC.evidence.prophylaxis
Definition

Descriptive details of the vaccine type

ShortDescriptive details of the vaccine type
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
114. CertDIVOC.evidence.testName
Definition

Lab test results: Test name

ShortLab test results: Test name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
116. CertDIVOC.evidence.testType
Definition

Lab test results: Type of test, either RT-PCR or Rapid Antigen Test (RAT)

ShortLab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Control0..1
BindingThe codes SHALL be taken from Lab Test - Type - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
118. CertDIVOC.evidence.sampleOrigin
Definition

Lab test results: Type of sample that was taken (e.g., nasal swab

ShortLab test results: Type of sample that was taken (e.g., `nasal swab`
Control0..1
BindingThe codes SHALL be taken from Lab Test - Sample Origin - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
120. CertDIVOC.evidence.disease
Definition

Lab test results: Disease or agent targeted

ShortLab test results: Disease or agent targeted
Control0..1
BindingThe codes SHALL be taken from Lab Test - Pathogen - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
122. CertDIVOC.evidence.sampleCollectionTimestamp
Definition

Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601

ShortLab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. CertDIVOC.evidence.resultTimestamp
Definition

Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601

ShortLab test results: Results date and time; complete date, with time and time zone, following ISO 8601
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
126. CertDIVOC.evidence.result
Definition

Lab test results: result of test

ShortLab test results: result of test
Control0..1
BindingThe codes SHALL be taken from Lab Test - Qualitative Result - DIVOC
(required to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
128. CertDIVOC.proof
Definition

One or more cryptographic proofs that can be used to detect tampering and verify the authorship of a credential or presentation

ShortProof
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. CertDIVOC.proof.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. CertDIVOC.proof.type
Definition

Type of proof

ShortType of proof
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
134. CertDIVOC.proof.created
Definition

Signature date and time

ShortSignature date and time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
136. CertDIVOC.proof.verificationMethod
Definition

Resolvable issuer identifier

ShortResolvable issuer identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
138. CertDIVOC.proof.proofPurpose
Definition

Clearly expresses the purpose for the proof and ensures this information is protected by the signature

ShortPurpose of the signature
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
140. CertDIVOC.proof.jws
Definition

Signature

ShortSignature
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. CertDIVOC
Definition

Data elements for the DIVOC Core Data Set.

The official DIVOC documentation appears to be at https://divoc.digit.org. However, this does not include a full list of elements included in DIVOC certificates.

There is a JSON-LD context referenced in DIVOC certificate examples (https://cowin.gov.in/credentials/vaccination/v1), which would provide some element-level information, but this URL does not resolve. There is a copy of this JSON-LD context at https://github.com/egovernments/DIVOC/blob/main/vaccination-context/vaccination-context.js.

It was not possible to find any online documentation regarding DIVOC proof of testing. Information on this was provided by the DIVOC team via email.

Some element descriptions in this logical model provide details that are not in publicly available DIVOC documentation.

ShortCertificate - DIVOC Verifiable Credential Logical Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CertDIVOC.context
Definition

Context (JSON-LD) - should actually be @context but this name isn't supported by FHIR.

ShortContext (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CertDIVOC.type
Definition

JSON-LD Type

ShortType
Control1..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CertDIVOC.issuer
Definition

Issuer identifier URI. generally a DID

ShortIssuer identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CertDIVOC.issuanceDate
Definition

Date and time when a credential becomes valid

ShortissuanceDate
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CertDIVOC.nonTransferable
Definition

indicates that a verifiable credential must only be encapsulated into a verifiable presentation whose proof was issued by the credentialSubject

ShortNon Trasnferability
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CertDIVOC.credentialSubject
Definition

Contains claims about one or more objects (Patients)

ShortCredentialSubject
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. CertDIVOC.credentialSubject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
16. CertDIVOC.credentialSubject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CertDIVOC.credentialSubject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 18. CertDIVOC.credentialSubject.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. CertDIVOC.credentialSubject.type
    Definition

    Type of credential. Generally 'Person'

    Shorttype
    Control1..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. CertDIVOC.credentialSubject.uhid
    Definition

    another id

    Shortanother id
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. CertDIVOC.credentialSubject.refId
    Definition

    reference id

    Shortreference id
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. CertDIVOC.credentialSubject.name
    Definition

    A name associated with the patient

    ShortA name associated with the patient
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. CertDIVOC.credentialSubject.gender
    Definition

    Gender (Male or Female; unknown if there are other options)

    ShortGender (`Male` or `Female`; unknown if there are other options)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    30. CertDIVOC.credentialSubject.sex
    Definition

    Sex (not used in examples; presumably Male or Female; unknown if there are other options)

    ShortSex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    32. CertDIVOC.credentialSubject.age
    Definition

    Age

    ShortAge
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    34. CertDIVOC.credentialSubject.dob
    Definition

    The date of birth for the individual (V2 only)

    ShortThe date of birth for the individual (V2 only)
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    36. CertDIVOC.credentialSubject.nationality
    Definition

    Nationality

    ShortNationality
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. CertDIVOC.credentialSubject.address
    Definition

    Address

    ShortAddress
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. CertDIVOC.credentialSubject.address.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    42. CertDIVOC.credentialSubject.address.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on CertDIVOC.credentialSubject.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 44. CertDIVOC.credentialSubject.address.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      46. CertDIVOC.credentialSubject.address.streetAddress
      Definition

      Line 1 of the address

      ShortLine 1 of the address
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      48. CertDIVOC.credentialSubject.address.streetAddress2
      Definition

      Line 2 of the address

      ShortLine 2 of the address
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      50. CertDIVOC.credentialSubject.address.district
      Definition

      District name (aka county)

      ShortDistrict name (aka county)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      52. CertDIVOC.credentialSubject.address.city
      Definition

      Name of city, town etc.

      ShortName of city, town etc.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      54. CertDIVOC.credentialSubject.address.addressRegion
      Definition

      Sub-unit of country (abbreviations ok)

      ShortSub-unit of country (abbreviations ok)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      56. CertDIVOC.credentialSubject.address.addressCountry
      Definition

      Country (e.g. may be ISO 3166 2 or 3 letter code)

      ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      58. CertDIVOC.credentialSubject.address.postalCode
      Definition

      Postal code for area

      ShortPostal code for area
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      60. CertDIVOC.evidence
      Definition

      Vaccination Information

      ShortEvidence
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. CertDIVOC.evidence.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      64. CertDIVOC.evidence.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on CertDIVOC.evidence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 66. CertDIVOC.evidence.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        68. CertDIVOC.evidence.feedbackUrl
        Definition

        URL for feedback

        ShortURL for feedback
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        70. CertDIVOC.evidence.infoUrl
        Definition

        URL for more information on this record

        ShortURL for more information on this record
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        72. CertDIVOC.evidence.certificateId
        Definition

        Certificate Unique Identifier

        ShortCertificate Unique Identifier
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        74. CertDIVOC.evidence.type
        Definition

        Type of evidence record. Generally Vaccination or TestDetails

        Shorttype
        Control1..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        76. CertDIVOC.evidence.batch
        Definition

        Vaccine lot number

        ShortVaccine lot number
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        78. CertDIVOC.evidence.vaccine
        Definition

        Vaccine description. Might include vaccine type and brand

        ShortVaccine description. Might include vaccine type and brand
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        80. CertDIVOC.evidence.manufacturer
        Definition

        Name of the Vaccine/Test Manufacturer

        ShortName of the Vaccine/Test Manufacturer
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        82. CertDIVOC.evidence.date
        Definition

        Date of immunization

        ShortDate of immunization
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        84. CertDIVOC.evidence.effectiveStart
        Definition

        Effective immunization start date

        ShortEffective immunization start date
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        86. CertDIVOC.evidence.effectiveUntil
        Definition

        Effective immunization end date

        ShortEffective immunization end date
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        88. CertDIVOC.evidence.dose
        Definition

        Dose Number

        ShortDose Number
        Control0..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        90. CertDIVOC.evidence.totalDoses
        Definition

        Total doses for this vaccine protocol regimen

        ShortTotal doses for this vaccine protocol regimen
        Control0..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        92. CertDIVOC.evidence.verifier
        Definition

        Practitioner that oversaw the application

        ShortVerifier
        Control0..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. CertDIVOC.evidence.verifier.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        96. CertDIVOC.evidence.verifier.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on CertDIVOC.evidence.verifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 98. CertDIVOC.evidence.verifier.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          100. CertDIVOC.evidence.verifier.name
          Definition

          Name of the practitioner

          ShortName of the practitioner
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          102. CertDIVOC.evidence.facility
          Definition

          Facility where the immunization took place

          ShortFacility
          Control0..1
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          104. CertDIVOC.evidence.facility.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          106. CertDIVOC.evidence.facility.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on CertDIVOC.evidence.facility.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 108. CertDIVOC.evidence.facility.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            110. CertDIVOC.evidence.facility.name
            Definition

            Name of the facility/entity

            ShortName of the facility/entity
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            112. CertDIVOC.evidence.facility.address
            Definition

            Address of the facility

            ShortAddress of the facility
            Control0..1
            TypeAddress
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            114. CertDIVOC.evidence.facility.address.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            116. CertDIVOC.evidence.facility.address.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on CertDIVOC.evidence.facility.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 118. CertDIVOC.evidence.facility.address.use
              Definition

              The purpose of this address.

              Shorthome | work | temp | old | billing - purpose of this address
              Comments

              Applications can assume that an address is current unless it explicitly says that it is temporary or old.

              Control0..1
              BindingThe codes SHALL be taken from AddressUse
              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

              The use of an address.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows an appropriate address to be chosen from a list of many.

              Example<br/><b>General</b>:home
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              120. CertDIVOC.evidence.facility.address.type
              Definition

              Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

              Shortpostal | physical | both
              Comments

              The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

              Control0..1
              BindingThe codes SHALL be taken from AddressType
              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

              The type of an address (physical / postal).

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Example<br/><b>General</b>:both
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              122. CertDIVOC.evidence.facility.address.text
              Definition

              Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

              ShortText representation of the address
              Comments

              Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              A renderable, unencoded form.

              Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              124. CertDIVOC.evidence.facility.address.line
              Definition

              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

              ShortStreet name, number, direction & P.O. Box etc.
              Control0..*
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Example<br/><b>General</b>:137 Nowhere Street
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              126. CertDIVOC.evidence.facility.address.city
              Definition

              Name of city, town etc.

              ShortName of city, town etc.
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesMunicpality
              Example<br/><b>General</b>:Erewhon
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              128. CertDIVOC.evidence.facility.address.district
              Definition

              District name (aka county)

              ShortDistrict name (aka county)
              Comments

              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesCounty
              Example<br/><b>General</b>:Madison
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              130. CertDIVOC.evidence.facility.address.state
              Definition

              Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

              ShortSub-unit of country (abbreviations ok)
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesProvince, Territory
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              132. CertDIVOC.evidence.facility.address.postalCode
              Definition

              Postal code for area

              ShortPostal code for area
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesZip
              Example<br/><b>General</b>:9132
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              134. CertDIVOC.evidence.facility.address.country
              Definition

              Country - a nation as commonly understood or generally accepted.

              ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
              Comments

              ISO 3166 3 letter codes can be used in place of a human readable country name.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              136. CertDIVOC.evidence.facility.address.period
              Definition

              Time period when address was/is in use.

              ShortTime period when address was/is in use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows addresses to be placed in historical context.

              Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              138. CertDIVOC.evidence.facility.address.streetAddress
              Definition

              Line 1 of the address

              ShortLine 1 of the address
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              140. CertDIVOC.evidence.facility.address.streetAddress2
              Definition

              Line 2 of the address

              ShortLine 2 of the address
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              142. CertDIVOC.evidence.facility.address.addressRegion
              Definition

              Sub-unit of country (abbreviations ok)

              ShortSub-unit of country (abbreviations ok)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              144. CertDIVOC.evidence.facility.address.addressCountry
              Definition

              Country (e.g. may be ISO 3166 2 or 3 letter code)

              ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
              Control0..1
              BindingThe codes SHOULD be taken from Iso3166-1-3
              (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              146. CertDIVOC.evidence.icd11Code
              Definition

              The specification for DIVOC does not provide any information beyond that this is an ICD-11 code, so correspondingly there is no required binding to a specific ValueSet in this logical model.

              ShortICD-11 code of this vaccine type (no binding information in spec)
              Control0..1
              BindingThe codes SHOULD be taken from WHO Vaccine List (COVID-19)
              (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              148. CertDIVOC.evidence.prophylaxis
              Definition

              Descriptive details of the vaccine type

              ShortDescriptive details of the vaccine type
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              150. CertDIVOC.evidence.testName
              Definition

              Lab test results: Test name

              ShortLab test results: Test name
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              152. CertDIVOC.evidence.testType
              Definition

              Lab test results: Type of test, either RT-PCR or Rapid Antigen Test (RAT)

              ShortLab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
              Control0..1
              BindingThe codes SHALL be taken from Lab Test - Type - DIVOC
              (required to http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              154. CertDIVOC.evidence.sampleOrigin
              Definition

              Lab test results: Type of sample that was taken (e.g., nasal swab

              ShortLab test results: Type of sample that was taken (e.g., `nasal swab`
              Control0..1
              BindingThe codes SHALL be taken from Lab Test - Sample Origin - DIVOC
              (required to http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              156. CertDIVOC.evidence.disease
              Definition

              Lab test results: Disease or agent targeted

              ShortLab test results: Disease or agent targeted
              Control0..1
              BindingThe codes SHALL be taken from Lab Test - Pathogen - DIVOC
              (required to http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              158. CertDIVOC.evidence.sampleCollectionTimestamp
              Definition

              Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601

              ShortLab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              160. CertDIVOC.evidence.resultTimestamp
              Definition

              Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601

              ShortLab test results: Results date and time; complete date, with time and time zone, following ISO 8601
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              162. CertDIVOC.evidence.result
              Definition

              Lab test results: result of test

              ShortLab test results: result of test
              Control0..1
              BindingThe codes SHALL be taken from Lab Test - Qualitative Result - DIVOC
              (required to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet)
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              164. CertDIVOC.proof
              Definition

              One or more cryptographic proofs that can be used to detect tampering and verify the authorship of a credential or presentation

              ShortProof
              Control1..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              166. CertDIVOC.proof.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              168. CertDIVOC.proof.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on CertDIVOC.proof.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 170. CertDIVOC.proof.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                172. CertDIVOC.proof.type
                Definition

                Type of proof

                ShortType of proof
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                174. CertDIVOC.proof.created
                Definition

                Signature date and time

                ShortSignature date and time
                Control0..1
                TypedateTime
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                176. CertDIVOC.proof.verificationMethod
                Definition

                Resolvable issuer identifier

                ShortResolvable issuer identifier
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                178. CertDIVOC.proof.proofPurpose
                Definition

                Clearly expresses the purpose for the proof and ensures this information is protected by the signature

                ShortPurpose of the signature
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                180. CertDIVOC.proof.jws
                Definition

                Signature

                ShortSignature
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension