Package org.hl7.fhir.dstu3.context

Class BaseWorkerContext

java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.dstu3.context.BaseWorkerContext

All Implemented Interfaces:

IWorkerContext

Direct Known Subclasses:

SimpleWorkerContext

public abstract class BaseWorkerContext
extends org.hl7.fhir.utilities.i18n.I18nBase
implements IWorkerContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.dstu3.context.IWorkerContext

IWorkerContext.ILoggingService, IWorkerContext.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowLoadingDuplicates
protected String	cache
protected boolean	cacheValidation
protected Map<String,CodeSystem>	codeSystems
protected Map<String,DataElement>	dataElements
protected ValueSetExpanderFactory	expansionCache
protected ExpansionProfile	expProfile
protected Map<String,StructureDefinition>	extensionDefinitions
protected IWorkerContext.ILoggingService	logger
protected Map<String,ConceptMap>	maps
protected String	name
protected Set<String>	nonSupportedCodeSystems
protected boolean	noTerminologyServer
protected Map<String,OperationDefinition>	operations
protected Map<String,StructureDefinition>	profiles
protected Map<String,Questionnaire>	questionnaires
protected Map<String,SearchParameter>	searchParameters
protected Map<String,StructureMap>	transforms
protected String	tsServer
protected FHIRToolingClient	txServer
protected Map<String,Map<String,IWorkerContext.ValidationResult>>	validationCache
protected String	validationCachePath
protected Map<String,ValueSet>	valueSets

Fields inherited from class org.hl7.fhir.utilities.i18n.I18nBase

KEY_DELIMITER, PLURAL_SUFFIX

Constructor Summary

Constructors

Constructor	Description
BaseWorkerContext()

Method Summary

Modifier and Type	Method	Description
void	cacheResource(Resource r)
void	dropCodeSystem(String id)
void	dropExtensionDefinition(String id)
void	dropProfile(String id)
void	dropResource(String type, String id)
void	dropValueSet(String id)
ValueSetExpander.ValueSetExpansionOutcome	expandOnServer(ValueSet vs, String fn)
ValueSet.ValueSetExpansionComponent	expandVS(ValueSet.ConceptSetComponent inc, boolean heirachical)	Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand
CodeSystem	fetchCodeSystem(String system)	Find the code system definition for the nominated system uri.
StructureDefinition	fetchTypeDefinition(String typeName)
List<ConceptMap>	findMapsForSource(String url)	find concept maps for a source
Map<String,CodeSystem>	getCodeSystems()
Map<String,DataElement>	getDataElements()
int	getExpandCodesLimit()
ExpansionProfile	getExpansionProfile()
Map<String,StructureDefinition>	getExtensionDefinitions()
Map<String,ConceptMap>	getMaps()
String	getName()
Set<String>	getNonSupportedCodeSystems()
Map<String,OperationDefinition>	getOperations()
Map<String,StructureDefinition>	getProfiles()
Map<String,Questionnaire>	getQuestionnaires()
Set<String>	getResourceNamesAsSet()
Map<String,ValueSet>	getValueSets()
void	initTS(String cachePath, String tsServer)
boolean	isAllowLoadingDuplicates()
boolean	isCanRunWithoutTerminology()
boolean	isNoTerminologyServer()
protected void	loadValidationCache()
void	reportStatus(com.google.gson.JsonObject json)
void	seeCodeSystem(String url, CodeSystem cs)
void	seeExtensionDefinition(String url, StructureDefinition ed)
void	seeOperation(OperationDefinition opd)
void	seeProfile(String url, StructureDefinition p)
void	seeQuestionnaire(String url, Questionnaire theQuestionnaire)
void	seeValueSet(String url, ValueSet vs)
void	setAllowLoadingDuplicates(boolean allowLoadingDuplicates)
void	setCanRunWithoutTerminology(boolean canRunWithoutTerminology)
void	setExpandCodesLimit(int expandCodesLimit)
void	setExpansionProfile(ExpansionProfile expProfile)
void	setLogger(IWorkerContext.ILoggingService logger)
void	setName(String name)
boolean	supportsSystem(String system)	True if the underlying terminology service provider will do expansion and code validation for the terminology.
IWorkerContext.ValidationResult	validateCode(String system, String code, String display)	Validation of a code - consult the terminology service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(String system, String code, String display, ValueSet vs)	Validation of a code - consult the terminology service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(String system, String code, String display, ValueSet.ConceptSetComponent vsi)	Validation of a code - consult the terminology service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(CodeableConcept code, ValueSet vs)
IWorkerContext.ValidationResult	validateCode(Coding code, ValueSet vs)

Methods inherited from class org.hl7.fhir.utilities.i18n.I18nBase

formatMessage, formatMessagePlural, getLocale, getPluralKey, isWarnAboutMissingMessages, setLocale, setPluralRules, setValidationMessageLanguage, setWarnAboutMissingMessages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.dstu3.context.IWorkerContext

allConformanceResources, allStructures, fetchResource, fetchResourceWithException, formatMessage, getAbbreviation, getLocale, getNarrativeGenerator, getParser, getParser, getResourceNames, getTypeNames, getVersion, hasCache, hasResource, newJsonParser, newValidator, newXmlParser, oid2Uri, setLocale, setValidationMessageLanguage, typeTails

Field Detail

codeSystems

protected Map<String,CodeSystem> codeSystems

nonSupportedCodeSystems

protected Set<String> nonSupportedCodeSystems

valueSets

protected Map<String,ValueSet> valueSets

maps

protected Map<String,ConceptMap> maps

transforms

protected Map<String,StructureMap> transforms

dataElements

protected Map<String,DataElement> dataElements

profiles

protected Map<String,StructureDefinition> profiles

searchParameters

protected Map<String,SearchParameter> searchParameters

extensionDefinitions

protected Map<String,StructureDefinition> extensionDefinitions

questionnaires

protected Map<String,Questionnaire> questionnaires

operations

protected Map<String,OperationDefinition> operations

expansionCache

protected ValueSetExpanderFactory expansionCache

cacheValidation

protected boolean cacheValidation

validationCache

protected Map<String,Map<String,IWorkerContext.ValidationResult>> validationCache

tsServer

protected String tsServer

validationCachePath

protected String validationCachePath

name

protected String name

txServer

protected FHIRToolingClient txServer

allowLoadingDuplicates

protected boolean allowLoadingDuplicates

noTerminologyServer

protected boolean noTerminologyServer

cache

protected String cache

logger

protected IWorkerContext.ILoggingService logger

expProfile

protected ExpansionProfile expProfile

Constructor Detail

BaseWorkerContext

public BaseWorkerContext()

Method Detail

getCodeSystems

public Map<String,CodeSystem> getCodeSystems()

getDataElements

public Map<String,DataElement> getDataElements()

getValueSets

public Map<String,ValueSet> getValueSets()

getMaps

public Map<String,ConceptMap> getMaps()

getProfiles

public Map<String,StructureDefinition> getProfiles()

getExtensionDefinitions

public Map<String,StructureDefinition> getExtensionDefinitions()

getQuestionnaires

public Map<String,Questionnaire> getQuestionnaires()

getOperations

public Map<String,OperationDefinition> getOperations()

seeExtensionDefinition

public void seeExtensionDefinition(String url,
                                   StructureDefinition ed)
                            throws Exception

Throws:

Exception

dropExtensionDefinition

public void dropExtensionDefinition(String id)

seeQuestionnaire

public void seeQuestionnaire(String url,
                             Questionnaire theQuestionnaire)
                      throws Exception

Throws:

Exception

seeOperation

public void seeOperation(OperationDefinition opd)
                  throws Exception

Throws:

Exception

seeValueSet

public void seeValueSet(String url,
                        ValueSet vs)
                 throws Exception

Throws:

Exception

dropValueSet

public void dropValueSet(String id)

seeCodeSystem

public void seeCodeSystem(String url,
                          CodeSystem cs)
                   throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

dropCodeSystem

public void dropCodeSystem(String id)

seeProfile

public void seeProfile(String url,
                       StructureDefinition p)
                throws Exception

Throws:

Exception

dropProfile

public void dropProfile(String id)

fetchCodeSystem

public CodeSystem fetchCodeSystem(String system)

Description copied from interface: IWorkerContext

Find the code system definition for the nominated system uri. return null if there isn't one (then the tool might try supportsSystem)

Specified by:

fetchCodeSystem in interface IWorkerContext

Returns:

supportsSystem

public boolean supportsSystem(String system)
                       throws org.hl7.fhir.exceptions.TerminologyServiceException

Description copied from interface: IWorkerContext

True if the underlying terminology service provider will do expansion and code validation for the terminology. Corresponds to the extension http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system in the Conformance resource

Specified by:

supportsSystem in interface IWorkerContext

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet vs,
                                                          boolean cacheOk,
                                                          boolean heirarchical)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand

Specified by:

expandVS in interface IWorkerContext

Returns:

expandOnServer

public ValueSetExpander.ValueSetExpansionOutcome expandOnServer(ValueSet vs,
                                                                String fn)
                                                         throws Exception

Throws:

Exception

expandVS

public ValueSet.ValueSetExpansionComponent expandVS(ValueSet.ConceptSetComponent inc,
                                                    boolean heirachical)
                                             throws org.hl7.fhir.exceptions.TerminologyServiceException

Description copied from interface: IWorkerContext

Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.

Specified by:

expandVS in interface IWorkerContext

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

validateCode

public IWorkerContext.ValidationResult validateCode(String system,
                                                    String code,
                                                    String display)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(Coding code,
                                                    ValueSet vs)

Specified by:

validateCode in interface IWorkerContext

validateCode

public IWorkerContext.ValidationResult validateCode(CodeableConcept code,
                                                    ValueSet vs)

Specified by:

validateCode in interface IWorkerContext

validateCode

public IWorkerContext.ValidationResult validateCode(String system,
                                                    String code,
                                                    String display,
                                                    ValueSet vs)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it Also, check whether it's in the provided value set note: always return a result, with either an error or a code description, or both (e.g. known code, but not in the value set) corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(String system,
                                                    String code,
                                                    String display,
                                                    ValueSet.ConceptSetComponent vsi)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it Also, check whether it's in the provided value set fragment (for supported systems with no value set definition) note: always return a result, with either an error or a code description, or both (e.g. known code, but not in the value set) corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Returns:

initTS

public void initTS(String cachePath,
                   String tsServer)
            throws Exception

Throws:

Exception

loadValidationCache

protected void loadValidationCache()
                            throws com.google.gson.JsonSyntaxException,
                                   Exception

Throws:

com.google.gson.JsonSyntaxException

Exception

findMapsForSource

public List<ConceptMap> findMapsForSource(String url)

Description copied from interface: IWorkerContext

find concept maps for a source

Specified by:

findMapsForSource in interface IWorkerContext

Returns:

getNonSupportedCodeSystems

public Set<String> getNonSupportedCodeSystems()

isCanRunWithoutTerminology

public boolean isCanRunWithoutTerminology()

setCanRunWithoutTerminology

public void setCanRunWithoutTerminology(boolean canRunWithoutTerminology)

getExpandCodesLimit

public int getExpandCodesLimit()

setExpandCodesLimit

public void setExpandCodesLimit(int expandCodesLimit)

setLogger

public void setLogger(IWorkerContext.ILoggingService logger)

Specified by:

setLogger in interface IWorkerContext

getExpansionProfile

public ExpansionProfile getExpansionProfile()

Specified by:

getExpansionProfile in interface IWorkerContext

setExpansionProfile

public void setExpansionProfile(ExpansionProfile expProfile)

Specified by:

setExpansionProfile in interface IWorkerContext

isNoTerminologyServer

public boolean isNoTerminologyServer()

Specified by:

isNoTerminologyServer in interface IWorkerContext

getName

public String getName()

setName

public void setName(String name)

getResourceNamesAsSet

public Set<String> getResourceNamesAsSet()

Specified by:

getResourceNamesAsSet in interface IWorkerContext

reportStatus

public void reportStatus(com.google.gson.JsonObject json)

cacheResource

public void cacheResource(Resource r)
                   throws Exception

Throws:

Exception

dropResource

public void dropResource(String type,
                         String id)
                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isAllowLoadingDuplicates

public boolean isAllowLoadingDuplicates()

setAllowLoadingDuplicates

public void setAllowLoadingDuplicates(boolean allowLoadingDuplicates)

fetchTypeDefinition

public StructureDefinition fetchTypeDefinition(String typeName)

Specified by:

fetchTypeDefinition in interface IWorkerContext