Source code

001package org.hl7.fhir.dstu3.terminologies;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import java.util.List;
035
036import org.hl7.fhir.dstu3.model.BooleanType;
037import org.hl7.fhir.dstu3.model.CodeSystem;
038import org.hl7.fhir.dstu3.model.CodeSystem.ConceptDefinitionComponent;
039import org.hl7.fhir.dstu3.model.CodeSystem.ConceptPropertyComponent;
040import org.hl7.fhir.dstu3.model.CodeSystem.PropertyComponent;
041import org.hl7.fhir.dstu3.model.CodeSystem.PropertyType;
042import org.hl7.fhir.dstu3.model.DateTimeType;
043import org.hl7.fhir.dstu3.model.Identifier;
044import org.hl7.fhir.dstu3.model.Meta;
045import org.hl7.fhir.dstu3.model.UriType;
046import org.hl7.fhir.dstu3.utils.ToolingExtensions;
047import org.hl7.fhir.exceptions.FHIRException;
048import org.hl7.fhir.exceptions.FHIRFormatError;
049import org.hl7.fhir.utilities.Utilities;
050
051@Deprecated
052public class CodeSystemUtilities {
053
054  public static boolean isDeprecated(CodeSystem cs, ConceptDefinitionComponent def) {
055    for (ConceptPropertyComponent p : def.getProperty()) {
056      if (p.getCode().equals("deprecated") && p.hasValue() && p.getValue() instanceof BooleanType) 
057        return ((BooleanType) p.getValue()).getValue();
058      if (p.getCode().equals("deprecationDate") && p.hasValue() && p.getValue() instanceof DateTimeType) 
059        return ((DateTimeType) p.getValue()).before(new DateTimeType());
060    }
061    return false;
062  }
063
064  public static boolean isNotSelectable(CodeSystem cs, ConceptDefinitionComponent def) {
065    for (ConceptPropertyComponent p : def.getProperty()) {
066      if (p.getCode().equals("notSelectable") && p.hasValue() && p.getValue() instanceof BooleanType) 
067        return ((BooleanType) p.getValue()).getValue();
068    }
069    return false;
070  }
071
072  public static void setNotSelectable(CodeSystem cs, ConceptDefinitionComponent concept) throws FHIRFormatError {
073    defineNotSelectableProperty(cs);
074    concept.addProperty().setCode("notSelectable").setValue(new BooleanType(true));    
075  }
076
077  public static void setInactive(CodeSystem cs, ConceptDefinitionComponent concept) throws FHIRFormatError {
078    defineInactiveProperty(cs);
079    concept.addProperty().setCode("inactive").setValue(new BooleanType(true));    
080  }
081
082  public static void setDeprecated(CodeSystem cs, ConceptDefinitionComponent concept, DateTimeType date) throws FHIRFormatError {
083    defineDeprecatedProperty(cs);
084    concept.addProperty().setCode("deprecationDate").setValue(date);    
085  }
086
087  public static void defineNotSelectableProperty(CodeSystem cs) {
088    defineCodeSystemProperty(cs, "notSelectable", "Indicates that the code is abstract - only intended to be used as a selector for other concepts", PropertyType.BOOLEAN);
089  }
090
091  public static void defineInactiveProperty(CodeSystem cs) {
092    defineCodeSystemProperty(cs, "inactive", "True if the concept is not considered active - e.g. not a valid concept any more", PropertyType.BOOLEAN);
093  }
094
095  public static void defineDeprecatedProperty(CodeSystem cs) {
096    defineCodeSystemProperty(cs, "deprecationDate", "The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged", PropertyType.DATETIME);
097  }
098
099  public static void defineCodeSystemProperty(CodeSystem cs, String code, String description, PropertyType type) {
100    for (PropertyComponent p : cs.getProperty()) {
101      if (p.getCode().equals(code))
102        return;
103    }
104    cs.addProperty().setCode(code).setDescription(description).setType(type).setUri("http://hl7.org/fhir/concept-properties#"+code);
105  }
106
107  public static String getCodeDefinition(CodeSystem cs, String code) {
108    return getCodeDefinition(cs.getConcept(), code);
109  }
110
111  private static String getCodeDefinition(List<ConceptDefinitionComponent> list, String code) {
112    for (ConceptDefinitionComponent c : list) {
113      if (c.getCode().equals(code))
114        return c.getDefinition();
115      String s = getCodeDefinition(c.getConcept(), code);
116      if (s != null)
117        return s;
118    }
119    return null;
120  }
121
122  public static CodeSystem makeShareable(CodeSystem cs) {
123    if (!cs.hasMeta())
124      cs.setMeta(new Meta());
125    for (UriType t : cs.getMeta().getProfile()) 
126      if (t.getValue().equals("http://hl7.org/fhir/StructureDefinition/shareablecodesystem"))
127        return cs;
128    cs.getMeta().getProfile().add(new UriType("http://hl7.org/fhir/StructureDefinition/shareablecodesystem"));
129    return cs;
130  }
131
132  public static void setOID(CodeSystem cs, String oid) {
133    if (!oid.startsWith("urn:oid:"))
134       oid = "urn:oid:" + oid;
135    if (!cs.hasIdentifier())
136      cs.setIdentifier(new Identifier().setSystem("urn:ietf:rfc:3986").setValue(oid));
137    else if ("urn:ietf:rfc:3986".equals(cs.getIdentifier().getSystem()) && cs.getIdentifier().hasValue() && cs.getIdentifier().getValue().startsWith("urn:oid:"))
138      cs.getIdentifier().setValue(oid);
139    else
140      throw new Error("unable to set OID on code system");
141    
142  }
143
144  public static boolean hasOID(CodeSystem cs) {
145    return getOID(cs) != null;
146  }
147
148  public static String getOID(CodeSystem cs) {
149    if (cs.hasIdentifier() && "urn:ietf:rfc:3986".equals(cs.getIdentifier().getSystem()) && cs.getIdentifier().hasValue() && cs.getIdentifier().getValue().startsWith("urn:oid:"))
150        return cs.getIdentifier().getValue().substring(8);
151    return null;
152  }
153
154  public static boolean isInactive(CodeSystem cs, ConceptDefinitionComponent def) throws FHIRException {
155    for (ConceptPropertyComponent p : def.getProperty()) {
156      if (p.getCode().equals("status") && p.hasValueStringType()) 
157        return "inactive".equals(p.getValueStringType());
158    }
159    return false;
160  }
161  
162  public static boolean isInactive(CodeSystem cs, String code) throws FHIRException {
163    ConceptDefinitionComponent def = findCode(cs.getConcept(), code);
164    if (def == null)
165      return true;
166    return isInactive(cs, def);
167  }
168
169  private static ConceptDefinitionComponent findCode(List<ConceptDefinitionComponent> list, String code) {
170    for (ConceptDefinitionComponent c : list) {
171      if (c.getCode().equals(code))
172        return c;
173      ConceptDefinitionComponent s = findCode(c.getConcept(), code);
174      if (s != null)
175        return s;
176    }
177    return null;
178  }
179
180  public static void markStatus(CodeSystem cs, String wg, String status, String fmm) {
181    if (wg != null) {
182      if (!ToolingExtensions.hasExtension(cs, ToolingExtensions.EXT_WORKGROUP) || 
183          (Utilities.existsInList(ToolingExtensions.readStringExtension(cs, ToolingExtensions.EXT_WORKGROUP), "fhir", "vocab") && !Utilities.existsInList(wg, "fhir", "vocab"))) {
184        ToolingExtensions.setCodeExtension(cs, ToolingExtensions.EXT_WORKGROUP, wg);
185      }
186    }
187    if (status != null) {
188      String ss = ToolingExtensions.readStringExtension(cs, ToolingExtensions.EXT_BALLOT_STATUS);
189      if (Utilities.noString(ss) || ssval(ss) < ssval(status)) 
190        ToolingExtensions.setStringExtension(cs, ToolingExtensions.EXT_BALLOT_STATUS, status);
191    }
192    if (fmm != null) {
193      String sfmm = ToolingExtensions.readStringExtension(cs, ToolingExtensions.EXT_FMM_LEVEL);
194      if (Utilities.noString(sfmm) || Integer.parseInt(sfmm) < Integer.parseInt(fmm)) 
195        ToolingExtensions.setIntegerExtension(cs, ToolingExtensions.EXT_FMM_LEVEL, Integer.parseInt(fmm));
196    }
197  }
198
199  private static int ssval(String status) {
200    if ("Draft".equals("status")) 
201      return 1;
202    if ("Informative".equals("status")) 
203      return 2;
204    if ("External".equals("status")) 
205      return 3;
206    if ("Trial Use".equals("status")) 
207      return 3;
208    if ("Normative".equals("status")) 
209      return 4;
210    return -1;
211  }
212
213}