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
023
024/*
025Copyright (c) 2011+, HL7, Inc
026All rights reserved.
027
028Redistribution and use in source and binary forms, with or without modification, 
029are permitted provided that the following conditions are met:
030
031 * Redistributions of source code must retain the above copyright notice, this 
032   list of conditions and the following disclaimer.
033 * Redistributions in binary form must reproduce the above copyright notice, 
034   this list of conditions and the following disclaimer in the documentation 
035   and/or other materials provided with the distribution.
036 * Neither the name of HL7 nor the names of its contributors may be used to 
037   endorse or promote products derived from this software without specific 
038   prior written permission.
039
040THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
041ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
042WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
043IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
044INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
045NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
046PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
047WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
048ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
049POSSIBILITY OF SUCH DAMAGE.
050
051 */
052
053import java.util.ArrayList;
054import java.util.HashMap;
055import java.util.Iterator;
056import java.util.List;
057import java.util.Map;
058
059import org.apache.commons.lang3.StringUtils;
060import org.fhir.ucum.Utilities;
061import org.hl7.fhir.exceptions.FHIRException;
062import org.hl7.fhir.r5.model.BooleanType;
063import org.hl7.fhir.r5.model.CanonicalType;
064import org.hl7.fhir.r5.model.CodeSystem.ConceptDefinitionComponent;
065import org.hl7.fhir.r5.model.CodeType;
066import org.hl7.fhir.r5.model.CodeableConcept;
067import org.hl7.fhir.r5.model.Coding;
068import org.hl7.fhir.r5.model.DomainResource;
069import org.hl7.fhir.r5.model.Element;
070import org.hl7.fhir.r5.model.ElementDefinition;
071import org.hl7.fhir.r5.model.Extension;
072import org.hl7.fhir.r5.model.ExtensionHelper;
073import org.hl7.fhir.r5.model.Factory;
074import org.hl7.fhir.r5.model.Identifier;
075import org.hl7.fhir.r5.model.IntegerType;
076import org.hl7.fhir.r5.model.MarkdownType;
077import org.hl7.fhir.r5.model.OperationOutcome.OperationOutcomeIssueComponent;
078import org.hl7.fhir.r5.model.PrimitiveType;
079import org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemComponent;
080import org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemType;
081import org.hl7.fhir.r5.model.StringType;
082import org.hl7.fhir.r5.model.DataType;
083import org.hl7.fhir.r5.model.UriType;
084import org.hl7.fhir.r5.model.UrlType;
085import org.hl7.fhir.r5.model.ValueSet.ConceptReferenceComponent;
086import org.hl7.fhir.r5.model.ValueSet.ConceptSetComponent;
087import org.hl7.fhir.utilities.StandardsStatus;
088import org.hl7.fhir.utilities.validation.ValidationMessage;
089import org.hl7.fhir.utilities.validation.ValidationMessage.IssueSeverity;
090import org.hl7.fhir.utilities.validation.ValidationMessage.IssueType;
091import org.hl7.fhir.utilities.validation.ValidationMessage.Source;
092
093
094public class ToolingExtensions {
095
096  // validated
097//  private static final String EXT_OID = "http://hl7.org/fhir/StructureDefinition/valueset-oid";
098//  public static final String EXT_DEPRECATED = "http://hl7.org/fhir/StructureDefinition/codesystem-deprecated";
099  public static final String EXT_DEFINITION = "http://hl7.org/fhir/StructureDefinition/valueset-concept-definition";
100  public static final String EXT_CS_COMMENT = "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments";
101  public static final String EXT_VS_COMMENT = "http://hl7.org/fhir/StructureDefinition/valueset-concept-comments";
102  private static final String EXT_IDENTIFIER = "http://hl7.org/fhir/StructureDefinition/identifier";
103  public static final String EXT_TRANSLATION = "http://hl7.org/fhir/StructureDefinition/translation";
104  public static final String EXT_ISSUE_SOURCE = "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source";
105  public static final String EXT_ISSUE_LINE = "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-line";
106  public static final String EXT_ISSUE_COL = "http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-col";
107  public static final String EXT_DISPLAY_HINT = "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint"; 
108  public static final String EXT_REPLACED_BY = "http://hl7.org/fhir/StructureDefinition/valueset-replacedby";
109  public static final String EXT_REGEX = "http://hl7.org/fhir/StructureDefinition/regex"; 
110  public static final String EXT_CONTROL = "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"; 
111  public static final String EXT_MINOCCURS = "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"; 
112  public static final String EXT_MAXOCCURS = "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs";
113  public static final String EXT_ALLOWEDRESOURCE = "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource";
114  public static final String EXT_REFERENCEFILTER = "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter";
115  public static final String EXT_CODE_GENERATION_PARENT = "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super";
116  public static final String EXT_HIERARCHY = "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy";
117  public static final String EXT_BEST_PRACTICE = "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice";
118  public static final String EXT_BEST_PRACTICE_EXPLANATION = "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation";
119  // unregistered?
120  public static final String EXT_MAPPING_PREFIX = "http://hl7.org/fhir/tools/StructureDefinition/logical-mapping-prefix";
121  public static final String EXT_MAPPING_SUFFIX = "http://hl7.org/fhir/tools/StructureDefinition/logical-mapping-suffix";
122
123//  public static final String EXT_FLYOVER = "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover";
124  public static final String EXT_QTYPE = "http://hl7.org/fhir/StructureDefinition/questionnnaire-baseType";
125//  private static final String EXT_QREF = "http://www.healthintersections.com.au/fhir/Profile/metadata#reference";
126//  private static final String EXTENSION_FILTER_ONLY = "http://www.healthintersections.com.au/fhir/Profile/metadata#expandNeedsFilter";
127//  private static final String EXT_TYPE = "http://www.healthintersections.com.au/fhir/Profile/metadata#type";
128//  private static final String EXT_REFERENCE = "http://www.healthintersections.com.au/fhir/Profile/metadata#reference";
129  private static final String EXT_FHIRTYPE = "http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType";
130  private static final String EXT_ALLOWABLE_UNITS = "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits";
131  public static final String EXT_CIMI_REFERENCE = "http://hl7.org/fhir/StructureDefinition/cimi-reference";
132  public static final String EXT_UNCLOSED = "http://hl7.org/fhir/StructureDefinition/valueset-unclosed";
133  public static final String EXT_FMM_LEVEL = "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm";
134  public static final String EXT_SEC_CAT = "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category";
135  public static final String EXT_RESOURCE_CATEGORY = "http://hl7.org/fhir/StructureDefinition/structuredefinition-category";
136  public static final String EXT_RESOURCE_INTERFACE = "http://hl7.org/fhir/StructureDefinition/structuredefinition-interface";
137  public static final String EXT_TABLE_NAME = "http://hl7.org/fhir/StructureDefinition/structuredefinition-table-name";
138  public static final String EXT_OO_FILE = "http://hl7.org/fhir/StructureDefinition/operationoutcome-file";
139  public static final String EXT_WORKGROUP = "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg";
140  public static final String EXT_STANDARDS_STATUS = "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status";
141  public static final String EXT_NORMATIVE_VERSION = "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version";
142  public static final String EXT_IGP_BASE = "http://hl7.org/fhir/StructureDefinition/igpublisher-res-base";
143  public static final String EXT_IGP_DEFNS = "http://hl7.org/fhir/StructureDefinition/igpublisher-res-defns";
144  public static final String EXT_IGP_FORMAT = "http://hl7.org/fhir/StructureDefinition/igpublisher-res-format";
145  public static final String EXT_IGP_SOURCE = "http://hl7.org/fhir/StructureDefinition/igpublisher-res-source";
146  public static final String EXT_IGP_VERSION = "http://hl7.org/fhir/StructureDefinition/igpublisher-res-version";
147  public static final String EXT_IGP_RESOURCES = "http://hl7.org/fhir/StructureDefinition/igpublisher-folder-resource";
148  public static final String EXT_IGP_PAGES = "http://hl7.org/fhir/StructureDefinition/igpublisher-folder-pages";
149  public static final String EXT_IGP_SPREADSHEET = "http://hl7.org/fhir/StructureDefinition/igpublisher-spreadsheet";
150  public static final String EXT_IGP_MAPPING_CSV = "http://hl7.org/fhir/StructureDefinition/igpublisher-mapping-csv";
151  public static final String EXT_IGP_BUNDLE = "http://hl7.org/fhir/StructureDefinition/igpublisher-bundle";
152  public static final String EXT_IGP_RESOURCE_INFO = "http://hl7.org/fhir/tools/StructureDefinition/resource-information";
153  public static final String EXT_IGP_LOADVERSION = "http://hl7.org/fhir/StructureDefinition/igpublisher-loadversion";
154  public static final String EXT_MAX_VALUESET = "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet";
155  public static final String EXT_MIN_VALUESET = "http://hl7.org/fhir/StructureDefinition/elementdefinition-minValueSet";
156  public static final String EXT_PROFILE_ELEMENT = "http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element";
157  public static final String EXT_LIST_PACKAGE = "http://hl7.org/fhir/StructureDefinition/list-packageId";
158  public static final String EXT_MAPPING_NAME = "http://hl7.org/fhir/tools/StructureDefinition/conceptmap-source-name";
159  public static final String EXT_MAPPING_TYPE = "http://hl7.org/fhir/tools/StructureDefinition/conceptmap-source-type";
160  public static final String EXT_MAPPING_CARD = "http://hl7.org/fhir/tools/StructureDefinition/conceptmap-source-cardinality";
161  public static final String EXT_MAPPING_TGTTYPE = "http://hl7.org/fhir/tools/StructureDefinition/conceptmap-target-type";
162  public static final String EXT_MAPPING_TGTCARD = "http://hl7.org/fhir/tools/StructureDefinition/conceptmap-target-cardinality";
163  public static final String EXT_PRIVATE_BASE = "http://hl7.org/fhir/tools/";
164  public static final String EXT_ALLOWED_TYPE =  "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type";
165  public static final String EXT_FHIR_TYPE = "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type";
166  public static final String EXT_XML_TYPE = "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type";
167  public static final String EXT_RENDERED_VALUE = "http://hl7.org/fhir/StructureDefinition/rendered-value";
168
169  // specific extension helpers
170
171  public static Extension makeIssueSource(Source source) {
172    Extension ex = new Extension();
173    // todo: write this up and get it published with the pack (and handle the redirect?)
174    ex.setUrl(ToolingExtensions.EXT_ISSUE_SOURCE);
175    CodeType c = new CodeType();
176    c.setValue(source.toString());
177    ex.setValue(c);
178    return ex;
179  }
180
181  public static boolean hasExtension(DomainResource de, String url) {
182    return getExtension(de, url) != null;
183  }
184
185  public static boolean hasExtension(Element e, String url) {
186    return getExtension(e, url) != null;
187  }
188
189//  public static void addStringExtension(DomainResource dr, String url, String content) {
190//    if (!StringUtils.isBlank(content)) {
191//      Extension ex = getExtension(dr, url);
192//      if (ex != null)
193//        ex.setValue(new StringType(content));
194//      else
195//        dr.getExtension().add(Factory.newExtension(url, new StringType(content), true));   
196//    }
197//  }
198
199  public static void addMarkdownExtension(DomainResource dr, String url, String content) {
200    if (!StringUtils.isBlank(content)) {
201      Extension ex = getExtension(dr, url);
202      if (ex != null)
203        ex.setValue(new StringType(content));
204      else
205        dr.getExtension().add(Factory.newExtension(url, new MarkdownType(content), true));   
206    }
207  }
208
209  public static void addStringExtension(Element e, String url, String content) {
210    if (!StringUtils.isBlank(content)) {
211      Extension ex = getExtension(e, url);
212      if (ex != null)
213        ex.setValue(new StringType(content));
214      else
215        e.getExtension().add(Factory.newExtension(url, new StringType(content), true));   
216    }
217  }
218
219  public static void addCodeExtension(Element e, String url, String content) {
220    if (!StringUtils.isBlank(content)) {
221      Extension ex = getExtension(e, url);
222      if (ex != null)
223        ex.setValue(new CodeType(content));
224      else
225        e.getExtension().add(Factory.newExtension(url, new CodeType(content), true));   
226    }
227  }
228
229  public static void addStringExtension(DomainResource e, String url, String content) {
230    if (!StringUtils.isBlank(content)) {
231      Extension ex = getExtension(e, url);
232      if (ex != null)
233        ex.setValue(new StringType(content));
234      else
235        e.getExtension().add(Factory.newExtension(url, new StringType(content), true));   
236    }
237  }
238
239
240  public static void addBooleanExtension(Element e, String url, boolean content) {
241    Extension ex = getExtension(e, url);
242    if (ex != null)
243      ex.setValue(new BooleanType(content));
244    else
245      e.getExtension().add(Factory.newExtension(url, new BooleanType(content), true));   
246  }
247
248  public static void addBooleanExtension(DomainResource e, String url, boolean content) {
249    Extension ex = getExtension(e, url);
250    if (ex != null)
251      ex.setValue(new BooleanType(content));
252    else
253      e.getExtension().add(Factory.newExtension(url, new BooleanType(content), true));   
254  }
255
256  public static void addIntegerExtension(DomainResource dr, String url, int value) {
257    Extension ex = getExtension(dr, url);
258    if (ex != null)
259      ex.setValue(new IntegerType(value));
260    else
261      dr.getExtension().add(Factory.newExtension(url, new IntegerType(value), true));   
262  }
263
264  public static void addCodeExtension(DomainResource dr, String url, String value) {
265    Extension ex = getExtension(dr, url);
266    if (ex != null)
267      ex.setValue(new CodeType(value));
268    else
269      dr.getExtension().add(Factory.newExtension(url, new CodeType(value), true));   
270  }
271
272  public static void addVSComment(ConceptSetComponent nc, String comment) {
273    if (!StringUtils.isBlank(comment))
274      nc.getExtension().add(Factory.newExtension(EXT_VS_COMMENT, Factory.newString_(comment), true));   
275  }
276  public static void addVSComment(ConceptReferenceComponent nc, String comment) {
277    if (!StringUtils.isBlank(comment))
278      nc.getExtension().add(Factory.newExtension(EXT_VS_COMMENT, Factory.newString_(comment), true));   
279  }
280
281  public static void addCSComment(ConceptDefinitionComponent nc, String comment) {
282    if (!StringUtils.isBlank(comment))
283      nc.getExtension().add(Factory.newExtension(EXT_CS_COMMENT, Factory.newString_(comment), true));   
284  }
285
286//  public static void markDeprecated(Element nc) {
287//    setDeprecated(nc);   
288//  }
289//
290
291  public static void addDefinition(Element nc, String definition) {
292    if (!StringUtils.isBlank(definition))
293      nc.getExtension().add(Factory.newExtension(EXT_DEFINITION, Factory.newString_(definition), true));   
294  }
295
296  public static void addDisplayHint(Element def, String hint) {
297    if (!StringUtils.isBlank(hint))
298      def.getExtension().add(Factory.newExtension(EXT_DISPLAY_HINT, Factory.newString_(hint), true));   
299  }
300
301  public static String getDisplayHint(Element def) {
302    return readStringExtension(def, EXT_DISPLAY_HINT);    
303  }
304
305  public static String readStringExtension(Element c, String uri) {
306    Extension ex = ExtensionHelper.getExtension(c, uri);
307    if (ex == null)
308      return null;
309    if (ex.getValue() instanceof UriType)
310      return ((UriType) ex.getValue()).getValue();
311    if (ex.getValue() instanceof CanonicalType)
312      return ((CanonicalType) ex.getValue()).getValue();
313    if (ex.getValue() instanceof CodeType)
314      return ((CodeType) ex.getValue()).getValue();
315    if (ex.getValue() instanceof IntegerType)
316      return ((IntegerType) ex.getValue()).asStringValue();
317    if ((ex.getValue() instanceof MarkdownType))
318      return ((MarkdownType) ex.getValue()).getValue();
319    if (!(ex.getValue() instanceof StringType))
320      return null;
321    return ((StringType) ex.getValue()).getValue();
322  }
323
324  public static String readStringExtension(DomainResource c, String uri) {
325    Extension ex = getExtension(c, uri);
326    if (ex == null)
327      return null;
328    if ((ex.getValue() instanceof StringType))
329      return ((StringType) ex.getValue()).getValue();
330    if ((ex.getValue() instanceof UriType))
331      return ((UriType) ex.getValue()).getValue();
332    if (ex.getValue() instanceof CodeType)
333      return ((CodeType) ex.getValue()).getValue();
334    if (ex.getValue() instanceof IntegerType)
335      return ((IntegerType) ex.getValue()).asStringValue();
336    if ((ex.getValue() instanceof MarkdownType))
337      return ((MarkdownType) ex.getValue()).getValue();
338    return null;
339  }
340
341  @SuppressWarnings("unchecked")
342  public static PrimitiveType<DataType> readPrimitiveExtension(DomainResource c, String uri) {
343    Extension ex = getExtension(c, uri);
344    if (ex == null)
345      return null;
346    return (PrimitiveType<DataType>) ex.getValue();
347  }
348
349  public static boolean findStringExtension(Element c, String uri) {
350    Extension ex = ExtensionHelper.getExtension(c, uri);
351    if (ex == null)
352      return false;
353    if (!(ex.getValue() instanceof StringType))
354      return false;
355    return !StringUtils.isBlank(((StringType) ex.getValue()).getValue());
356  }
357
358  public static Boolean readBooleanExtension(Element c, String uri) {
359    Extension ex = ExtensionHelper.getExtension(c, uri);
360    if (ex == null)
361      return null;
362    if (!(ex.getValue() instanceof BooleanType))
363      return null;
364    return ((BooleanType) ex.getValue()).getValue();
365  }
366
367  public static boolean findBooleanExtension(Element c, String uri) {
368    Extension ex = ExtensionHelper.getExtension(c, uri);
369    if (ex == null)
370      return false;
371    if (!(ex.getValue() instanceof BooleanType))
372      return false;
373    return true;
374  }
375
376  public static Boolean readBooleanExtension(DomainResource c, String uri) {
377    Extension ex = ExtensionHelper.getExtension(c, uri);
378    if (ex == null)
379      return null;
380    if (!(ex.getValue() instanceof BooleanType))
381      return null;
382    return ((BooleanType) ex.getValue()).getValue();
383  }
384
385  public static boolean readBoolExtension(DomainResource c, String uri) {
386    Extension ex = ExtensionHelper.getExtension(c, uri);
387    if (ex == null)
388      return false;
389    if (!(ex.getValue() instanceof BooleanType))
390      return false;
391    return ((BooleanType) ex.getValue()).getValue();
392  }
393
394  public static boolean findBooleanExtension(DomainResource c, String uri) {
395    Extension ex = ExtensionHelper.getExtension(c, uri);
396    if (ex == null)
397      return false;
398    if (!(ex.getValue() instanceof BooleanType))
399      return false;
400    return true;
401  }
402
403  public static String getCSComment(ConceptDefinitionComponent c) {
404    return readStringExtension(c, EXT_CS_COMMENT);    
405  }
406//
407//  public static Boolean getDeprecated(Element c) {
408//    return readBooleanExtension(c, EXT_DEPRECATED);    
409//  }
410
411  public static boolean hasCSComment(ConceptDefinitionComponent c) {
412    return findStringExtension(c, EXT_CS_COMMENT);    
413  }
414
415//  public static boolean hasDeprecated(Element c) {
416//    return findBooleanExtension(c, EXT_DEPRECATED);    
417//  }
418
419  public static void addFlyOver(QuestionnaireItemComponent item, String text){
420    if (!StringUtils.isBlank(text)) {
421        QuestionnaireItemComponent display = item.addItem();
422        display.setType(QuestionnaireItemType.DISPLAY);
423        display.setText(text);
424        display.getExtension().add(Factory.newExtension(EXT_CONTROL, Factory.newCodeableConcept("flyover", "http://hl7.org/fhir/questionnaire-item-control", "Fly-over"), true));
425    }
426  }
427
428  public static void addMin(QuestionnaireItemComponent item, int min) {
429    item.getExtension().add(Factory.newExtension(EXT_MINOCCURS, Factory.newInteger(min), true));
430  }
431  
432  public static void addMax(QuestionnaireItemComponent item, int max) {
433    item.getExtension().add(Factory.newExtension(EXT_MAXOCCURS, Factory.newInteger(max), true));
434  }
435  
436  public static void addFhirType(QuestionnaireItemComponent group, String value) {
437    group.getExtension().add(Factory.newExtension(EXT_FHIRTYPE, Factory.newString_(value), true));       
438  }
439
440  public static void addControl(QuestionnaireItemComponent group, String value) {
441    group.getExtension().add(Factory.newExtension(EXT_CONTROL, Factory.newCodeableConcept(value, "http://hl7.org/fhir/questionnaire-item-control", value), true));
442  }
443
444  public static void addAllowedResource(QuestionnaireItemComponent group, String value) {
445    group.getExtension().add(Factory.newExtension(EXT_ALLOWEDRESOURCE, Factory.newCode(value), true));       
446  }
447
448  public static void addReferenceFilter(QuestionnaireItemComponent group, String value) {
449    group.getExtension().add(Factory.newExtension(EXT_REFERENCEFILTER, Factory.newString_(value), true));       
450  }
451
452  public static void addIdentifier(Element element, Identifier value) {
453    element.getExtension().add(Factory.newExtension(EXT_IDENTIFIER, value, true));       
454  }
455
456  /**
457   * @param name the identity of the extension of interest
458   * @return The extension, if on this element, else null
459   */
460  public static Extension getExtension(DomainResource resource, String name) {
461    if (name == null)
462      return null;
463    if (!resource.hasExtension())
464      return null;
465    for (Extension e : resource.getExtension()) {
466      if (name.equals(e.getUrl()))
467        return e;
468    }
469    return null;
470  }
471
472  public static Extension getExtension(Element el, String name) {
473    if (name == null)
474      return null;
475    if (!el.hasExtension())
476      return null;
477    for (Extension e : el.getExtension()) {
478      if (name.equals(e.getUrl()))
479        return e;
480    }
481    return null;
482  }
483
484  public static void setStringExtension(DomainResource resource, String uri, String value) {
485    if (Utilities.noString(value))
486      return;
487        Extension ext = getExtension(resource, uri);
488    if (ext != null)
489      ext.setValue(new StringType(value));
490    else
491      resource.getExtension().add(new Extension(uri).setValue(new StringType(value)));
492  }
493
494  public static void setStringExtension(Element resource, String uri, String value) {
495    if (Utilities.noString(value))
496      return;
497        Extension ext = getExtension(resource, uri);
498    if (ext != null)
499      ext.setValue(new StringType(value));
500    else
501      resource.getExtension().add(new Extension(uri).setValue(new StringType(value)));
502  }
503
504  public static void setCodeExtension(DomainResource resource, String uri, String value) {
505    if (Utilities.noString(value))
506      return;
507    
508    Extension ext = getExtension(resource, uri);
509    if (ext != null)
510      ext.setValue(new CodeType(value));
511    else
512      resource.getExtension().add(new Extension(uri).setValue(new CodeType(value)));
513  }
514
515  public static void setCodeExtension(Element element, String uri, String value) {
516    if (Utilities.noString(value))
517      return;
518    
519    Extension ext = getExtension(element, uri);
520    if (ext != null)
521      ext.setValue(new CodeType(value));
522    else
523      element.getExtension().add(new Extension(uri).setValue(new CodeType(value)));
524  }
525
526  public static void setIntegerExtension(DomainResource resource, String uri, int value) {
527    Extension ext = getExtension(resource, uri);
528    if (ext != null)
529      ext.setValue(new IntegerType(value));
530    else
531      resource.getExtension().add(new Extension(uri).setValue(new IntegerType(value)));
532  }
533
534//  public static String getOID(CodeSystem define) {
535//    return readStringExtension(define, EXT_OID);    
536//  }
537//
538//  public static String getOID(ValueSet vs) {
539//    return readStringExtension(vs, EXT_OID);    
540//  }
541//
542//  public static void setOID(CodeSystem define, String oid) throws FHIRFormatError, URISyntaxException {
543//    if (!oid.startsWith("urn:oid:"))
544//      throw new FHIRFormatError("Error in OID format");
545//    if (oid.startsWith("urn:oid:urn:oid:"))
546//      throw new FHIRFormatError("Error in OID format");
547//    if (!hasExtension(define, EXT_OID))
548//    define.getExtension().add(Factory.newExtension(EXT_OID, Factory.newUri(oid), false));       
549//    else if (!oid.equals(readStringExtension(define, EXT_OID)))
550//      throw new Error("Attempt to assign multiple OIDs to a code system");
551//  }
552//  public static void setOID(ValueSet vs, String oid) throws FHIRFormatError, URISyntaxException {
553//    if (!oid.startsWith("urn:oid:"))
554//      throw new FHIRFormatError("Error in OID format");
555//    if (oid.startsWith("urn:oid:urn:oid:"))
556//      throw new FHIRFormatError("Error in OID format");
557//    if (!hasExtension(vs, EXT_OID))
558//    vs.getExtension().add(Factory.newExtension(EXT_OID, Factory.newUri(oid), false));       
559//    else if (!oid.equals(readStringExtension(vs, EXT_OID)))
560//      throw new Error("Attempt to assign multiple OIDs to value set "+vs.getName()+" ("+vs.getUrl()+"). Has "+readStringExtension(vs, EXT_OID)+", trying to add "+oid);
561//  }
562
563  public static boolean hasLanguageTranslation(Element element, String lang) {
564    for (Extension e : element.getExtension()) {
565      if (e.getUrl().equals(EXT_TRANSLATION)) {
566        Extension e1 = ExtensionHelper.getExtension(e, "lang");
567
568        if (e1 != null && e1.getValue() instanceof CodeType && ((CodeType) e.getValue()).getValue().equals(lang))
569          return true;
570      }
571    }
572    return false;
573  }
574
575  public static String getLanguageTranslation(Element element, String lang) {
576    for (Extension e : element.getExtension()) {
577      if (e.getUrl().equals(EXT_TRANSLATION)) {
578        Extension e1 = ExtensionHelper.getExtension(e, "lang");
579
580        if (e1 != null && e1.getValue() instanceof CodeType && ((CodeType) e.getValue()).getValue().equals(lang)) {
581          e1 = ExtensionHelper.getExtension(e, "content");
582          return ((StringType) e.getValue()).getValue();
583        }
584      }
585    }
586    return null;
587  }
588
589  public static void addLanguageTranslation(Element element, String lang, String value) {
590    if (Utilities.noString(lang) || Utilities.noString(value))
591      return;
592    
593    Extension extension = new Extension().setUrl(EXT_TRANSLATION);
594    extension.addExtension().setUrl("lang").setValue(new CodeType(lang));
595    extension.addExtension().setUrl("content").setValue(new StringType(value));
596    element.getExtension().add(extension);
597  }
598
599  public static DataType getAllowedUnits(ElementDefinition eld) {
600    for (Extension e : eld.getExtension()) 
601      if (e.getUrl().equals(EXT_ALLOWABLE_UNITS)) 
602        return e.getValue();
603    return null;
604  }
605
606  public static void setAllowableUnits(ElementDefinition eld, CodeableConcept cc) {
607    for (Extension e : eld.getExtension()) 
608      if (e.getUrl().equals(EXT_ALLOWABLE_UNITS)) {
609        e.setValue(cc);
610        return;
611      }
612    eld.getExtension().add(new Extension().setUrl(EXT_ALLOWABLE_UNITS).setValue(cc));
613  }
614
615  public static List<Extension> getExtensions(Element element, String url) {
616    List<Extension> results = new ArrayList<Extension>();
617    for (Extension ex : element.getExtension())
618      if (ex.getUrl().equals(url))
619        results.add(ex);
620    return results;
621  }
622
623  public static List<Extension> getExtensions(DomainResource resource, String url) {
624    List<Extension> results = new ArrayList<Extension>();
625    for (Extension ex : resource.getExtension())
626      if (ex.getUrl().equals(url))
627        results.add(ex);
628    return results;
629  }
630
631//  public static void addDEReference(DataElement de, String value) {
632//    for (Extension e : de.getExtension()) 
633//      if (e.getUrl().equals(EXT_CIMI_REFERENCE)) {
634//        e.setValue(new UriType(value));
635//        return;
636//      }
637//    de.getExtension().add(new Extension().setUrl(EXT_CIMI_REFERENCE).setValue(new UriType(value)));
638//  }
639
640//  public static void setDeprecated(Element nc) {
641//    for (Extension e : nc.getExtension()) 
642//      if (e.getUrl().equals(EXT_DEPRECATED)) {
643//        e.setValue(new BooleanType(true));
644//        return;
645//      }
646//    nc.getExtension().add(new Extension().setUrl(EXT_DEPRECATED).setValue(new BooleanType(true)));    
647//  }
648
649  public static void setExtension(Element focus, String url, Coding c) {
650    for (Extension e : focus.getExtension()) 
651      if (e.getUrl().equals(url)) {
652        e.setValue(c);
653        return;
654      }
655    focus.getExtension().add(new Extension().setUrl(url).setValue(c));    
656  }
657
658  public static void removeExtension(DomainResource focus, String url) {
659    Iterator<Extension> i = focus.getExtension().iterator();
660    while (i.hasNext()) {
661      Extension e = i.next(); // must be called before you can call i.remove()
662      if (e.getUrl().equals(url)) {
663        i.remove();
664      }
665    }
666  }
667  
668  public static void removeExtension(Element focus, String url) {
669    Iterator<Extension> i = focus.getExtension().iterator();
670    while (i.hasNext()) {
671      Extension e = i.next(); // must be called before you can call i.remove()
672      if (e.getUrl().equals(url)) {
673        i.remove();
674      }
675    }
676  }
677
678  public static int readIntegerExtension(DomainResource dr, String uri, int defaultValue) {
679    Extension ex = ExtensionHelper.getExtension(dr, uri);
680    if (ex == null)
681      return defaultValue;
682    if (ex.getValue() instanceof IntegerType)
683      return ((IntegerType) ex.getValue()).getValue();
684    throw new Error("Unable to read extension "+uri+" as an integer");
685  }
686
687  public static int readIntegerExtension(Element e, String uri, int defaultValue) {
688    Extension ex = ExtensionHelper.getExtension(e, uri);
689    if (ex == null)
690      return defaultValue;
691    if (ex.getValue() instanceof IntegerType)
692      return ((IntegerType) ex.getValue()).getValue();
693    throw new Error("Unable to read extension "+uri+" as an integer");
694  }
695
696  public static Map<String, String> getLanguageTranslations(Element e) {
697    Map<String, String> res = new HashMap<String, String>();
698    for (Extension ext : e.getExtension()) {
699      if (ext.getUrl().equals(EXT_TRANSLATION)) {
700        String lang = readStringExtension(ext, "lang");
701        String value = readStringExtension(ext, "content");
702        res.put(lang,  value);
703      }
704    }
705    return res;
706  }
707
708  public static StandardsStatus getStandardsStatus(DomainResource dr) throws FHIRException {
709    return StandardsStatus.fromCode(ToolingExtensions.readStringExtension(dr, ToolingExtensions.EXT_STANDARDS_STATUS));
710  }
711
712  public static void setStandardsStatus(DomainResource dr, StandardsStatus status, String normativeVersion) {
713    if (status == null)
714      ToolingExtensions.removeExtension(dr, ToolingExtensions.EXT_STANDARDS_STATUS);
715    else
716      ToolingExtensions.setCodeExtension(dr, ToolingExtensions.EXT_STANDARDS_STATUS, status.toCode());
717    if (normativeVersion == null)
718      ToolingExtensions.removeExtension(dr, ToolingExtensions.EXT_NORMATIVE_VERSION);
719    else
720      ToolingExtensions.setCodeExtension(dr, ToolingExtensions.EXT_NORMATIVE_VERSION, normativeVersion);
721  }
722
723  public static void setStandardsStatus(Element dr, StandardsStatus status, String normativeVersion) {
724    if (status == null)
725      ToolingExtensions.removeExtension(dr, ToolingExtensions.EXT_STANDARDS_STATUS);
726    else
727      ToolingExtensions.setCodeExtension(dr, ToolingExtensions.EXT_STANDARDS_STATUS, status.toCode());
728    if (normativeVersion == null)
729      ToolingExtensions.removeExtension(dr, ToolingExtensions.EXT_NORMATIVE_VERSION);
730    else
731      ToolingExtensions.setCodeExtension(dr, ToolingExtensions.EXT_NORMATIVE_VERSION, normativeVersion);
732  }
733
734  public static ValidationMessage readValidationMessage(OperationOutcomeIssueComponent issue, Source source) {
735    ValidationMessage vm = new ValidationMessage();
736    vm.setSource(source);
737    vm.setLevel(mapSeverity(issue.getSeverity()));
738    vm.setType(mapType(issue.getCode()));
739    if (issue.hasExtension(ToolingExtensions.EXT_ISSUE_LINE))
740      vm.setLine(ToolingExtensions.readIntegerExtension(issue, ToolingExtensions.EXT_ISSUE_LINE, 0));
741    if (issue.hasExtension(ToolingExtensions.EXT_ISSUE_COL))
742      vm.setCol(ToolingExtensions.readIntegerExtension(issue, ToolingExtensions.EXT_ISSUE_COL, 0));
743    if (issue.hasExpression())
744      vm.setLocation(issue.getExpression().get(0).asStringValue());
745    vm.setMessage(issue.getDetails().getText());
746    if (issue.hasExtension("http://hl7.org/fhir/StructureDefinition/rendering-xhtml"))
747      vm.setHtml(ToolingExtensions.readStringExtension(issue, "http://hl7.org/fhir/StructureDefinition/rendering-xhtml"));
748    return vm;
749  }
750
751  private static IssueType mapType(org.hl7.fhir.r5.model.OperationOutcome.IssueType code) {
752    switch (code) {
753    case BUSINESSRULE: return IssueType.BUSINESSRULE;
754    case CODEINVALID: return IssueType.CODEINVALID;
755    case CONFLICT: return IssueType.CONFLICT;
756    case DELETED: return IssueType.DELETED;
757    case DUPLICATE: return IssueType.DUPLICATE;
758    case EXCEPTION: return IssueType.EXCEPTION;
759    case EXPIRED: return IssueType.EXPIRED;
760    case EXTENSION: return IssueType.EXTENSION;
761    case FORBIDDEN: return IssueType.FORBIDDEN;
762    case INCOMPLETE: return IssueType.INCOMPLETE;
763    case INFORMATIONAL: return IssueType.INFORMATIONAL;
764    case INVALID: return IssueType.INVALID;
765    case INVARIANT: return IssueType.INVARIANT;
766    case LOCKERROR: return IssueType.LOCKERROR;
767    case LOGIN: return IssueType.LOGIN;
768    case MULTIPLEMATCHES: return IssueType.MULTIPLEMATCHES;
769    case NOSTORE: return IssueType.NOSTORE;
770    case NOTFOUND: return IssueType.NOTFOUND;
771    case NOTSUPPORTED: return IssueType.NOTSUPPORTED;
772    case NULL: return IssueType.NULL;
773    case PROCESSING: return IssueType.PROCESSING;
774    case REQUIRED: return IssueType.REQUIRED;
775    case SECURITY: return IssueType.SECURITY;
776    case STRUCTURE: return IssueType.STRUCTURE;
777    case SUPPRESSED: return IssueType.SUPPRESSED;
778    case THROTTLED: return IssueType.THROTTLED;
779    case TIMEOUT: return IssueType.TIMEOUT;
780    case TOOCOSTLY: return IssueType.TOOCOSTLY;
781    case TOOLONG: return IssueType.TOOLONG;
782    case TRANSIENT: return IssueType.TRANSIENT;
783    case UNKNOWN: return IssueType.UNKNOWN;
784    case VALUE: return IssueType.VALUE;
785    default: return null;
786    }
787  }
788
789  private static IssueSeverity mapSeverity(org.hl7.fhir.r5.model.OperationOutcome.IssueSeverity severity) {
790    switch (severity) {
791    case ERROR: return IssueSeverity.ERROR;
792    case FATAL: return IssueSeverity.FATAL;
793    case INFORMATION: return IssueSeverity.INFORMATION;
794    case WARNING: return IssueSeverity.WARNING;
795    default: return null;
796    }
797  }
798
799  public static String getPresentation(PrimitiveType<?> type) {
800    if (type.hasExtension(EXT_RENDERED_VALUE))
801      return readStringExtension(type, EXT_RENDERED_VALUE);
802    return type.primitiveValue();
803  }
804  
805  public static String getPresentation(Element holder, PrimitiveType<?> type) {
806    if (holder.hasExtension(EXT_RENDERED_VALUE))
807      return readStringExtension(holder, EXT_RENDERED_VALUE);
808    if (type.hasExtension(EXT_RENDERED_VALUE))
809      return readStringExtension(type, EXT_RENDERED_VALUE);
810    return type.primitiveValue();
811  }
812  
813//  public static boolean hasOID(ValueSet vs) {
814//    return hasExtension(vs, EXT_OID);
815//  }
816//  
817//  public static boolean hasOID(CodeSystem cs) {
818//    return hasExtension(cs, EXT_OID);
819//  }
820//  
821  public static void addUrlExtension(Element e, String url, String content) {
822    if (!StringUtils.isBlank(content)) {
823      Extension ex = getExtension(e, url);
824      if (ex != null)
825        ex.setValue(new UrlType(content));
826      else
827        e.getExtension().add(Factory.newExtension(url, new UrlType(content), true));   
828    }
829  }
830
831  public static void addUrlExtension(DomainResource dr, String url, String value) {
832    Extension ex = getExtension(dr, url);
833    if (ex != null)
834      ex.setValue(new UrlType(value));
835    else
836      dr.getExtension().add(Factory.newExtension(url, new UrlType(value), true));   
837  }
838
839  public static void addUriExtension(Element e, String url, String content) {
840    if (!StringUtils.isBlank(content)) {
841      Extension ex = getExtension(e, url);
842      if (ex != null)
843        ex.setValue(new UriType(content));
844      else
845        e.getExtension().add(Factory.newExtension(url, new UriType(content), true));   
846    }
847  }
848
849  public static void addUriExtension(DomainResource dr, String url, String value) {
850    Extension ex = getExtension(dr, url);
851    if (ex != null)
852      ex.setValue(new UriType(value));
853    else
854      dr.getExtension().add(Factory.newExtension(url, new UriType(value), true));   
855  }
856
857  
858}