WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
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
| Draft as of 2024-10-15 |
JSON representation of the DDCCCoreDataSetVSPoV logical model.
{
"resourceType" : "StructureDefinition",
"id" : "DDCCCoreDataSetVSPoV",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition DDCCCoreDataSetVSPoV</b></p><a name=\"DDCCCoreDataSetVSPoV\"> </a><a name=\"hcDDCCCoreDataSetVSPoV\"> </a><a name=\"DDCCCoreDataSetVSPoV-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DDCCCoreDataSetVSPoV-definitions.html#DDCCCoreDataSet\" title=\"Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination.\">DDCCCoreDataSet</a><a name=\"DDCCCoreDataSet\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-DDCCCoreDataSetVS.html\">DDCCCoreDataSetVS</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-DDCCCoreDataSet.html\" title=\"The full name of the person.\">name</a>, <a href=\"StructureDefinition-DDCCCoreDataSet.html\" title=\"The person's date of birth (DOB) if known. If unknown, use given DOB for administrative purposes\">birthDate</a>, <a href=\"StructureDefinition-DDCCCoreDataSet.html\" title=\"Unique identifier for the person, according to the policies applicable to each country. There can be more than one unique identifier used to link records. (e.g. national ID, health ID, immunization information system ID, medical record ID).\">identifier</a>, <a href=\"StructureDefinition-DDCCCoreDataSet.html\" title=\"Metadata associated with the certificate\">certificate</a>, <a href=\"StructureDefinition-DDCCCoreDataSetVS.html\" title=\"A vaccination event.\">vaccination</a><br/>DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSetVSPoV",
"version" : "1.0.0",
"name" : "DDCCCoreDataSetVSPoV",
"title" : "DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination",
"status" : "draft",
"date" : "2024-10-15T11:00:36+02:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "ddcc-immunization",
"uri" : "http://smart.who.int/ddcc/StructureDefinition/DDCCImmunization",
"name" : "WHO Digital Documentation of COVID Certificates"
},
{
"identity" : "ddcc-immunization-recommendation",
"uri" : "http://smart.who.int/ddcc/StructureDefinition/DDCCImmunizationRecommendation",
"name" : "WHO Digital Documentation of COVID Certificates"
},
{
"identity" : "ddcc-composition",
"uri" : "http://smart.who.int/ddcc/StructureDefinition/DDCCComposition",
"name" : "WHO Digital Documentation of COVID Certificates"
},
{
"identity" : "ddcc-patient",
"uri" : "http://smart.who.int/ddcc/StructureDefinition/DDCCPatient",
"name" : "WHO Digital Documentation of COVID Certificates"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet",
"baseDefinition" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSetVS",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "DDCCCoreDataSet",
"path" : "DDCCCoreDataSet",
"short" : "DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination",
"definition" : "Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "DDCCCoreDataSet.name",
"path" : "DDCCCoreDataSet.name",
"short" : "Name",
"definition" : "The full name of the person.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.name",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-patient",
"map" : "Patient.name.text"
}
]
},
{
"id" : "DDCCCoreDataSet.birthDate",
"path" : "DDCCCoreDataSet.birthDate",
"short" : "Date of birth",
"definition" : "The person's date of birth (DOB) if known. If unknown, use given DOB for administrative purposes",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-patient",
"map" : "Patient.birthDate"
}
]
},
{
"id" : "DDCCCoreDataSet.identifier",
"path" : "DDCCCoreDataSet.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the person, according to the policies applicable to each country. There can be more than one unique identifier used to link records. (e.g. national ID, health ID, immunization information system ID, medical record ID).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-patient",
"map" : "Patient.identifier"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate",
"path" : "DDCCCoreDataSet.certificate",
"short" : "Certificate Metadata",
"definition" : "Metadata associated with the certificate",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true
},
{
"id" : "DDCCCoreDataSet.certificate.id",
"path" : "DDCCCoreDataSet.certificate.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.extension",
"path" : "DDCCCoreDataSet.certificate.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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.",
"comment" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.modifierExtension",
"path" : "DDCCCoreDataSet.certificate.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.issuer",
"path" : "DDCCCoreDataSet.certificate.issuer",
"short" : "Certificate issuer",
"definition" : "Certificate issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.issuer",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://smart.who.int/ddcc/StructureDefinition/DDCCOrganization"
]
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.protocolApplied.authority.identifier"
},
{
"identity" : "ddcc-composition",
"map" : "Composition.author.identifier"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.kid",
"path" : "DDCCCoreDataSet.certificate.kid",
"short" : "Key ID used to verify the signature of the certificate",
"definition" : "Key ID",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.kid",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.hcid",
"path" : "DDCCCoreDataSet.certificate.hcid",
"short" : "Health certificate identifier (HCID)",
"definition" : "Health certificate identifier (HCID).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.hcid",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true
},
{
"id" : "DDCCCoreDataSet.certificate.ddccid",
"path" : "DDCCCoreDataSet.certificate.ddccid",
"short" : "DDCC Identifier",
"definition" : "DDCC Identifier",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.ddccid",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true
},
{
"id" : "DDCCCoreDataSet.certificate.version",
"path" : "DDCCCoreDataSet.certificate.version",
"short" : "Certificate schema version",
"definition" : "Certificate schema version",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.version",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true
},
{
"id" : "DDCCCoreDataSet.certificate.period",
"path" : "DDCCCoreDataSet.certificate.period",
"short" : "Certificate Validity Period",
"definition" : "Certificate validity period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.certificate.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath" : "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet"
}
],
"mapping" : [
{
"identity" : "ddcc-composition",
"map" : "Composition.event.period"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.period.id",
"path" : "DDCCCoreDataSet.certificate.period.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.period.extension",
"path" : "DDCCCoreDataSet.certificate.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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.",
"comment" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.period.start",
"path" : "DDCCCoreDataSet.certificate.period.start",
"short" : "Certificate valid from",
"definition" : "Start date of certificate validity.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "DDCCCoreDataSet.certificate.period.end",
"path" : "DDCCCoreDataSet.certificate.period.end",
"short" : "Certificate valid until",
"definition" : "End date of certificate validity.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination",
"path" : "DDCCCoreDataSet.vaccination",
"short" : "Vaccination Event",
"definition" : "A vaccination event.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "who-ddcc-data-1",
"severity" : "error",
"human" : "Manufacturer or Market Authorization Holder SHALL be present",
"expression" : "manufacturer.exists() or maholder.exists()",
"source" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSetVS"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary" : true
},
{
"id" : "DDCCCoreDataSet.vaccination.id",
"path" : "DDCCCoreDataSet.vaccination.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.extension",
"path" : "DDCCCoreDataSet.vaccination.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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.",
"comment" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.modifierExtension",
"path" : "DDCCCoreDataSet.vaccination.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.vaccine",
"path" : "DDCCCoreDataSet.vaccination.vaccine",
"short" : "Vaccine or prophylaxis",
"definition" : "Generic description of the vaccine or vaccine sub-type. e.g. COVID-19 mRNA vaccine, HPV vaccine.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.vaccine",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"strength" : "preferred",
"valueSet" : "http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19"
},
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.vaccineCode"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.brand",
"path" : "DDCCCoreDataSet.vaccination.brand",
"short" : "Vaccine brand",
"definition" : "The brand or trade name used to refer to the vaccine received.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.brand",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.extension[https://smart.who.int/ddcc/StructureDefinition/DDCCEventBrand]"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.manufacturer",
"path" : "DDCCCoreDataSet.vaccination.manufacturer",
"short" : "Vaccine manufacturer",
"definition" : "Name of the manufacturer of the vaccine received. e.g. Serum institute of India, AstraZeneca. If vaccine manufacturer is unknown, market authorization holder is REQUIRED.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.manufacturer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.manufacturer"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.maholder",
"path" : "DDCCCoreDataSet.vaccination.maholder",
"short" : "Vaccine market authorization holder",
"definition" : "Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.maholder",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.extension[https://smart.who.int/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization]"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.lot",
"path" : "DDCCCoreDataSet.vaccination.lot",
"short" : "Vaccine lot number",
"definition" : "Lot number or batch number of vaccination.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.lot",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.lotNumber"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.date",
"path" : "DDCCCoreDataSet.vaccination.date",
"short" : "Date of vaccination",
"definition" : "Date in which the vaccine was provided.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.date",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.occurrence"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.validFrom",
"path" : "DDCCCoreDataSet.vaccination.validFrom",
"short" : "Vaccination valid from",
"definition" : "Date upon which provided vaccination is considered valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.validFrom",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.extension[https://smart.who.int/ddcc/StructureDefinition/DDCCVaccineValidFrom]"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.dose",
"path" : "DDCCCoreDataSet.vaccination.dose",
"short" : "Dose number",
"definition" : "Vaccine dose number.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.dose",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.protocolApplied.doseNumber"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.totalDoses",
"path" : "DDCCCoreDataSet.vaccination.totalDoses",
"short" : "Total doses",
"definition" : "Total expected doses as defined by Member State care plan and immunization programme policies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.totalDoses",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.protocolApplied.seriesDoses"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.country",
"path" : "DDCCCoreDataSet.vaccination.country",
"short" : "Country of vaccination",
"definition" : "The country in which the individual has been vaccinated.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.country",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"strength" : "preferred",
"valueSet" : "http://hl7.org/fhir/ValueSet/iso3166-1-3"
},
"mapping" : [
{
"identity" : "ddcc",
"map" : "Immunization.extension.where(url='https://smart.who.int/ddcc/StructureDefinition/DDCCCountryOfVaccination')"
},
{
"identity" : "ddcc-immunization",
"map" : "Immunization.extension[https://smart.who.int/ddcc/StructureDefinition/DDCCCountryOfEvent]"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.centre",
"path" : "DDCCCoreDataSet.vaccination.centre",
"short" : "Administering centre",
"definition" : "The name or identifier of the vaccination facility responsible for providing the vaccination.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.centre",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.location"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.signature",
"path" : "DDCCCoreDataSet.vaccination.signature",
"short" : "Signature of health worker",
"definition" : "REQUIRED for PAPER vaccination certificates ONLY. The health worker who provided the vaccination or the supervising clinician's hand-written signature.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.signature",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Signature"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.practitioner",
"path" : "DDCCCoreDataSet.vaccination.practitioner",
"short" : "Health worker identifier",
"definition" : "OPTIONAL for DIGITAL and PAPER vaccination certificates. The unique identifier for the health worker as determined by the member state. There can be more than one unique identifier used. (e.g. system generated ID, health profession number, cryptographic signature, or any other form of health worker unique identifier). This can be used in lieu of a paper-based signature.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.practitioner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.performer.actor"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.disease",
"path" : "DDCCCoreDataSet.vaccination.disease",
"short" : "Disease or agent targeted",
"definition" : "Name of disease vaccinated against (such as COVID-19).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.disease",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19"
},
"mapping" : [
{
"identity" : "ddcc-immunization",
"map" : "Immunization.protocolApplied.targetDisease"
}
]
},
{
"id" : "DDCCCoreDataSet.vaccination.nextDose",
"path" : "DDCCCoreDataSet.vaccination.nextDose",
"short" : "Due date of next dose",
"definition" : "Date on which the next vaccination should be administered, if a next dose is REQUIRED.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DDCCCoreDataSet.vaccination.nextDose",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"mapping" : [
{
"identity" : "ddcc-immunization-recommendation",
"map" : "ImmunizationRecommendation.dateCriterion.value"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "DDCCCoreDataSet",
"path" : "DDCCCoreDataSet",
"short" : "DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination",
"definition" : "Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination."
}
]
}
}