{
"description": "Data elements for the DDCC Core Data Set.",
"_filename": "StructureDefinition-DDCCCoreDataSet.json",
"package_name": "who.ddcc",
"date": "2024-12-18T16:40:01+01:00",
"derivation": "specialization",
"publisher": "WHO",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "DDCCCoreDataSet",
"mapping": [ {
"uri": "http://smart.who.int/ddcc/StructureDefinition/DDCCComposition",
"name": "WHO Digital Documentation of COVID Certificates",
"identity": "ddcc-composition"
}, {
"uri": "http://smart.who.int/ddcc/StructureDefinition/DDCCPatient",
"name": "WHO Digital Documentation of COVID Certificates",
"identity": "ddcc-patient"
} ],
"abstract": true,
"type": "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "DDCC Core Data Set Logical Model",
"package_version": "1.0.1",
"snapshot": {
"element": [ {
"id": "DDCCCoreDataSet",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Base"
},
"path": "DDCCCoreDataSet",
"short": "DDCC Core Data Set Logical Model",
"definition": "Data elements for the DDCC Core Data Set.",
"isModifier": false
}, {
"path": "DDCCCoreDataSet.name",
"min": 1,
"definition": "The full name of the person.",
"short": "Name",
"mapping": [ {
"map": "Patient.name.text",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DDCCCoreDataSet.name",
"base": {
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.name"
},
"isSummary": true
}, {
"path": "DDCCCoreDataSet.birthDate",
"min": 0,
"definition": "The person's date of birth (DOB) if known. If unknown, use given DOB for administrative purposes",
"short": "Date of birth",
"mapping": [ {
"map": "Patient.birthDate",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "DDCCCoreDataSet.birthDate",
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.birthDate"
},
"isSummary": true
}, {
"path": "DDCCCoreDataSet.identifier",
"min": 0,
"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).",
"short": "Unique identifier",
"mapping": [ {
"map": "Patient.identifier",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DDCCCoreDataSet.identifier",
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DDCCCoreDataSet.certificate",
"min": 0,
"definition": "Metadata associated with the certificate",
"short": "Certificate Metadata",
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate",
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate"
},
"isSummary": true
}, {
"path": "DDCCCoreDataSet.certificate.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DDCCCoreDataSet.certificate.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DDCCCoreDataSet.certificate.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DDCCCoreDataSet.certificate.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DDCCCoreDataSet.certificate.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "DDCCCoreDataSet.certificate.issuer",
"min": 1,
"definition": "Certificate issuer.",
"short": "Certificate issuer",
"mapping": [ {
"map": "Composition.author.identifier",
"identity": "ddcc-composition"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://smart.who.int/ddcc/StructureDefinition/DDCCOrganization" ]
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.issuer",
"base": {
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.certificate.issuer"
},
"isSummary": true
}, {
"id": "DDCCCoreDataSet.certificate.kid",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.kid"
},
"path": "DDCCCoreDataSet.certificate.kid",
"type": [ {
"code": "string"
} ],
"short": "Key ID used to verify the signature of the certificate",
"definition": "Key ID"
}, {
"path": "DDCCCoreDataSet.certificate.hcid",
"min": 1,
"definition": "Health certificate identifier (HCID).",
"short": "Health certificate identifier (HCID)",
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.hcid",
"base": {
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.certificate.hcid"
},
"isSummary": true
}, {
"path": "DDCCCoreDataSet.certificate.ddccid",
"min": 0,
"definition": "DDCC Identifier",
"short": "DDCC Identifier",
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.ddccid",
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.ddccid"
},
"isSummary": true
}, {
"path": "DDCCCoreDataSet.certificate.version",
"min": 1,
"definition": "Certificate schema version",
"short": "Certificate schema version",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.version",
"base": {
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.certificate.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)"
} ],
"path": "DDCCCoreDataSet.certificate.period",
"min": 0,
"definition": "Certificate validity period.",
"short": "Certificate Validity Period",
"mapping": [ {
"map": "Composition.event.period",
"identity": "ddcc-composition"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.period",
"base": {
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.period"
}
}, {
"path": "DDCCCoreDataSet.certificate.period.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.period.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "DDCCCoreDataSet.certificate.period.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DDCCCoreDataSet.certificate.period.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DDCCCoreDataSet.certificate.period.start",
"min": 0,
"definition": "Start date of certificate validity.",
"isModifier": false,
"short": "Certificate valid from",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.period.start",
"condition": [ "per-1" ],
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "Period.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DDCCCoreDataSet.certificate.period.end",
"min": 0,
"definition": "End date of certificate validity.",
"isModifier": false,
"short": "Certificate valid until",
"mapping": [ {
"map": "DR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"max": "1",
"id": "DDCCCoreDataSet.certificate.period.end",
"condition": [ "per-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Period.end"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "174d68b2-aea6-471e-b5c8-26f0c85d09f2",
"kind": "logical",
"url": "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet",
"version": "1.0.1",
"differential": {
"element": [ {
"id": "DDCCCoreDataSet",
"path": "DDCCCoreDataSet",
"short": "DDCC Core Data Set Logical Model",
"definition": "Data elements for the DDCC Core Data Set."
}, {
"path": "DDCCCoreDataSet.name",
"min": 1,
"definition": "The full name of the person.",
"short": "Name",
"mapping": [ {
"map": "Patient.name.text",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "DDCCCoreDataSet.name",
"isSummary": true
}, {
"path": "DDCCCoreDataSet.birthDate",
"min": 0,
"definition": "The person's date of birth (DOB) if known. If unknown, use given DOB for administrative purposes",
"short": "Date of birth",
"mapping": [ {
"map": "Patient.birthDate",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "DDCCCoreDataSet.birthDate",
"isSummary": true
}, {
"path": "DDCCCoreDataSet.identifier",
"min": 0,
"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).",
"short": "Unique identifier",
"mapping": [ {
"map": "Patient.identifier",
"identity": "ddcc-patient"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "DDCCCoreDataSet.identifier",
"isSummary": true
}, {
"id": "DDCCCoreDataSet.certificate",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Certificate Metadata",
"isSummary": true,
"definition": "Metadata associated with the certificate"
}, {
"path": "DDCCCoreDataSet.certificate.issuer",
"min": 1,
"definition": "Certificate issuer.",
"short": "Certificate issuer",
"mapping": [ {
"map": "Composition.author.identifier",
"identity": "ddcc-composition"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://smart.who.int/ddcc/StructureDefinition/DDCCOrganization" ]
} ],
"max": "1",
"id": "DDCCCoreDataSet.certificate.issuer",
"isSummary": true
}, {
"id": "DDCCCoreDataSet.certificate.kid",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.kid",
"type": [ {
"code": "string"
} ],
"short": "Key ID used to verify the signature of the certificate",
"definition": "Key ID"
}, {
"id": "DDCCCoreDataSet.certificate.hcid",
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.certificate.hcid",
"type": [ {
"code": "Identifier"
} ],
"short": "Health certificate identifier (HCID)",
"isSummary": true,
"definition": "Health certificate identifier (HCID)."
}, {
"id": "DDCCCoreDataSet.certificate.ddccid",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.ddccid",
"type": [ {
"code": "Identifier"
} ],
"short": "DDCC Identifier",
"isSummary": true,
"definition": "DDCC Identifier"
}, {
"id": "DDCCCoreDataSet.certificate.version",
"max": "1",
"min": 1,
"path": "DDCCCoreDataSet.certificate.version",
"type": [ {
"code": "string"
} ],
"short": "Certificate schema version",
"isSummary": true,
"definition": "Certificate schema version"
}, {
"id": "DDCCCoreDataSet.certificate.period",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.period",
"type": [ {
"code": "Period"
} ],
"short": "Certificate Validity Period",
"mapping": [ {
"map": "Composition.event.period",
"identity": "ddcc-composition"
} ],
"definition": "Certificate validity period."
}, {
"id": "DDCCCoreDataSet.certificate.period.start",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.period.start",
"type": [ {
"code": "dateTime"
} ],
"short": "Certificate valid from",
"definition": "Start date of certificate validity."
}, {
"id": "DDCCCoreDataSet.certificate.period.end",
"max": "1",
"min": 0,
"path": "DDCCCoreDataSet.certificate.period.end",
"type": [ {
"code": "dateTime"
} ],
"short": "Certificate valid until",
"definition": "End date of certificate validity."
} ]
},
"contact": [ {
"name": "WHO",
"telecom": [ {
"value": "http://who.int",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}