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