WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.
| Draft as of 2024-01-19 |
{
"resourceType" : "StructureMap",
"id" : "IPSToCoreDataSetVS",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><pre>map "http://smart.who.int/ddcc/StructureMap/IPSToCoreDataSetVS" = "IPSToCoreDataSetVS"\r\n\r\n\r\nuses "http://hl7.org/fhir/StructureDefinition/Bundle" alias IPS as source\r\nuses "http://hl7.org/fhir/StructureDefinition/Bundle" alias DDCCBundle as target\r\nuses "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS.PoV" alias DDCC as produced\r\n\r\ngroup IPSToCoreDataSetVS(source ips : IPS, target ddccBundle : DDCCBundle) {\r\n ips.id as id -> ddccBundle.id = id "set id";\r\n ips.entry first as compentry then {\r\n compentry.resource : Composition as composition then {\r\n composition.subject as subject then {\r\n subject.reference as patientid then {\r\n ips.entry as findpatient where resource.is(Patient) and (resource.id = patientid.replaceMatches('.*Patient/(?<id>[A-Za-z0-9\\\\-\\\\.]{1,64})$', '${id}')) then {\r\n findpatient.resource as patient then {\r\n ips.entry as entry then {\r\n entry.resource : Immunization as immunization where vaccineCode.memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-allowed-vaccines-covid-19') -> ddccBundle.entry as outentry, create('http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS.PoV') as ddcc then {\r\n immunization then PatientToDDCC(patient, ddcc) "set patient info";\r\n immunization -> ddcc.vaccination as vaccination then ImmunizationToVaccination(immunization, vaccination) "set vaccination";\r\n immunization -> ddcc.certificate as certificate then IPSToCertificate(composition, certificate, immunization) "set certificate";\r\n immunization -> outentry.resource = ddcc "set outentry";\r\n } "immunizations";\r\n } "entries";\r\n } "get patient";\r\n } "find patient";\r\n } "get subject reference";\r\n } "get subject";\r\n } "get composition";\r\n } "get first entry";\r\n}\r\n\r\ngroup ImmunizationToVaccination(source immunization, target vaccination) {\r\n immunization.vaccineCode as vaccine then {\r\n vaccine.coding as coding where memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-vaccines-covid-19') then {\r\n coding -> vaccination.vaccine = coding "set coding";\r\n } "copy vaccine";\r\n vaccine.coding as coding where memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-vaccines-covid-19').not() then {\r\n coding -> vaccination.vaccine = translate(coding, 'who-ddcc-map-cvx-icd11-vaccines', 'Coding') "translate code";\r\n } "translate vaccine coding";\r\n vaccine.coding as coding -> vaccination.brand = translate(coding, 'who-ddcc-map-cvx-icd11-brands', 'Coding') "translate brand";\r\n } "set vaccine";\r\n immunization -> vaccination.country = c('urn:iso:std:iso:3166', 'USA') "set country";\r\n immunization.lotNumber as lot -> vaccination.lot = lot "set lot";\r\n immunization.occurrence as occurrence -> vaccination.date = occurrence "set date";\r\n immunization.manufacturer as manufacturer then {\r\n manufacturer.identifier as identifier -> vaccination.manufacturer as vMan then {\r\n identifier.system as system -> vMan.system = system "set manufacturer system";\r\n identifier.value as value -> vMan.code = value "set manufactutuer code";\r\n } "set manufacturer id";\r\n } "set manufacturer";\r\n}\r\n\r\ngroup IPSToCertificate(source composition, target certificate, source immunization) {\r\n immunization.id as id -> certificate.ddccid as ddccid, ddccid.value = id "set ddccid";\r\n composition.id as id -> certificate.hcid as hcid, hcid.value = id "set hcid";\r\n composition.author first as author -> certificate.issuer = author "set issuer";\r\n}\r\n\r\ngroup PatientToDDCC(source patient, target ddcc) {\r\n patient.name as name then NameToText(name, ddcc) "set name";\r\n patient.birthDate as birthDate -> ddcc.birthDate = birthDate "set birthdate";\r\n // patient.gender as gender -> ddcc.sex = gender "set sex";\r\n patient.identifier first as identifier -> ddcc.identifier = identifier "set identifier";\r\n}\r\n\r\ngroup NameToText(source name : HumanName, target ddcc) {\r\n // annoying because append doesn't work until ddcc.name is set\r\n name.given first as given -> ddcc.name = (given.replaceMatches('$', ' ')) "set first name";\r\n // name.given not_first as other -> ddcc.name as tName, ddcc.name = append( tName, other ) "set other names";\r\n name.given not_first as other -> ddcc.name as tName, (other.replaceMatches('$', ' ')) as spaced, ddcc.name = append(tName, spaced) "set other names";\r\n name.family as family -> ddcc.name as tName, ddcc.name = append(tName, family) "add family name";\r\n name.text as text -> ddcc.name = text "set full name";\r\n}\r\n\r\n</pre></div>"
},
"url" : "http://smart.who.int/ddcc/StructureMap/IPSToCoreDataSetVS",
"version" : "1.0.0",
"name" : "IPSToCoreDataSetVS",
"status" : "draft",
"date" : "2024-01-19T16:18:21+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"structure" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"mode" : "source",
"alias" : "IPS"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"mode" : "target",
"alias" : "DDCCBundle"
},
{
"url" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS.PoV",
"mode" : "produced",
"alias" : "DDCC"
}
],
"group" : [
{
"name" : "IPSToCoreDataSetVS",
"typeMode" : "none",
"input" : [
{
"name" : "ips",
"type" : "IPS",
"mode" : "source"
},
{
"name" : "ddccBundle",
"type" : "DDCCBundle",
"mode" : "target"
}
],
"rule" : [
{
"name" : "set id",
"source" : [
{
"context" : "ips",
"element" : "id",
"variable" : "id"
}
],
"target" : [
{
"context" : "ddccBundle",
"contextType" : "variable",
"element" : "id",
"transform" : "copy",
"parameter" : [
{
"valueId" : "id"
}
]
}
]
},
{
"name" : "get first entry",
"source" : [
{
"context" : "ips",
"element" : "entry",
"listMode" : "first",
"variable" : "compentry"
}
],
"rule" : [
{
"name" : "get composition",
"source" : [
{
"context" : "compentry",
"type" : "Composition",
"element" : "resource",
"variable" : "composition"
}
],
"rule" : [
{
"name" : "get subject",
"source" : [
{
"context" : "composition",
"element" : "subject",
"variable" : "subject"
}
],
"rule" : [
{
"name" : "get subject reference",
"source" : [
{
"context" : "subject",
"element" : "reference",
"variable" : "patientid"
}
],
"rule" : [
{
"name" : "find patient",
"source" : [
{
"context" : "ips",
"element" : "entry",
"variable" : "findpatient",
"condition" : "resource.is(Patient) and (resource.id = patientid.replaceMatches('.*Patient/(?<id>[A-Za-z0-9\\\\-\\\\.]{1,64})$', '${id}'))"
}
],
"rule" : [
{
"name" : "get patient",
"source" : [
{
"context" : "findpatient",
"element" : "resource",
"variable" : "patient"
}
],
"rule" : [
{
"name" : "entries",
"source" : [
{
"context" : "ips",
"element" : "entry",
"variable" : "entry"
}
],
"rule" : [
{
"name" : "immunizations",
"source" : [
{
"context" : "entry",
"type" : "Immunization",
"element" : "resource",
"variable" : "immunization",
"condition" : "vaccineCode.memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-allowed-vaccines-covid-19')"
}
],
"target" : [
{
"context" : "ddccBundle",
"contextType" : "variable",
"element" : "entry",
"variable" : "outentry"
},
{
"contextType" : "variable",
"variable" : "ddcc",
"transform" : "create",
"parameter" : [
{
"valueString" : "http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS.PoV"
}
]
}
],
"rule" : [
{
"name" : "set patient info",
"source" : [
{
"context" : "immunization"
}
],
"dependent" : [
{
"name" : "PatientToDDCC",
"variable" : [
"patient",
"ddcc"
]
}
]
},
{
"name" : "set vaccination",
"source" : [
{
"context" : "immunization"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "vaccination",
"variable" : "vaccination"
}
],
"dependent" : [
{
"name" : "ImmunizationToVaccination",
"variable" : [
"immunization",
"vaccination"
]
}
]
},
{
"name" : "set certificate",
"source" : [
{
"context" : "immunization"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "certificate",
"variable" : "certificate"
}
],
"dependent" : [
{
"name" : "IPSToCertificate",
"variable" : [
"composition",
"certificate",
"immunization"
]
}
]
},
{
"name" : "set outentry",
"source" : [
{
"context" : "immunization"
}
],
"target" : [
{
"context" : "outentry",
"contextType" : "variable",
"element" : "resource",
"transform" : "copy",
"parameter" : [
{
"valueId" : "ddcc"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"name" : "ImmunizationToVaccination",
"typeMode" : "none",
"input" : [
{
"name" : "immunization",
"mode" : "source"
},
{
"name" : "vaccination",
"mode" : "target"
}
],
"rule" : [
{
"name" : "set vaccine",
"source" : [
{
"context" : "immunization",
"element" : "vaccineCode",
"variable" : "vaccine"
}
],
"rule" : [
{
"name" : "copy vaccine",
"source" : [
{
"context" : "vaccine",
"element" : "coding",
"variable" : "coding",
"condition" : "memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-vaccines-covid-19')"
}
],
"rule" : [
{
"name" : "set coding",
"source" : [
{
"context" : "coding"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "vaccine",
"transform" : "copy",
"parameter" : [
{
"valueId" : "coding"
}
]
}
]
}
]
},
{
"name" : "translate vaccine coding",
"source" : [
{
"context" : "vaccine",
"element" : "coding",
"variable" : "coding",
"condition" : "memberOf('http://smart.who.int/ddcc/ValueSet/who-ddcc-vaccines-covid-19').not()"
}
],
"rule" : [
{
"name" : "translate code",
"source" : [
{
"context" : "coding"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "vaccine",
"transform" : "translate",
"parameter" : [
{
"valueId" : "coding"
},
{
"valueString" : "who-ddcc-map-cvx-icd11-vaccines"
},
{
"valueString" : "Coding"
}
]
}
]
}
]
},
{
"name" : "translate brand",
"source" : [
{
"context" : "vaccine",
"element" : "coding",
"variable" : "coding"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "brand",
"transform" : "translate",
"parameter" : [
{
"valueId" : "coding"
},
{
"valueString" : "who-ddcc-map-cvx-icd11-brands"
},
{
"valueString" : "Coding"
}
]
}
]
}
]
},
{
"name" : "set country",
"source" : [
{
"context" : "immunization"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "country",
"transform" : "c",
"parameter" : [
{
"valueString" : "urn:iso:std:iso:3166"
},
{
"valueString" : "USA"
}
]
}
]
},
{
"name" : "set lot",
"source" : [
{
"context" : "immunization",
"element" : "lotNumber",
"variable" : "lot"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "lot",
"transform" : "copy",
"parameter" : [
{
"valueId" : "lot"
}
]
}
]
},
{
"name" : "set date",
"source" : [
{
"context" : "immunization",
"element" : "occurrence",
"variable" : "occurrence"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "date",
"transform" : "copy",
"parameter" : [
{
"valueId" : "occurrence"
}
]
}
]
},
{
"name" : "set manufacturer",
"source" : [
{
"context" : "immunization",
"element" : "manufacturer",
"variable" : "manufacturer"
}
],
"rule" : [
{
"name" : "set manufacturer id",
"source" : [
{
"context" : "manufacturer",
"element" : "identifier",
"variable" : "identifier"
}
],
"target" : [
{
"context" : "vaccination",
"contextType" : "variable",
"element" : "manufacturer",
"variable" : "vMan"
}
],
"rule" : [
{
"name" : "set manufacturer system",
"source" : [
{
"context" : "identifier",
"element" : "system",
"variable" : "system"
}
],
"target" : [
{
"context" : "vMan",
"contextType" : "variable",
"element" : "system",
"transform" : "copy",
"parameter" : [
{
"valueId" : "system"
}
]
}
]
},
{
"name" : "set manufactutuer code",
"source" : [
{
"context" : "identifier",
"element" : "value",
"variable" : "value"
}
],
"target" : [
{
"context" : "vMan",
"contextType" : "variable",
"element" : "code",
"transform" : "copy",
"parameter" : [
{
"valueId" : "value"
}
]
}
]
}
]
}
]
}
]
},
{
"name" : "IPSToCertificate",
"typeMode" : "none",
"input" : [
{
"name" : "composition",
"mode" : "source"
},
{
"name" : "certificate",
"mode" : "target"
},
{
"name" : "immunization",
"mode" : "source"
}
],
"rule" : [
{
"name" : "set ddccid",
"source" : [
{
"context" : "immunization",
"element" : "id",
"variable" : "id"
}
],
"target" : [
{
"context" : "certificate",
"contextType" : "variable",
"element" : "ddccid",
"variable" : "ddccid"
},
{
"context" : "ddccid",
"contextType" : "variable",
"element" : "value",
"transform" : "copy",
"parameter" : [
{
"valueId" : "id"
}
]
}
]
},
{
"name" : "set hcid",
"source" : [
{
"context" : "composition",
"element" : "id",
"variable" : "id"
}
],
"target" : [
{
"context" : "certificate",
"contextType" : "variable",
"element" : "hcid",
"variable" : "hcid"
},
{
"context" : "hcid",
"contextType" : "variable",
"element" : "value",
"transform" : "copy",
"parameter" : [
{
"valueId" : "id"
}
]
}
]
},
{
"name" : "set issuer",
"source" : [
{
"context" : "composition",
"element" : "author",
"listMode" : "first",
"variable" : "author"
}
],
"target" : [
{
"context" : "certificate",
"contextType" : "variable",
"element" : "issuer",
"transform" : "copy",
"parameter" : [
{
"valueId" : "author"
}
]
}
]
}
]
},
{
"name" : "PatientToDDCC",
"typeMode" : "none",
"input" : [
{
"name" : "patient",
"mode" : "source"
},
{
"name" : "ddcc",
"mode" : "target"
}
],
"rule" : [
{
"name" : "set name",
"source" : [
{
"context" : "patient",
"element" : "name",
"variable" : "name"
}
],
"dependent" : [
{
"name" : "NameToText",
"variable" : [
"name",
"ddcc"
]
}
]
},
{
"name" : "set birthdate",
"source" : [
{
"context" : "patient",
"element" : "birthDate",
"variable" : "birthDate"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "birthDate",
"transform" : "copy",
"parameter" : [
{
"valueId" : "birthDate"
}
]
}
]
},
{
"name" : "set identifier",
"source" : [
{
"context" : "patient",
"element" : "identifier",
"listMode" : "first",
"variable" : "identifier"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "identifier",
"transform" : "copy",
"parameter" : [
{
"valueId" : "identifier"
}
]
}
],
"documentation" : "patient.gender as gender -> ddcc.sex = gender \"set sex\";"
}
]
},
{
"name" : "NameToText",
"typeMode" : "none",
"input" : [
{
"name" : "name",
"type" : "HumanName",
"mode" : "source"
},
{
"name" : "ddcc",
"mode" : "target"
}
],
"rule" : [
{
"name" : "set first name",
"source" : [
{
"context" : "name",
"element" : "given",
"listMode" : "first",
"variable" : "given"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "given.replaceMatches('$', ' ')"
}
]
}
],
"documentation" : "annoying because append doesn't work until ddcc.name is set"
},
{
"name" : "set other names",
"source" : [
{
"context" : "name",
"element" : "given",
"listMode" : "not_first",
"variable" : "other"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"variable" : "tName"
},
{
"contextType" : "variable",
"variable" : "spaced",
"transform" : "evaluate",
"parameter" : [
{
"valueString" : "other.replaceMatches('$', ' ')"
}
]
},
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"transform" : "append",
"parameter" : [
{
"valueId" : "tName"
},
{
"valueId" : "spaced"
}
]
}
],
"documentation" : "name.given not_first as other -> ddcc.name as tName, ddcc.name = append( tName, other ) \"set other names\";"
},
{
"name" : "add family name",
"source" : [
{
"context" : "name",
"element" : "family",
"variable" : "family"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"variable" : "tName"
},
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"transform" : "append",
"parameter" : [
{
"valueId" : "tName"
},
{
"valueId" : "family"
}
]
}
]
},
{
"name" : "set full name",
"source" : [
{
"context" : "name",
"element" : "text",
"variable" : "text"
}
],
"target" : [
{
"context" : "ddcc",
"contextType" : "variable",
"element" : "name",
"transform" : "copy",
"parameter" : [
{
"valueId" : "text"
}
]
}
]
}
]
}
]
}
IG © 2021+ WHO. Package who.ddcc#1.0.0 based on FHIR 4.0.1. Generated 2024-01-19
Links: Table of Contents |
QA Report
| Issues
| Version History | License