001package org.hl7.fhir.r4.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
032import org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent;
033import org.hl7.fhir.r4.model.OperationOutcome.IssueSeverity;
034import org.hl7.fhir.r4.model.ValueSet;
035import org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent;
036import org.hl7.fhir.r4.model.ValueSet.ValueSetExpansionComponent;
037import org.hl7.fhir.r4.terminologies.ValueSetExpander.ValueSetExpansionOutcome;
038import org.hl7.fhir.utilities.MarkedToMoveToAdjunctPackage;
039
040/**
041 * The value set system has a collection of value sets that define code systems,
042 * and construct value sets from them
043 * 
044 * Large external terminologies - LOINC, Snomed, etc - are too big, and trying
045 * to represent their definition as a native value set is too large. (e.g. LOINC
046 * + properties ~ 500MB). So we don't try. Instead. we assume that there's some
047 * external server that provides these services, using this interface
048 * 
049 * The FHIR build tool uses http://fhir.healthintersections.com.au for these
050 * services
051 * 
052 * @author Grahame
053 *
054 */
055@MarkedToMoveToAdjunctPackage
056public interface ITerminologyServices {
057  /**
058   * return true if the service handles code or value set resolution on the system
059   */
060  public boolean supportsSystem(String system);
061
062  /**
063   * given a system|code, return a definition for it. Nil means not valid
064   */
065  public ConceptDefinitionComponent getCodeDefinition(String system, String code);
066
067  public class ValidationResult {
068    private IssueSeverity severity;
069    private String message;
070
071    public ValidationResult(IssueSeverity severity, String message) {
072      super();
073      this.severity = severity;
074      this.message = message;
075    }
076
077    public IssueSeverity getSeverity() {
078      return severity;
079    }
080
081    public String getMessage() {
082      return message;
083    }
084
085  }
086
087  /**
088   * for this system|code and display, validate the triple against the rules of
089   * the underlying code system
090   */
091  public ValidationResult validateCode(String system, String code, String display);
092
093  /**
094   * Expand the value set fragment (system | codes | filters). Note that this
095   * might fail if the expansion is very large. If the expansion fails, then the
096   * checkVS will be called instead
097   */
098  public ValueSetExpansionComponent expandVS(ConceptSetComponent inc) throws Exception;
099
100//  public ValueSet expandVS(ValueSet vs) throws Exception;
101  public ValueSetExpansionOutcome expand(ValueSet vs);
102
103  /**
104   * Test the value set fragment (system | codes | filters).
105   */
106  public boolean checkVS(ConceptSetComponent vsi, String system, String code);
107
108  public boolean verifiesSystem(String system);
109
110}