Package org.hl7.fhir.r4.context

Class BaseWorkerContext

java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.r4.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

Modifier and Type	Class	Description
class	BaseWorkerContext.NullTranslator

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

IWorkerContext.ILoggingService, IWorkerContext.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected Parameters	expParameters
protected String	name
protected boolean	noTerminologyServer
protected Map<String,StructureMap>	transforms
protected String	tsServer
protected TerminologyCache	txCache
protected TerminologyClient	txClient
protected HTMLClientLogger	txLog
protected Map<String,Map<String,IWorkerContext.ValidationResult>>	validationCache

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

KEY_DELIMITER, uncontainedKeys

Constructor Summary

Constructors

Constructor	Description
BaseWorkerContext()
BaseWorkerContext(Map<String,CodeSystem> codeSystems, Map<String,ValueSet> valueSets, Map<String,ConceptMap> maps, Map<String,StructureDefinition> profiles, Map<String,ImplementationGuide> guides)

Method Summary

Modifier and Type	Method	Description
List<MetadataResource>	allConformanceResources()
void	cacheResource(Resource r)	cache a resource for later retrieval using fetchResource.
void	cacheVS(com.google.gson.JsonObject json, Map<String,IWorkerContext.ValidationResult> t)
protected void	copy(BaseWorkerContext other)
IWorkerContext.ValidationResult	doValidateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, Coding code, ValueSet vs, boolean inferSystem)
void	dropResource(String fhirType, String id)
void	dropResource(Resource r)
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ElementDefinition.ElementDefinitionBindingComponent binding, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand, but resolves the binding first
ValueSetExpander.ValueSetExpansionOutcome	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
ValueSetExpander.ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical, Parameters p)
CodeSystem	fetchCodeSystem(String system)	Find the code system definition for the nominated system uri. return null if there isn't one (then the tool might try supportsSystem)
<T extends Resource> T	fetchResource(Class<T> class_, String uri)	Find an identified resource.
<T extends Resource> T	fetchResource(Class<T> class_, String uri, String version)
<T extends Resource> T	fetchResource(Class<T> class_, String uri, Resource source)
Resource	fetchResourceById(String type, String uri)	Variation of fetchResource when you have a string type, and don't need the right class The URI can have one of 3 formats: - a full URL e.g.
<T extends Resource> List<T>	fetchResourcesByType(Class<T> class_)
<T extends Resource> T	fetchResourceWithException(Class<T> class_, String uri)
StructureDefinition	fetchTypeDefinition(String typeName)
List<StructureDefinition>	fetchTypeDefinitions(String n)
List<ConceptMap>	findMapsForSource(String url)	find concept maps for a source
int	getExpandCodesLimit()
Parameters	getExpansionParameters()
String	getLinkForUrl(String corePath, String url)
IWorkerContext.ILoggingService	getLogger()	Deprecated.
String	getName()
String	getOverrideVersionNs()
Set<String>	getResourceNamesAsSet()
SearchParameter	getSearchParameter(String code)
StructureDefinition	getStructure(String code)
List<StructureDefinition>	getStructures()
StructureMap	getTransform(String code)
org.fhir.ucum.UcumService	getUcumService()
<T extends Resource> boolean	hasResource(Class<T> class_, String uri)	find whether a resource is available.
void	initTS(String cachePath)
boolean	isAllowLoadingDuplicates()
boolean	isCanRunWithoutTerminology()
boolean	isDataType(String type)
boolean	isNoTerminologyServer()
boolean	isPrimitiveType(String type)
boolean	isTlogging()
List<ConceptMap>	listMaps()
List<StructureDefinition>	listStructures()
String	listSupportedSystems()
List<StructureMap>	listTransforms()
String	oid2Uri(String oid)
void	reportStatus(com.google.gson.JsonObject json)
protected <T extends MetadataResource> void	seeMetadataResource(T r, Map<String,T> map, boolean addId)
void	setAllowLoadingDuplicates(boolean allowLoadingDuplicates)
void	setCanRunWithoutTerminology(boolean canRunWithoutTerminology)
void	setExpandCodesLimit(int expandCodesLimit)
void	setExpansionProfile(Parameters expParameters)
void	setLogger(IWorkerContext.ILoggingService logger)	Deprecated.
void	setName(String name)
void	setOverrideVersionNs(String value)
void	setTlogging(boolean tlogging)
void	setTranslator(org.hl7.fhir.utilities.TranslationServices translator)
void	setUcumService(org.fhir.ucum.UcumService ucumService)
boolean	supportsSystem(String system)	True if the underlying terminology service provider will do expansion and code validation for the terminology.
protected void	tlog(String msg)
int	totalCount()
org.hl7.fhir.utilities.TranslationServices	translator()
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, String system, String code, String display)	Validation of a code - consult the terminology service to see whether it is known.
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, 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(org.hl7.fhir.utilities.validation.ValidationOptions options, 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(org.hl7.fhir.utilities.validation.ValidationOptions options, String code, ValueSet vs)
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, CodeableConcept code, ValueSet vs)
IWorkerContext.ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, Coding code, ValueSet vs)

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

formatMessage, formatMessagePlural, getLocale, getMessages, getMessagesSourceFileName, getPluralKey, getPluralKeys, getPluralRules, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, logUncontainedMessage, messageKeyExistsForLocale, setLocale, setValidationMessageLanguage, setWarnAboutMissingMessages, typeOfString

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.r4.context.IWorkerContext

allStructures, formatMessage, formatMessagePlural, generateSnapshot, getAbbreviation, getLocale, getNarrativeGenerator, getParser, getParser, getResourceNames, getTypeNames, getVersion, hasCache, newJsonParser, newValidator, newXmlParser, setLocale, setValidationMessageLanguage, typeTails

Field Details

transforms

protected Map<String,StructureMap> transforms

validationCache

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

tsServer

protected String tsServer

name

protected String name

txClient

protected TerminologyClient txClient

txLog

protected HTMLClientLogger txLog

noTerminologyServer

protected boolean noTerminologyServer

expParameters

protected Parameters expParameters

txCache

protected TerminologyCache txCache

Constructor Details

BaseWorkerContext

public BaseWorkerContext()
                  throws FileNotFoundException,
IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

FileNotFoundException

IOException

org.hl7.fhir.exceptions.FHIRException

BaseWorkerContext

public BaseWorkerContext(Map<String,CodeSystem> codeSystems,
 Map<String,ValueSet> valueSets,
 Map<String,ConceptMap> maps,
 Map<String,StructureDefinition> profiles,
 Map<String,ImplementationGuide> guides)
                  throws FileNotFoundException,
IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

FileNotFoundException

IOException

org.hl7.fhir.exceptions.FHIRException

Method Details

copy

protected void copy(BaseWorkerContext other)

cacheResource

public void cacheResource(Resource r)
                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

cache a resource for later retrieval using fetchResource. Note that various context implementations will have their own ways of loading rseources, and not all need implement cacheResource

Specified by:

cacheResource in interface IWorkerContext

Parameters:

r -

Throws:

org.hl7.fhir.exceptions.FHIRException

seeMetadataResource

protected <T extends MetadataResource> void seeMetadataResource(T r,
 Map<String,T> map,
 boolean addId)
                                                         throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

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

Parameters:

system -

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

Parameters:

system -

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

tlog

protected void tlog(String msg)

getExpandCodesLimit

public int getExpandCodesLimit()

setExpandCodesLimit

public void setExpandCodesLimit(int expandCodesLimit)

expandVS

public ValueSetExpander.ValueSetExpansionOutcome expandVS(ElementDefinition.ElementDefinitionBindingComponent binding,
 boolean cacheOk,
 boolean heirarchical)
                                                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand, but resolves the binding first

Specified by:

expandVS in interface IWorkerContext

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

expandVS

public ValueSetExpander.ValueSetExpansionOutcome 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

Parameters:

inc -

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

Parameters:

vs -

Returns:

expandVS

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

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 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

Parameters:

system -

code -

display -

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 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

Parameters:

system -

code -

display -

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 String code,
 ValueSet vs)

Specified by:

validateCode in interface IWorkerContext

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 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

Parameters:

system -

code -

display -

Returns:

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 Coding code,
 ValueSet vs)

Specified by:

validateCode in interface IWorkerContext

doValidateCode

public IWorkerContext.ValidationResult doValidateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 Coding code,
 ValueSet vs,
 boolean inferSystem)

validateCode

public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 CodeableConcept code,
 ValueSet vs)

Specified by:

validateCode in interface IWorkerContext

initTS

public void initTS(String cachePath)
            throws Exception

Throws:

Exception

findMapsForSource

public List<ConceptMap> findMapsForSource(String url)
                                   throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContext

find concept maps for a source

Specified by:

findMapsForSource in interface IWorkerContext

Parameters:

url -

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

isCanRunWithoutTerminology

public boolean isCanRunWithoutTerminology()

setCanRunWithoutTerminology

public void setCanRunWithoutTerminology(boolean canRunWithoutTerminology)

setLogger

@Deprecated
public void setLogger(IWorkerContext.ILoggingService logger)

Deprecated.

Specified by:

setLogger in interface IWorkerContext

getExpansionParameters

public Parameters getExpansionParameters()

Specified by:

getExpansionParameters in interface IWorkerContext

setExpansionProfile

public void setExpansionProfile(Parameters expParameters)

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

isAllowLoadingDuplicates

public boolean isAllowLoadingDuplicates()

setAllowLoadingDuplicates

public void setAllowLoadingDuplicates(boolean allowLoadingDuplicates)

fetchResourceWithException

public <T extends Resource> T fetchResourceWithException(Class<T> class_,
 String uri)
                                                  throws org.hl7.fhir.exceptions.FHIRException

Specified by:

fetchResourceWithException in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceById

public Resource fetchResourceById(String type,
 String uri)

Description copied from interface: IWorkerContext

Variation of fetchResource when you have a string type, and don't need the right class The URI can have one of 3 formats: - a full URL e.g. http://acme.org/fhir/ValueSet/[id] - a relative URL e.g. ValueSet/[id] - a logical id e.g. [id] if type == null, the URI can't be a simple logical id

Specified by:

fetchResourceById in interface IWorkerContext

Parameters:

type -

uri -

Returns:

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri)

Description copied from interface: IWorkerContext

Find an identified resource. The most common use of this is to access the the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. Also, the narrative generator uses this, and may access any kind of resource The URI is called speculatively for things that might exist, so not finding a matching resouce, return null, not an error The URI can have one of 3 formats: - a full URL e.g. http://acme.org/fhir/ValueSet/[id] - a relative URL e.g. ValueSet/[id] - a logical id e.g. [id] It's an error if the second form doesn't agree with class_. It's an error if class_ is null for the last form

Specified by:

fetchResource in interface IWorkerContext

Returns:

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri,
 Resource source)

Specified by:

fetchResource in interface IWorkerContext

fetchTypeDefinitions

public List<StructureDefinition> fetchTypeDefinitions(String n)

Specified by:

fetchTypeDefinitions in interface IWorkerContext

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri,
 String version)

Specified by:

fetchResource in interface IWorkerContext

hasResource

public <T extends Resource> boolean hasResource(Class<T> class_,
 String uri)

Description copied from interface: IWorkerContext

find whether a resource is available. Implementations of the interface can assume that if hasResource ruturns true, the resource will usually be fetched subsequently

Specified by:

hasResource in interface IWorkerContext

Parameters:

class_ -

uri -

Returns:

translator

public org.hl7.fhir.utilities.TranslationServices translator()

Specified by:

translator in interface IWorkerContext

setTranslator

public void setTranslator(org.hl7.fhir.utilities.TranslationServices translator)

reportStatus

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

dropResource

public void dropResource(Resource r)
                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

dropResource

public void dropResource(String fhirType,
 String id)

allConformanceResources

public List<MetadataResource> allConformanceResources()

Specified by:

allConformanceResources in interface IWorkerContext

listSupportedSystems

public String listSupportedSystems()

totalCount

public int totalCount()

listMaps

public List<ConceptMap> listMaps()

listTransforms

public List<StructureMap> listTransforms()

Specified by:

listTransforms in interface IWorkerContext

getTransform

public StructureMap getTransform(String code)

Specified by:

getTransform in interface IWorkerContext

listStructures

public List<StructureDefinition> listStructures()

getStructure

public StructureDefinition getStructure(String code)

oid2Uri

public String oid2Uri(String oid)

Specified by:

oid2Uri in interface IWorkerContext

cacheVS

public void cacheVS(com.google.gson.JsonObject json,
 Map<String,IWorkerContext.ValidationResult> t)

getSearchParameter

public SearchParameter getSearchParameter(String code)

getOverrideVersionNs

public String getOverrideVersionNs()

Specified by:

getOverrideVersionNs in interface IWorkerContext

setOverrideVersionNs

public void setOverrideVersionNs(String value)

Specified by:

setOverrideVersionNs in interface IWorkerContext

getLogger

@Deprecated
public IWorkerContext.ILoggingService getLogger()

Deprecated.

Specified by:

getLogger in interface IWorkerContext

fetchTypeDefinition

public StructureDefinition fetchTypeDefinition(String typeName)

Specified by:

fetchTypeDefinition in interface IWorkerContext

isPrimitiveType

public boolean isPrimitiveType(String type)

Specified by:

isPrimitiveType in interface IWorkerContext

isDataType

public boolean isDataType(String type)

isTlogging

public boolean isTlogging()

setTlogging

public void setTlogging(boolean tlogging)

getUcumService

public org.fhir.ucum.UcumService getUcumService()

Specified by:

getUcumService in interface IWorkerContext

setUcumService

public void setUcumService(org.fhir.ucum.UcumService ucumService)

Specified by:

setUcumService in interface IWorkerContext

getStructures

public List<StructureDefinition> getStructures()

Specified by:

getStructures in interface IWorkerContext

getLinkForUrl

public String getLinkForUrl(String corePath,
 String url)

Specified by:

getLinkForUrl in interface IWorkerContext

fetchResourcesByType

public <T extends Resource> List<T> fetchResourcesByType(Class<T> class_)

Specified by:

fetchResourcesByType in interface IWorkerContext