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; 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 */ 054public interface ITerminologyServices { 055 /** 056 * return true if the service handles code or value set resolution on the system 057 */ 058 public boolean supportsSystem(String system); 059 060 /** 061 * given a system|code, return a definition for it. Nil means not valid 062 */ 063 public ConceptDefinitionComponent getCodeDefinition(String system, String code); 064 065 public class ValidationResult { 066 private IssueSeverity severity; 067 private String message; 068 069 public ValidationResult(IssueSeverity severity, String message) { 070 super(); 071 this.severity = severity; 072 this.message = message; 073 } 074 075 public IssueSeverity getSeverity() { 076 return severity; 077 } 078 079 public String getMessage() { 080 return message; 081 } 082 083 } 084 085 /** 086 * for this system|code and display, validate the triple against the rules of 087 * the underlying code system 088 */ 089 public ValidationResult validateCode(String system, String code, String display); 090 091 /** 092 * Expand the value set fragment (system | codes | filters). Note that this 093 * might fail if the expansion is very large. If the expansion fails, then the 094 * checkVS will be called instead 095 */ 096 public ValueSetExpansionComponent expandVS(ConceptSetComponent inc) throws Exception; 097 098// public ValueSet expandVS(ValueSet vs) throws Exception; 099 public ValueSetExpansionOutcome expand(ValueSet vs); 100 101 /** 102 * Test the value set fragment (system | codes | filters). 103 */ 104 public boolean checkVS(ConceptSetComponent vsi, String system, String code); 105 106 public boolean verifiesSystem(String system); 107 108}