001package org.hl7.fhir.r5.terminologies.client;
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
033import org.hl7.fhir.exceptions.FHIRException;
034import org.hl7.fhir.r5.model.*;
035import org.hl7.fhir.r5.model.Enumerations.FHIRVersion;
036import org.hl7.fhir.r5.utils.client.network.ClientHeaders;
037import org.hl7.fhir.utilities.FhirPublication;
038import org.hl7.fhir.utilities.ToolingClientLogger;
039
040import java.util.EnumSet;
041import java.util.Map;
042
043public interface ITerminologyClient {
044
045  EnumSet<FhirPublication> supportableVersions();
046  void setAllowedVersions(EnumSet<FhirPublication> versions);
047  EnumSet<FhirPublication> getAllowedVersions();
048  FhirPublication getActualVersion();
049  
050  String getId();
051  String getAddress();
052  String getServerVersion();
053  TerminologyCapabilities getTerminologyCapabilities() throws FHIRException;
054  ValueSet expandValueset(ValueSet vs, Parameters p) throws FHIRException;
055  Parameters validateCS(Parameters pin) throws FHIRException;
056  Parameters validateVS(Parameters pin) throws FHIRException;
057  Parameters subsumes(Parameters pin) throws FHIRException;
058  ITerminologyClient setTimeoutFactor(int i) throws FHIRException;
059  ToolingClientLogger getLogger();
060  ITerminologyClient setLogger(ToolingClientLogger txLog) throws FHIRException;
061  int getRetryCount() throws FHIRException;
062  ITerminologyClient setRetryCount(int retryCount) throws FHIRException;
063  CapabilityStatement getCapabilitiesStatementQuick() throws FHIRException;
064  Parameters lookupCode(Map<String, String> params) throws FHIRException;
065  Parameters lookupCode(Parameters params) throws FHIRException;
066  Parameters translate(Parameters params) throws FHIRException;
067  Bundle validateBatch(Bundle batch);
068  CanonicalResource read(String type, String id);
069  ClientHeaders getClientHeaders();
070  ITerminologyClient setClientHeaders(ClientHeaders clientHeaders);
071  ITerminologyClient setUserAgent(String userAgent);
072  ITerminologyClient setAcceptLanguage(String lang);
073  ITerminologyClient setContentLanguage(String lang);
074  String getUserAgent();
075  int getUseCount();
076  Bundle search(String type, String criteria); 
077}