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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: Certificate - DIVOC Verifiable Credential Logical Model ( Abstract )

Official URL: http://smart.who.int/ddcc/StructureDefinition/CertDIVOC Version: 1.0.0
Draft as of 2024-10-15 Computable Name: CertDIVOC

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.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... district 0..1 string District name (aka county)
...... city 0..1 string Name of city, town etc.
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
...... postalCode 0..1 string Postal code for area
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... state Σ 0..1 string Sub-unit of country (abbreviations ok)
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(10 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... district 0..1 string District name (aka county)
...... city 0..1 string Name of city, town etc.
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
...... postalCode 0..1 string Postal code for area
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertDIVOC 0..* Base This is an abstracttype.
Certificate - DIVOC Verifiable Credential Logical Model
Instances of this logical model are not marked to be the target of a Reference
... context 1..* string Context (JSON-LD) - should actually be `@context` but this name isn't supported by FHIR.
... type 1..* string Type
... issuer 1..1 string Issuer identifier
... nonTransferable 0..1 boolean Non Trasnferability
... credentialSubject 1..1 BackboneElement CredentialSubject
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..* string type
.... uhid 0..1 string another id
.... refId 0..1 string reference id
.... name 0..1 string A name associated with the patient
.... gender 0..1 string Gender (`Male` or `Female`; unknown if there are other options)
.... sex 0..1 string Sex (not used in examples; presumably `Male` or `Female`; unknown if there are other options)
.... age 0..1 string Age
.... dob 0..1 date The date of birth for the individual (V2 only)
.... nationality 0..1 string Nationality
.... address 0..1 BackboneElement Address
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... streetAddress 0..1 string Line 1 of the address
..... streetAddress2 0..1 string Line 2 of the address
..... district 0..1 string District name (aka county)
..... city 0..1 string Name of city, town etc.
..... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
..... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
..... postalCode 0..1 string Postal code for area
... evidence 0..* BackboneElement Evidence
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... feedbackUrl 0..1 string URL for feedback
.... infoUrl 0..1 string URL for more information on this record
.... certificateId 0..1 string Certificate Unique Identifier
.... type 1..* string type
.... batch 0..1 string Vaccine lot number
.... vaccine 0..1 string Vaccine description. Might include vaccine type and brand
.... manufacturer 0..1 string Name of the Vaccine/Test Manufacturer
.... date 0..1 dateTime Date of immunization
.... effectiveStart 0..1 date Effective immunization start date
.... effectiveUntil 0..1 date Effective immunization end date
.... dose 0..1 positiveInt Dose Number
.... totalDoses 0..1 positiveInt Total doses for this vaccine protocol regimen
.... verifier 0..1 BackboneElement Verifier
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the practitioner
.... facility 0..1 BackboneElement Facility
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 0..1 string Name of the facility/entity
..... address 0..1 Address Address of the facility
...... @id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... state Σ 0..1 string Sub-unit of country (abbreviations ok)
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... streetAddress 0..1 string Line 1 of the address
...... streetAddress2 0..1 string Line 2 of the address
...... addressRegion 0..1 string Sub-unit of country (abbreviations ok)
...... addressCountry 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (preferred)
.... icd11Code 0..1 string ICD-11 code of this vaccine type (no binding information in spec)
Binding: WHO Vaccine List (COVID-19) (preferred)
.... prophylaxis 0..1 string Descriptive details of the vaccine type
.... testName 0..1 string Lab test results: Test name
.... testType 0..1 string Lab test results: Type of test, either `RT-PCR` or `Rapid Antigen Test (RAT)`
Binding: Lab Test - Type - DIVOC (required)
.... sampleOrigin 0..1 string Lab test results: Type of sample that was taken (e.g., `nasal swab`
Binding: Lab Test - Sample Origin - DIVOC (required)
.... disease 0..1 string Lab test results: Disease or agent targeted
Binding: Lab Test - Pathogen - DIVOC (required)
.... sampleCollectionTimestamp 0..1 dateTime Lab test results: Sample collection date and time; complete date, with time and time zone, following ISO 8601
.... resultTimestamp 0..1 dateTime Lab test results: Results date and time; complete date, with time and time zone, following ISO 8601
.... result 0..1 string Lab test results: result of test
Binding: Lab Test - Qualitative Result - DIVOC (required)
... proof 1..* BackboneElement Proof
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string Type of proof
.... created 0..1 dateTime Signature date and time
.... verificationMethod 1..1 string Resolvable issuer identifier
.... proofPurpose 0..1 string Purpose of the signature
.... jws 1..1 string Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CertDIVOC.evidence.facility.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
CertDIVOC.evidence.facility.address.addressCountrypreferredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
CertDIVOC.evidence.icd11CodepreferredWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
CertDIVOC.evidence.testTyperequiredLabTestTypeDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestTypeDivocValueSet
from this IG
CertDIVOC.evidence.sampleOriginrequiredLabTestSampleOriginDivocValueSet
http://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-divoc
from this IG
CertDIVOC.evidence.diseaserequiredLabTestPathogenDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestPathogenDivocValueSet
from this IG
CertDIVOC.evidence.resultrequiredLabTestQualitativeResultDivocValueSet
http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultDivocValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(10 nested mandatory elements)

 

Other representations of profile: CSV, Excel