001package org.hl7.fhir.r5.utils; 002 003/*- 004 * #%L 005 * org.hl7.fhir.r5 006 * %% 007 * Copyright (C) 2014 - 2019 Health Level 7 008 * %% 009 * Licensed under the Apache License, Version 2.0 (the "License"); 010 * you may not use this file except in compliance with the License. 011 * You may obtain a copy of the License at 012 * 013 * http://www.apache.org/licenses/LICENSE-2.0 014 * 015 * Unless required by applicable law or agreed to in writing, software 016 * distributed under the License is distributed on an "AS IS" BASIS, 017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 018 * See the License for the specific language governing permissions and 019 * limitations under the License. 020 * #L% 021 */ 022 023import java.io.File; 024import java.io.FileInputStream; 025import java.io.FileNotFoundException; 026import java.io.FileOutputStream; 027import java.io.IOException; 028import java.io.InputStream; 029import java.util.ArrayList; 030import java.util.HashMap; 031import java.util.List; 032import java.util.Map; 033 034import org.hl7.fhir.exceptions.FHIRException; 035import org.hl7.fhir.r5.formats.IParser.OutputStyle; 036import org.hl7.fhir.r5.formats.JsonParser; 037import org.hl7.fhir.r5.model.ConceptMap; 038import org.hl7.fhir.r5.model.ConceptMap.ConceptMapGroupComponent; 039import org.hl7.fhir.r5.model.ConceptMap.OtherElementComponent; 040import org.hl7.fhir.r5.model.ConceptMap.SourceElementComponent; 041import org.hl7.fhir.r5.model.ConceptMap.TargetElementComponent; 042import org.hl7.fhir.r5.model.DateTimeType; 043import org.hl7.fhir.r5.model.Enumerations.ConceptMapRelationship; 044import org.hl7.fhir.r5.model.Enumerations.PublicationStatus; 045import org.hl7.fhir.r5.model.IdType; 046import org.hl7.fhir.r5.model.CanonicalResource; 047import org.hl7.fhir.r5.model.StringType; 048import org.hl7.fhir.r5.model.StructureMap; 049import org.hl7.fhir.r5.model.StructureMap.StructureMapContextType; 050import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupComponent; 051import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleComponent; 052import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleDependentComponent; 053import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleSourceComponent; 054import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleTargetComponent; 055import org.hl7.fhir.r5.model.StructureMap.StructureMapGroupTypeMode; 056import org.hl7.fhir.r5.model.StructureMap.StructureMapTransform; 057import org.hl7.fhir.r5.model.UrlType; 058import org.hl7.fhir.utilities.CSVReader; 059import org.hl7.fhir.utilities.TextFile; 060import org.hl7.fhir.utilities.Utilities; 061 062public class MappingSheetParser { 063 064 public class MappingRow { 065 private String sequence; 066 private String identifier; 067 private String name; 068 private String dataType; 069 private String cardinality; 070 private String condition; 071 private String attribute; 072 private String type; 073 private String minMax; 074 private String dtMapping; 075 private String vocabMapping; 076 private String derived; 077 private String derivedMapping; 078 private String comments; 079 public String getSequence() { 080 return sequence; 081 } 082 public String getIdentifier() { 083 return identifier; 084 } 085 public String getName() { 086 return name; 087 } 088 public String getDataType() { 089 return dataType; 090 } 091 public String getCardinality() { 092 return cardinality; 093 } 094 public int getCardinalityMin() { 095 return Integer.parseInt(cardinality.split("\\.")[0]); 096 } 097 public String getCardinalityMax() { 098 return cardinality.split("\\.")[2]; 099 } 100 public String getCondition() { 101 return condition; 102 } 103 public String getAttribute() { 104 return attribute; 105 } 106 public String getType() { 107 return type; 108 } 109 public String getMinMax() { 110 return minMax; 111 } 112 public String getDtMapping() { 113 return dtMapping; 114 } 115 public String getVocabMapping() { 116 return vocabMapping; 117 } 118 public String getDerived() { 119 return derived; 120 } 121 public String getDerivedMapping() { 122 return derivedMapping; 123 } 124 public String getComments() { 125 return comments; 126 } 127 128 } 129 130 131 private List<MappingRow> rows = new ArrayList<>(); 132 private Map<String, String> metadata = new HashMap<>(); 133 134 public MappingSheetParser() { 135 super(); 136 } 137 138 public void parse(InputStream stream, String name) throws FHIRException, IOException { 139 CSVReader csv = new CSVReader(stream); 140 checkHeaders1(csv, name); 141 checkHeaders2(csv, name); 142 while (csv.line()) { 143 processRow(csv); 144 } 145 } 146 147 private void checkHeaders1(CSVReader csv, String name) throws FHIRException, IOException { 148 csv.readHeaders(); 149 csv.checkColumn(1, "HL7 v2", "Mapping Sheet "+name); 150 csv.checkColumn(6, "Condition (IF True)", "Mapping Sheet "+name); 151 csv.checkColumn(7, "HL7 FHIR", "Mapping Sheet "+name); 152 csv.checkColumn(14, "Comments", "Mapping Sheet "+name); 153 csv.checkColumn(16, "Name", "Mapping Sheet "+name); 154 csv.checkColumn(17, "Value", "Mapping Sheet "+name); 155 } 156 157 private void checkHeaders2(CSVReader csv, String name) throws FHIRException, IOException { 158 csv.readHeaders(); 159 csv.checkColumn(1, "Display Sequence", "Mapping Sheet "+name); 160 csv.checkColumn(2, "Identifier", "Mapping Sheet "+name); 161 csv.checkColumn(3, "Name", "Mapping Sheet "+name); 162 csv.checkColumn(4, "Data Type", "Mapping Sheet "+name); 163 csv.checkColumn(5, "Cardinality", "Mapping Sheet "+name); 164 csv.checkColumn(7, "FHIR Attribute", "Mapping Sheet "+name); 165 csv.checkColumn(8, "Data Type", "Mapping Sheet "+name); 166 csv.checkColumn(9, "Cardinality", "Mapping Sheet "+name); 167 csv.checkColumn(10, "Data Type Mapping", "Mapping Sheet "+name); 168 csv.checkColumn(11, "Vocabulary Mapping\n(IS, ID, CE, CNE, CWE)", "Mapping Sheet "+name); 169 csv.checkColumn(12, "Derived Mapping", "Mapping Sheet "+name); 170 } 171 172 private void processRow(CSVReader csv) { 173 MappingRow mr = new MappingRow(); 174 mr.sequence = csv.value(1); 175 mr.identifier = csv.value(2); 176 mr.name = csv.value(3); 177 mr.dataType = csv.value(4); 178 mr.cardinality = csv.value(5); 179 mr.condition = csv.value(6); 180 mr.attribute = csv.value(7); 181 mr.type = csv.value(8); 182 mr.minMax = csv.value(9); 183 mr.dtMapping = csv.value(10); 184 mr.vocabMapping = csv.value(11); 185 mr.derived = csv.value(12); 186 if (!Utilities.noString(mr.derived)) { 187 String[] s = mr.derived.split("\\="); 188 mr.derived = s[0].trim(); 189 mr.derivedMapping = s[1].trim(); 190 } 191 mr.comments = csv.value(14); 192 rows.add(mr); 193 if (!org.hl7.fhir.utilities.Utilities.noString(csv.value(16))) 194 metadata.put(csv.value(16), csv.value(17)); 195 } 196 197 public List<MappingRow> getRows() { 198 return rows; 199 } 200 201 public ConceptMap getConceptMap() throws FHIRException { 202 ConceptMap map = new ConceptMap(); 203 loadMetadata(map); 204 if (metadata.containsKey("copyright")) 205 map.setCopyright(metadata.get("copyright")); 206 for (MappingRow row : rows) { 207 SourceElementComponent element = map.getGroupFirstRep().addElement(); 208 element.setCode(row.getIdentifier()); 209 element.setId(row.getSequence()); 210 element.setDisplay(row.getName()+" : "+row.getDataType()+" ["+row.getCardinality()+"]"); 211 element.addExtension(ToolingExtensions.EXT_MAPPING_NAME, new StringType(row.getName())); 212 element.addExtension(ToolingExtensions.EXT_MAPPING_TYPE, new StringType(row.getDataType())); 213 element.addExtension(ToolingExtensions.EXT_MAPPING_CARD, new StringType(row.getCardinality())); 214 if ("N/A".equals(row.getAttribute())) 215 element.setNoMap(true); 216 else { 217 element.getTargetFirstRep().setRelationship(ConceptMapRelationship.RELATEDTO); 218 if (row.getCondition() != null) 219 element.getTargetFirstRep().addDependsOn().setProperty("http://hl7.org/fhirpath").setValue(processCondition(row.getCondition())); 220 element.getTargetFirstRep().setCode(row.getAttribute()); 221 element.getTargetFirstRep().setDisplay(row.getType()+" : ["+row.getMinMax()+"]"); 222 element.getTargetFirstRep().addExtension(ToolingExtensions.EXT_MAPPING_TGTTYPE, new StringType(row.getType())); 223 element.getTargetFirstRep().addExtension(ToolingExtensions.EXT_MAPPING_TGTCARD, new StringType(row.getMinMax())); 224 if (row.getDerived() != null) 225 element.getTargetFirstRep().getProductFirstRep().setProperty(row.getDerived()).setValue(row.getDerivedMapping()); 226 if (row.getComments() != null) 227 element.getTargetFirstRep().setComment(row.getComments()); 228 if (row.getDtMapping() != null) 229 element.getTargetFirstRep().addExtension("http://hl7.org/fhir/StructureDefinition/ConceptMap-type-mapping", new UrlType("todo#"+row.getDtMapping())); 230 if (row.getVocabMapping() != null) 231 element.getTargetFirstRep().addExtension("http://hl7.org/fhir/StructureDefinition/ConceptMap-vocab-mapping", new UrlType("todo#"+row.getVocabMapping())); 232 } 233 } 234 return map; 235 } 236 237 private String processCondition(String condition) { 238 if (condition.startsWith("IF ") && condition.endsWith(" IS VALUED")) 239 return "`"+condition.substring(4, condition.length()-10)+"`.exists()"; 240 if (condition.startsWith("IF ") && condition.endsWith(" DOES NOT EXIST")) 241 return "`"+condition.substring(4, condition.length()-15)+"`.exists()"; 242 throw new Error("not processed yet: "+condition); 243 } 244 245 private void loadMetadata(CanonicalResource mr) throws FHIRException { 246 if (metadata.containsKey("id")) 247 mr.setId(metadata.get("id")); 248 if (metadata.containsKey("url")) 249 mr.setUrl(metadata.get("url")); 250 if (metadata.containsKey("name")) 251 mr.setName(metadata.get("name")); 252 if (metadata.containsKey("title")) 253 mr.setTitle(metadata.get("title")); 254 if (metadata.containsKey("version")) 255 mr.setVersion(metadata.get("version")); 256 if (metadata.containsKey("status")) 257 mr.setStatus(PublicationStatus.fromCode(metadata.get("status"))); 258 if (metadata.containsKey("date")) 259 mr.setDateElement(new DateTimeType(metadata.get("date"))); 260 if (metadata.containsKey("publisher")) 261 mr.setPublisher(metadata.get("publisher")); 262 if (metadata.containsKey("description")) 263 mr.setDescription(metadata.get("description")); 264 } 265 266 public StructureMap getStructureMap() throws FHIRException { 267 StructureMap map = new StructureMap(); 268 loadMetadata(map); 269 if (metadata.containsKey("copyright")) 270 map.setCopyright(metadata.get("copyright")); 271 StructureMapGroupComponent grp = map.addGroup(); 272 grp.setTypeMode(StructureMapGroupTypeMode.NONE); 273 for (MappingRow row : rows) { 274 StructureMapGroupRuleComponent rule = grp.addRule(); 275 rule.setName(row.getSequence()); 276 StructureMapGroupRuleSourceComponent src = rule.getSourceFirstRep(); 277 src.setContext("src"); 278 src.setElement(row.getIdentifier()); 279 src.setMin(row.getCardinalityMin()); 280 src.setMax(row.getCardinalityMax()); 281 src.setType(row.getDataType()); 282 src.addExtension(ToolingExtensions.EXT_MAPPING_NAME, new StringType(row.getName())); 283 if (row.getCondition() != null) { 284 src.setCheck(processCondition(row.getCondition())); 285 } 286 StructureMapGroupRuleTargetComponent tgt = rule.getTargetFirstRep(); 287 tgt.setContext("tgt"); 288 tgt.setContextType(StructureMapContextType.VARIABLE); 289 tgt.setElement(row.getAttribute()); 290 tgt.addExtension(ToolingExtensions.EXT_MAPPING_TGTTYPE, new StringType(row.getType())); 291 tgt.addExtension(ToolingExtensions.EXT_MAPPING_TGTCARD, new StringType(row.getMinMax())); 292 if (row.getDtMapping() != null) { 293 src.setVariable("s"); 294 tgt.setVariable("t"); 295 tgt.setTransform(StructureMapTransform.CREATE); 296 StructureMapGroupRuleDependentComponent dep = rule.addDependent(); 297 dep.setName(row.getDtMapping()); 298 dep.addVariable("s"); 299 dep.addVariable("t"); 300 } else if (row.getVocabMapping() != null) { 301 tgt.setTransform(StructureMapTransform.TRANSLATE); 302 tgt.addParameter().setValue(new StringType(row.getVocabMapping())); 303 tgt.addParameter().setValue(new IdType("src")); 304 } else { 305 tgt.setTransform(StructureMapTransform.COPY); 306 } 307 rule.setDocumentation(row.getComments()); 308 if (row.getDerived() != null) { 309 tgt = rule.addTarget(); 310 tgt.setContext("tgt"); 311 tgt.setContextType(StructureMapContextType.VARIABLE); 312 tgt.setElement(row.getDerived()); 313 tgt.setTransform(StructureMapTransform.COPY); 314 tgt.addParameter().setValue(new StringType(row.getDerivedMapping())); 315 } 316 } 317 return map; 318 } 319 320 public boolean isSheet(ConceptMap cm) { 321 if (cm.getGroup().size() != 1) 322 return false; 323 ConceptMapGroupComponent grp = cm.getGroupFirstRep(); 324 for (SourceElementComponent e : grp.getElement()) { 325 if (!e.hasExtension(ToolingExtensions.EXT_MAPPING_TYPE)) 326 return false; 327 } 328 return true; 329 } 330 331 public String genSheet(ConceptMap cm) throws FHIRException { 332 StringBuilder b = new StringBuilder(); 333 readConceptMap(cm); 334 b.append("<table class=\"grid\">\r\n"); 335 addHeaderRow1(b); 336 addHeaderRow2(b); 337 for (MappingRow row : rows) 338 addRow(b, row); 339 b.append("</table>\r\n"); 340 return b.toString(); 341 } 342 343 private void addRow(StringBuilder b, MappingRow row) { 344 b.append(" <tr>"); 345 b.append("<td>"+Utilities.escapeXml(nn(row.sequence))+"</td>"); 346 b.append("<td>"+Utilities.escapeXml(nn(row.identifier))+"</td>"); 347 b.append("<td>"+Utilities.escapeXml(nn(row.name))+"</td>"); 348 b.append("<td>"+Utilities.escapeXml(nn(row.dataType))+"</td>"); 349 b.append("<td>"+Utilities.escapeXml(nn(row.cardinality))+"</td>"); 350 b.append("<td>"+Utilities.escapeXml(nn(row.condition))+"</td>"); 351 b.append("<td>"+Utilities.escapeXml(nn(row.attribute))+"</td>"); 352 b.append("<td>"+Utilities.escapeXml(nn(row.type))+"</td>"); 353 b.append("<td>"+Utilities.escapeXml(nn(row.minMax))+"</td>"); 354 b.append("<td>"+Utilities.escapeXml(nn(row.dtMapping))+"</td>"); 355 b.append("<td>"+Utilities.escapeXml(nn(row.vocabMapping))+"</td>"); 356 if (row.derived != null) 357 b.append("<td>"+Utilities.escapeXml(nn(row.derived+"="+row.derivedMapping))+"</td>"); 358 else 359 b.append("<td></td>"); 360 b.append("<td>"+Utilities.escapeXml(nn(row.comments))+"</td>"); 361 b.append("</tr>\r\n"); 362 363 } 364 365 private String nn(String s) { 366 return s == null ? "" : s; 367 } 368 369 private void addHeaderRow1(StringBuilder b) { 370 b.append(" <tr>"); 371 b.append("<td colspan=\"5\" style=\"background-color: lightgreen\"><b>v2</b></td>"); 372 b.append("<td colspan=\"1\"><b>Condition</b></td>"); 373 b.append("<td colspan=\"6\" style=\"background-color: orange\"><b>FHIR</b></td>"); 374 b.append("<td colspan=\"1\"><b>Comments</b></td>"); 375 b.append("</tr>\r\n"); 376 } 377 378 private void addHeaderRow2(StringBuilder b) { 379 b.append(" <tr>"); 380 b.append("<td style=\"background-color: lightgreen\"><b>Display Sequence</b></td>"); 381 b.append("<td style=\"background-color: lightgreen\"><b>Identifier</b></td>"); 382 b.append("<td style=\"background-color: lightgreen\"><b>Name</b></td>"); 383 b.append("<td style=\"background-color: lightgreen\"><b>Data Type</b></td>"); 384 b.append("<td style=\"background-color: lightgreen\"><b>Cardinality</b></td>"); 385 b.append("<td><b></b></td>"); 386 b.append("<td style=\"background-color: orange\"><b>FHIR Attribute</b></td>"); 387 b.append("<td style=\"background-color: orange\"><b>Data Type</b></td>"); 388 b.append("<td style=\"background-color: orange\"><b>Cardinality</b></td>"); 389 b.append("<td style=\"background-color: orange\"><b>Data Type Mapping</b></td>"); 390 b.append("<td style=\"background-color: orange\"><b>Vocabulary Mapping</b></td>"); 391 b.append("<td style=\"background-color: orange\"><b>Derived Mapping</b></td>"); 392 b.append("<td><b></b></td>"); 393 b.append("</tr>\r\n"); 394 } 395 396 private void readConceptMap(ConceptMap cm) throws FHIRException { 397 for (ConceptMapGroupComponent g : cm.getGroup()) { 398 for (SourceElementComponent e : g.getElement()) { 399 if (e.hasId() && e.getTarget().size() == 1 && e.hasExtension(ToolingExtensions.EXT_MAPPING_TYPE)) { 400 TargetElementComponent t = e.getTargetFirstRep(); 401 MappingRow row = new MappingRow(); 402 row.sequence = e.getId(); 403 row.identifier = e.getCode(); 404 row.name = e.getExtensionString(ToolingExtensions.EXT_MAPPING_NAME); 405 row.dataType = e.getExtensionString(ToolingExtensions.EXT_MAPPING_TYPE); 406 row.cardinality = e.getExtensionString(ToolingExtensions.EXT_MAPPING_CARD); 407 if (e.getNoMap() == true) { 408 row.attribute = "N/A"; 409 } else { 410 OtherElementComponent dep = getDependency(t, "http://hl7.org/fhirpath"); 411 if (dep != null) 412 row.condition = dep.getValue(); 413 row.attribute = t.getCode(); 414 row.type = t.getExtensionString(ToolingExtensions.EXT_MAPPING_TGTTYPE); 415 row.minMax = t.getExtensionString(ToolingExtensions.EXT_MAPPING_TGTCARD); 416 row.dtMapping = t.getExtensionString("http://hl7.org/fhir/StructureDefinition/ConceptMap-type-mapping"); 417 row.vocabMapping = t.getExtensionString("http://hl7.org/fhir/StructureDefinition/ConceptMap-vocab-mapping"); 418 if (t.getProduct().size() > 0) { 419 row.derived = t.getProductFirstRep().getProperty(); 420 row.derivedMapping = t.getProductFirstRep().getValue(); 421 } 422 } 423 row.comments = t.getComment(); 424 rows.add(row); 425 } 426 } 427 } 428 } 429 430 431 private OtherElementComponent getDependency(TargetElementComponent t, String prop) { 432 for (OtherElementComponent dep : t.getDependsOn()) { 433 if (prop.equals(dep.getProperty())) 434 return dep; 435 } 436 return null; 437 } 438 439 private static final String PFX = "<html><link rel=\"stylesheet\" href=\"file:c:\\work\\org.hl7.fhir\\build\\publish\\fhir.css\"/></head><body>\r\n"; 440 private static final String SFX = "<body></html>"; 441 public static void main(String[] args) throws FileNotFoundException, IOException, FHIRException { 442 MappingSheetParser parser = new MappingSheetParser(); 443 parser.parse(new FileInputStream("c:\\temp\\v2-pid.csv"), "v2-pid.csv"); 444 ConceptMap cm = parser.getConceptMap(); 445 StructureMap sm = parser.getStructureMap(); 446 new JsonParser().setOutputStyle(OutputStyle.PRETTY).compose(new FileOutputStream("c:\\temp\\sm.json"), sm); 447 new JsonParser().setOutputStyle(OutputStyle.PRETTY).compose(new FileOutputStream("c:\\temp\\cm.json"), cm); 448 TextFile.stringToFile(StructureMapUtilities.render(sm), "c:\\temp\\sm.txt"); 449 TextFile.stringToFile(PFX+parser.genSheet(cm)+SFX, "c:\\temp\\map.html"); 450 } 451 452}