Package org.hl7.fhir.r5.context

Class BaseWorkerContext

java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.r5.context.BaseWorkerContext

All Implemented Interfaces:

IOIDServices, IWorkerContext, IWorkerContextManager

Direct Known Subclasses:

SimpleWorkerContext

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BaseWorkerContext.BytesFromFileProvider
class	BaseWorkerContext.BytesFromPackageProvider
class	BaseWorkerContext.BytesProvider
static interface	BaseWorkerContext.IByteProvider
class	BaseWorkerContext.MetadataResourceVersionComparator<T extends CanonicalResource>
static class	BaseWorkerContext.ResourceProxy

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.context.IOIDServices

IOIDServices.OIDDefinition, IOIDServices.OIDDefinitionComparer, IOIDServices.OIDSummary

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

IWorkerContext.SystemSupportInformation

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.context.IWorkerContextManager

IWorkerContextManager.ICanonicalResourceLocator, IWorkerContextManager.IPackageLoadingTracker

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,BaseWorkerContext.IByteProvider>	binaries
protected boolean	canRunWithoutTerminology
protected org.hl7.fhir.utilities.TimeTracker	clock
protected ContextUtilities	cutils
protected AtomicReference<Parameters>	expansionParameters
protected ILoggingService	logger
protected String	name
protected boolean	noTerminologyServer
protected Map<String,Set<IOIDServices.OIDDefinition>>	oidCacheManual
protected List<org.hl7.fhir.r5.context.BaseWorkerContext.OIDSource>	oidSources
protected IWorkerContextManager.IPackageLoadingTracker	packageTracker
protected final TerminologyClientManager	terminologyClientManager
protected CanonicalResourceManager<StructureMap>	transforms
protected TerminologyCache	txCache
protected org.hl7.fhir.utilities.ToolingClientLogger	txLog
protected String	userAgent
protected Map<String,Map<String,ValidationResult>>	validationCache
protected String	version

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

KEY_DELIMITER, uncontainedKeys

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseWorkerContext()
protected	BaseWorkerContext(Locale locale)
protected	BaseWorkerContext(CanonicalResourceManager<CodeSystem> codeSystems, CanonicalResourceManager<ValueSet> valueSets, CanonicalResourceManager<ConceptMap> maps, CanonicalResourceManager<StructureDefinition> profiles, CanonicalResourceManager<ImplementationGuide> guides)

Method Summary

Modifier and Type	Method	Description
boolean	addDependentCodeSystem(ValueSetProcessBase.TerminologyOperationDetails opCtxt, TerminologyClientContext tc, Parameters pin, String sys, Resource src)
protected void	addServerValidationParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt, TerminologyClientContext terminologyClientContext, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options)
protected void	addServerValidationParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt, TerminologyClientContext terminologyClientContext, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options, Set<String> systems)
List<ImplementationGuide>	allImplementationGuides()
void	cacheResource(Resource r)	cache a resource for later retrieval using fetchResource.
void	cacheResourceFromPackage(Resource r, PackageInformation packageInfo)	cache a resource for later retrieval using fetchResource.
void	cacheVS(com.google.gson.JsonObject json, Map<String,ValidationResult> t)
void	clearTSCache(String url)
org.hl7.fhir.utilities.TimeTracker	clock()
protected Parameters	constructParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt, TerminologyClientContext tcd, ValueSet vs, boolean hierarchical)
protected Parameters	constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options, CodeableConcept codeableConcept)
protected Parameters	constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options, Coding coding)
protected Parameters	constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options, CodingValidationRequest codingValidationRequest)
protected ValueSetValidator	constructValueSetCheckerSimple(org.hl7.fhir.utilities.validation.ValidationOptions options, ValueSet vs)
protected ValueSetValidator	constructValueSetCheckerSimple(org.hl7.fhir.utilities.validation.ValidationOptions options, ValueSet vs, ValidationContextCarrier ctxt)
protected ValueSetExpander	constructValueSetExpanderSimple(org.hl7.fhir.utilities.validation.ValidationOptions options)
protected void	copy(BaseWorkerContext other)
int	countAllCaches()
void	dropResource(String fhirType, String id)
void	dropResource(Resource r)
ValueSetExpansionOutcome	expandVS(ExpansionOptions options, String url)	ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.
ValueSetExpansionOutcome	expandVS(ExpansionOptions options, ValueSet vs)	ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.
ValueSetExpansionOutcome	expandVS(ExpansionOptions options, ValueSet vs, Parameters pIn, boolean noLimits)
ValueSetExpansionOutcome	expandVS(Resource src, ElementDefinition.ElementDefinitionBindingComponent binding, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand, but resolves the binding first
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean hierarchical, boolean incompleteOk, Parameters pIn)
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical, int count)	ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.
ValueSetExpansionOutcome	expandVS(ValueSetProcessBase.TerminologyOperationDetails opCtxt, ValueSet.ConceptSetComponent inc, boolean hierarchical, boolean noInactive)
CodeSystem	fetchCodeSystem(String system)	Find the code system definition for the nominated system uri.
CodeSystem	fetchCodeSystem(String system, String version)
CodeSystem	fetchCodeSystem(String system, String version, Resource sourceOfReference)	Find the code system definition for the nominated system uri.
<T extends Resource> T	fetchResource(Class<T> class_, String uri)	Fetch (load if necessary) 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, String version, Resource sourceForReference)	Fetch (load if necessary) an identified resource.
Resource	fetchResourceById(String type, String uri)	Fetch (load if necessary) an identified resource.
Resource	fetchResourceById(String type, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> T	fetchResourceByVersionWithException(Class<T> class_, String uri, String version)
<T extends Resource> List<T>	fetchResourcesByType(Class<T> class_)	Fetch all the resources of a particular type. if class == (null | Resource | DomainResource | CanonicalResource) return everything Note: this forces every resource to be loaded; this might take a very long time.
<T extends Resource> List<T>	fetchResourcesByType(Class<T> class_, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> List<T>	fetchResourceVersions(Class<T> class_, String uri)	Fetch all the versions of a resource.
<T extends Resource> List<T>	fetchResourceVersionsByTypeAndUrl(Class<T> class_, String url)
<T extends Resource> T	fetchResourceWithException(Class<T> class_, String uri)	Fetch (load if necessary) an identified resource.
<T extends Resource> T	fetchResourceWithException(Class<T> class_, String uri, String version, Resource sourceForReference)	Fetch (load if necessary) an identified resource.
<T extends Resource> T	fetchResourceWithException(String cls, String uri)
<T extends Resource> T	fetchResourceWithExceptionByVersion(Class<T> class_, String uri, String version, Resource sourceForReference)
<T extends Resource> T	fetchResourceWithExceptionByVersion(String cls, String uri, String version, CanonicalResource source)
CodeSystem	fetchSupplementedCodeSystem(String system)	Like fetchCodeSystem, except that the context will find any CodeSysetm supplements and merge them into the definition that's returned
CodeSystem	fetchSupplementedCodeSystem(String system, String version, Resource sourceOfReference)	Like fetchCodeSystem, except that the context will find any CodeSysetm supplements and merge them into the definition that's returned
StructureDefinition	fetchTypeDefinition(String typeName)	This is a short cut for fetchResource(StructureDefinition.class, ...)
StructureDefinition	fetchTypeDefinition(String typeName, org.hl7.fhir.utilities.FhirPublication fhirVersion)
List<StructureDefinition>	fetchTypeDefinitions(String typeName)	This finds all the structure definitions that have the given typeName
<T extends Resource> T	findTxResource(Class<T> class_, String canonical)	this first does a fetch resource, and if nothing is found, looks in the terminology eco-system for a matching definition for the resource
<T extends Resource> T	findTxResource(Class<T> class_, String canonical, String version)
<T extends Resource> T	findTxResource(Class<T> class_, String canonical, String version, Resource sourceOfReference)	this first does a fetch resource, and if nothing is found, looks in the terminology eco-system for a matching definition for the resource
void	finishLoading(boolean genSnapshots)
void	fixOldSD(StructureDefinition sd)
byte[]	getBinaryForKey(String binaryKey)	Returns the binary for the key
Set<String>	getBinaryKeysAsSet()	Returns a set of keys that can be used to get binaries from this context.
String	getCacheId()
int	getClientRetryCount()
Set<String>	getCodeSystemsUsed()
ContextUtilities	getCutils()
int	getExpandCodesLimit()
Parameters	getExpansionParameters()	Returns a copy of the expansion parameters used by this context.
String	getLinkForUrl(String corePath, String url)
IWorkerContextManager.ICanonicalResourceLocator	getLocator()
ILoggingService	getLogger()
IWorkerContextManager	getManager()	if this returns null, the context is frozen (usually for threading concerns on the server) If you're considering not providing this service, the context can't load stuff on the fly so you need to take care to load everything in advance.
String	getName()
Map<String,NamingSystem>	getNSUrlMap()
PackageInformation	getPackageForUrl(String uri)	Note: take care with this method - there are multiple packages with the same canonical (different sub-packages, different versions)
IWorkerContextManager.IPackageLoadingTracker	getPackageTracker()
PEBuilder	getProfiledElementBuilder(PEBuilder.PEElementPropertiesPolicy elementProps, boolean fixedProps)
List<String>	getResourceNames(org.hl7.fhir.utilities.FhirPublication fhirVersion)
Set<String>	getResourceNamesAsSet()
Set<String>	getResourceNamesAsSet(org.hl7.fhir.utilities.FhirPublication fhirVersion)
SearchParameter	getSearchParameter(String code)
StructureDefinition	getStructure(String code)
List<String>	getSuppressedMappings()
TerminologyClientManager	getTxClientManager()
IWorkerContext.SystemSupportInformation	getTxSupportInfo(String system, String version)	return the System Support Information for the server that serves the specified code system
org.fhir.ucum.UcumService	getUcumService()
String	getUserAgent()
boolean	hasBinaryKey(String binaryKey)	Returns true if this worker context contains a binary for this key.
<T extends Resource> boolean	hasResource(Class<T> class_, String uri)	find whether a resource is available. the principal use of this method is to find whether a resource is known without actually loading it.
<T extends Resource> boolean	hasResource(Class<T> class_, String uri, String version, Resource sourceForReference)	find whether a resource is available. the principal use of this method is to find whether a resource is known without actually loading it.
<T extends Resource> boolean	hasResource(Class<T> class_, String uri, Resource sourceOfReference)
<T extends Resource> boolean	hasResource(String cls, String uri)
<T extends Resource> boolean	hasResourceVersion(Class<T> class_, String uri, String version)
<T extends Resource> boolean	hasResourceVersion(String cls, String uri, String version)
<T extends Resource> boolean	hasResourceVersion(String cls, String uri, String version, org.hl7.fhir.utilities.FhirPublication fhirVersion)
void	initTxCache(String cachePath)
void	initTxCache(TerminologyCache cache)
static boolean	isAllowedToIterateTerminologyResources()
boolean	isCachingAllowed()
boolean	isCanRunWithoutTerminology()
boolean	isDataType(String type)	return whether type is data type.
boolean	isForPublication()
boolean	isNoTerminologyServer()
boolean	isPrimitiveType(String type)	return whether type is primitive type.
boolean	isTlogging()
List<CodeSystem>	listCodeSystems()
List<ConceptMap>	listMaps()
List<StructureDefinition>	listStructures()
String	listSupportedSystems()
List<ValueSet>	listValueSets()
IOIDServices	oidServices()
Boolean	processSubsumesResult(Parameters pOut, String server)
ValidationResult	processValidationResult(Parameters pOut, String vs, String server)
void	registerResourceFromPackage(CanonicalResourceManager.CanonicalResourceProxy r, PackageInformation packageInfo)
void	reportStatus(com.google.gson.JsonObject json)
protected <T extends CanonicalResource> void	seeMetadataResource(T r, Map<String,T> map, List<T> list, boolean addId)
static void	setAllowedToIterateTerminologyResources(boolean allowedToIterateTerminologyResources)
void	setCachingAllowed(boolean cachingAllowed)
void	setCanRunWithoutTerminology(boolean canRunWithoutTerminology)
IWorkerContext	setClientRetryCount(int value)
void	setExpandCodesLimit(int expandCodesLimit)
void	setExpansionParameters(Parameters expansionParameters)	Get the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode
void	setForPublication(boolean value)
void	setLocale(Locale locale)	Sets the locale for this worker context.
void	setLocator(IWorkerContextManager.ICanonicalResourceLocator locator)
void	setLogger(ILoggingService logger)
void	setName(String name)
void	setNoTerminologyServer(boolean noTerminologyServer)
IWorkerContext	setPackageTracker(IWorkerContextManager.IPackageLoadingTracker packageTracker)
void	setSuppressedMappings(List<String> suppressedMappings)
void	setTlogging(boolean tlogging)
void	setUcumService(org.fhir.ucum.UcumService ucumService)
protected void	setUserAgent(String userAgent)
Boolean	subsumes(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg, Coding parent, Coding child)	ask the terminology system whether parent subsumes child.
protected String	tail(String url)
int	totalCount()
String	txCacheReport()
protected void	txLog(String msg)
void	unload()
IOIDServices.OIDSummary	urlsForOid(String oid, String resourceType)
IOIDServices.OIDSummary	urlsForOid(String oid, String resourceType, boolean retired)
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, String system, String version, String code, String display)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, String system, String version, String code, String display, ValueSet vs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, String path, Coding code, ValueSet vs)
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg, String path, Coding code, ValueSet vs, ValidationContextCarrier ctxt)
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, String code, ValueSet vs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, CodeableConcept code, ValueSet vs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, Coding code, ValueSet vs)	Validation of a code - consult the terminology infrstructure and/or service to see whether it is known.
ValidationResult	validateCode(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg, Coding code, ValueSet vs, ValidationContextCarrier ctxt)	See comments in ValidationContextCarrier.
void	validateCodeBatch(org.hl7.fhir.utilities.validation.ValidationOptions options, List<? extends CodingValidationRequest> codes, ValueSet vs, boolean passVS)	Batch validate code - reduce latency and do a bunch of codes in a single server call.
protected ValidationResult	validateOnServer(TerminologyClientContext tc, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options)
protected ValidationResult	validateOnServer2(TerminologyClientContext tc, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options, Set<String> systems)
OperationOutcome	validateTxResource(org.hl7.fhir.utilities.validation.ValidationOptions options, Resource resource)	Validate the actual terminology resource itself on the appropriate terminology server (used for ECL validation)

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

formatMessage, formatMessagePlural, getLocale, getMessages, getMessagesSourceFileName, getPluralKey, getPluralKeys, getPluralRules, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, logUncontainedMessage, messageKeyExistsForLocale, 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.r5.context.IWorkerContext

fetchResourceRaw, formatMessage, formatMessagePlural, getLocale, getPackage, getResourceNames, getSpecUrl, getVersion, hasPackage, hasPackage, newValidator

Methods inherited from interface org.hl7.fhir.r5.context.IWorkerContextManager

cachePackage, loadFromPackage, loadFromPackageAndDependencies, loadPackage, loadPackage, packageManager, setPackageManager

Field Details

version

protected String version

transforms

protected CanonicalResourceManager<StructureMap> transforms

binaries

protected Map<String,BaseWorkerContext.IByteProvider> binaries

oidCacheManual

protected Map<String,Set<IOIDServices.OIDDefinition>> oidCacheManual

oidSources

protected List<org.hl7.fhir.r5.context.BaseWorkerContext.OIDSource> oidSources

validationCache

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

name

protected String name

txLog

protected org.hl7.fhir.utilities.ToolingClientLogger txLog

canRunWithoutTerminology

protected boolean canRunWithoutTerminology

noTerminologyServer

protected boolean noTerminologyServer

logger

protected ILoggingService logger

terminologyClientManager

protected final TerminologyClientManager terminologyClientManager

expansionParameters

protected AtomicReference<Parameters> expansionParameters

txCache

protected TerminologyCache txCache

clock

protected org.hl7.fhir.utilities.TimeTracker clock

userAgent

protected String userAgent

cutils

protected ContextUtilities cutils

packageTracker

protected IWorkerContextManager.IPackageLoadingTracker packageTracker

Constructor Details

BaseWorkerContext

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

Throws:

FileNotFoundException

IOException

org.hl7.fhir.exceptions.FHIRException

BaseWorkerContext

protected BaseWorkerContext(Locale locale)
                     throws FileNotFoundException,
IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

FileNotFoundException

IOException

org.hl7.fhir.exceptions.FHIRException

BaseWorkerContext

protected BaseWorkerContext(CanonicalResourceManager<CodeSystem> codeSystems,
 CanonicalResourceManager<ValueSet> valueSets,
 CanonicalResourceManager<ConceptMap> maps,
 CanonicalResourceManager<StructureDefinition> profiles,
 CanonicalResourceManager<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: IWorkerContextManager

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. If the resource is loaded out of a package, call cacheResourceFromPackage instead

Specified by:

cacheResource in interface IWorkerContextManager

Parameters:

r -

Throws:

org.hl7.fhir.exceptions.FHIRException

registerResourceFromPackage

public void registerResourceFromPackage(CanonicalResourceManager.CanonicalResourceProxy r,
 PackageInformation packageInfo)
                                 throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

cacheResourceFromPackage

public void cacheResourceFromPackage(Resource r,
 PackageInformation packageInfo)
                              throws org.hl7.fhir.exceptions.FHIRException

Description copied from interface: IWorkerContextManager

cache a resource for later retrieval using fetchResource. The package information is used to help manage the cache internally, and to help with reference resolution. Packages should be define using cachePackage (but don't have to be) Note that various context implementations will have their own ways of loading rseources, and not all need implement cacheResource

Specified by:

cacheResourceFromPackage in interface IWorkerContextManager

Parameters:

r -

Throws:

org.hl7.fhir.exceptions.FHIRException

getNSUrlMap

public Map<String,NamingSystem> getNSUrlMap()

Specified by:

getNSUrlMap in interface IWorkerContext

fixOldSD

public void fixOldSD(StructureDefinition sd)

seeMetadataResource

protected <T extends CanonicalResource> void seeMetadataResource(T r,
 Map<String,T> map,
 List<T> list,
 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) This is a short cut for fetchResource(CodeSystem.class, system)

Specified by:

fetchCodeSystem in interface IWorkerContext

Parameters:

system -

Returns:

fetchCodeSystem

public CodeSystem fetchCodeSystem(String system,
 String version)

fetchCodeSystem

public CodeSystem fetchCodeSystem(String system,
 String version,
 Resource sourceOfReference)

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) This is a short cut for fetchResource(CodeSystem.class, system, version, sourceOfReference)

Specified by:

fetchCodeSystem in interface IWorkerContext

fetchSupplementedCodeSystem

public CodeSystem fetchSupplementedCodeSystem(String system)

Description copied from interface: IWorkerContext

Like fetchCodeSystem, except that the context will find any CodeSysetm supplements and merge them into the definition that's returned

Specified by:

fetchSupplementedCodeSystem in interface IWorkerContext

fetchSupplementedCodeSystem

public CodeSystem fetchSupplementedCodeSystem(String system,
 String version,
 Resource sourceOfReference)

Description copied from interface: IWorkerContext

Like fetchCodeSystem, except that the context will find any CodeSysetm supplements and merge them into the definition that's returned

Specified by:

fetchSupplementedCodeSystem in interface IWorkerContext

getTxSupportInfo

public IWorkerContext.SystemSupportInformation getTxSupportInfo(String system,
 String version)
                                                         throws org.hl7.fhir.exceptions.TerminologyServiceException

Description copied from interface: IWorkerContext

return the System Support Information for the server that serves the specified code system

Specified by:

getTxSupportInfo in interface IWorkerContext

Parameters:

system -

version -

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

txLog

protected void txLog(String msg)

getExpandCodesLimit

public int getExpandCodesLimit()

setExpandCodesLimit

public void setExpandCodesLimit(int expandCodesLimit)

expandVS

public ValueSetExpansionOutcome expandVS(Resource src,
 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

Parameters:

src -

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

expandVS

public ValueSetExpansionOutcome expandVS(ValueSetProcessBase.TerminologyOperationDetails opCtxt,
 ValueSet.ConceptSetComponent inc,
 boolean hierarchical,
 boolean noInactive)
                                  throws org.hl7.fhir.exceptions.TerminologyServiceException

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

expandVS

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

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.

Specified by:

expandVS in interface IWorkerContext

Parameters:

vs - - the valueset to expand

cacheOk - - whether to look in the cache for an expansion

heirarchical - - whether to accept a heirarchical expansion

Returns:

the expansion, or information about how the expansion failed

expandVS

public ValueSetExpansionOutcome expandVS(ValueSet vs,
 boolean cacheOk,
 boolean heirarchical,
 int count)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.

Specified by:

expandVS in interface IWorkerContext

Parameters:

vs - - the valueset to expand

cacheOk - - whether to look in the cache for an expansion

heirarchical - - whether to accept a heirarchical expansion

count - - maximum concepts to return

Returns:

the expansion, or information about how the expansion failed

expandVS

public ValueSetExpansionOutcome expandVS(ExpansionOptions options,
 String url)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care. This isn't quite the same as findTxResource+expand because if the uri can't be resolved, it'll be passed to the terminology service directly, and some terminology servers will expand value sets that they won't return.

Specified by:

expandVS in interface IWorkerContext

Parameters:

options - - controls the expansion process (overrides expansion parameters)

url - - valueset uri.

Returns:

the expansion, or information about how the expansion failed

expandVS

public ValueSetExpansionOutcome expandVS(ValueSet vs,
 boolean cacheOk,
 boolean hierarchical,
 boolean incompleteOk,
 Parameters pIn)

expandVS

public ValueSetExpansionOutcome expandVS(ExpansionOptions options,
 ValueSet vs)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand Note that caching makes a real performance difference, so turn it off with care.

Specified by:

expandVS in interface IWorkerContext

Parameters:

options - - controls the expansion process (overrides expansion parameters)

vs - - the valueset to expand

Returns:

the expansion, or information about how the expansion failed

expandVS

public ValueSetExpansionOutcome expandVS(ExpansionOptions options,
 ValueSet vs,
 Parameters pIn,
 boolean noLimits)

validateCode

public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options,
 String system,
 String version,
 String code,
 String display)

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or service to see whether it is known. If known, return a description of it corresponds to 2 terminology service calls: $validate-code and $lookup

Specified by:

validateCode in interface IWorkerContext

Parameters:

options - - validation options (required)

system - - equals Coding.system (required)

code - - equals Coding.code (required)

display - - equals Coding.display (optional)

Returns:

validateCode

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

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or 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

Specified by:

validateCode in interface IWorkerContext

Parameters:

options - - validation options (required)

system - - equals Coding.system (required)

code - - equals Coding.code (required)

display - - equals Coding.display (optional)

vs - the applicable valueset (optional)

Returns:

validateCode

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

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or 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 in this case, the system will be inferred from the value set. It's an error to call this one without the value set

Specified by:

validateCode in interface IWorkerContext

Parameters:

options - - validation options (required)

code - The code to validate (required)

vs - the applicable valueset (required)

Returns:

validateCodeBatch

public void validateCodeBatch(org.hl7.fhir.utilities.validation.ValidationOptions options,
 List<? extends CodingValidationRequest> codes,
 ValueSet vs,
 boolean passVS)

Description copied from interface: IWorkerContext

Batch validate code - reduce latency and do a bunch of codes in a single server call. Each is the same as a validateCode

Specified by:

validateCodeBatch in interface IWorkerContext

Parameters:

options -

codes -

vs -

validateCode

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

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or 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

Specified by:

validateCode in interface IWorkerContext

Parameters:

options - - validation options (required)

code - - Coding to validate

vs - the applicable valueset (optional)

Returns:

validateCode

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

validateCode

public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg,
 Coding code,
 ValueSet vs,
 ValidationContextCarrier ctxt)

Description copied from interface: IWorkerContext

See comments in ValidationContextCarrier. This is called when there might be additional value sets etc available in the context, but we don't want to pre-process them.

Specified by:

validateCode in interface IWorkerContext

Parameters:

optionsArg -

code -

vs -

ctxt -

Returns:

validateCode

public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg,
 String path,
 Coding code,
 ValueSet vs,
 ValidationContextCarrier ctxt)

subsumes

public Boolean subsumes(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg,
 Coding parent,
 Coding child)

ask the terminology system whether parent subsumes child.

Specified by:

subsumes in interface IWorkerContext

Returns:

true if it does, false if it doesn't, and null if it's not know whether it does

processSubsumesResult

public Boolean processSubsumesResult(Parameters pOut,
 String server)

constructValueSetExpanderSimple

protected ValueSetExpander constructValueSetExpanderSimple(org.hl7.fhir.utilities.validation.ValidationOptions options)

constructValueSetCheckerSimple

protected ValueSetValidator constructValueSetCheckerSimple(org.hl7.fhir.utilities.validation.ValidationOptions options,
 ValueSet vs,
 ValidationContextCarrier ctxt)

constructValueSetCheckerSimple

protected ValueSetValidator constructValueSetCheckerSimple(org.hl7.fhir.utilities.validation.ValidationOptions options,
 ValueSet vs)

constructParameters

protected Parameters constructParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt,
 TerminologyClientContext tcd,
 ValueSet vs,
 boolean hierarchical)

constructParameters

protected Parameters constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options,
 Coding coding)

constructParameters

protected Parameters constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options,
 CodeableConcept codeableConcept)

constructParameters

protected Parameters constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options,
 CodingValidationRequest codingValidationRequest)

validateCode

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

Description copied from interface: IWorkerContext

Validation of a code - consult the terminology infrstructure and/or 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 Note that this doesn't validate binding strength (e.g. is just text allowed?)

Specified by:

validateCode in interface IWorkerContext

Parameters:

options - - validation options (required)

code - - CodeableConcept to validate

vs - the applicable valueset (optional)

Returns:

validateOnServer

protected ValidationResult validateOnServer(TerminologyClientContext tc,
 ValueSet vs,
 Parameters pin,
 org.hl7.fhir.utilities.validation.ValidationOptions options)
                                     throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

validateOnServer2

protected ValidationResult validateOnServer2(TerminologyClientContext tc,
 ValueSet vs,
 Parameters pin,
 org.hl7.fhir.utilities.validation.ValidationOptions options,
 Set<String> systems)
                                      throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

addServerValidationParameters

protected void addServerValidationParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt,
 TerminologyClientContext terminologyClientContext,
 ValueSet vs,
 Parameters pin,
 org.hl7.fhir.utilities.validation.ValidationOptions options)

addServerValidationParameters

protected void addServerValidationParameters(ValueSetProcessBase.TerminologyOperationDetails opCtxt,
 TerminologyClientContext terminologyClientContext,
 ValueSet vs,
 Parameters pin,
 org.hl7.fhir.utilities.validation.ValidationOptions options,
 Set<String> systems)

addDependentCodeSystem

public boolean addDependentCodeSystem(ValueSetProcessBase.TerminologyOperationDetails opCtxt,
 TerminologyClientContext tc,
 Parameters pin,
 String sys,
 Resource src)

processValidationResult

public ValidationResult processValidationResult(Parameters pOut,
 String vs,
 String server)

initTxCache

public void initTxCache(String cachePath)
                 throws FileNotFoundException,
org.hl7.fhir.exceptions.FHIRException,
IOException

Throws:

FileNotFoundException

org.hl7.fhir.exceptions.FHIRException

IOException

initTxCache

public void initTxCache(TerminologyCache cache)

clearTSCache

public void clearTSCache(String url)
                  throws Exception

Throws:

Exception

isCanRunWithoutTerminology

public boolean isCanRunWithoutTerminology()

setCanRunWithoutTerminology

public void setCanRunWithoutTerminology(boolean canRunWithoutTerminology)

setLogger

public void setLogger(@Nonnull
 ILoggingService logger)

getExpansionParameters

public Parameters getExpansionParameters()

Returns a copy of the expansion parameters used by this context. Note that because the return value is a copy, any changes done to it will not be reflected in the context and any changes to the context will likewise not be reflected in the return value after it is returned. If you need to change the expansion parameters, use setExpansionParameters(Parameters).

Specified by:

getExpansionParameters in interface IWorkerContext

Returns:

a copy of the expansion parameters

setExpansionParameters

public void setExpansionParameters(Parameters expansionParameters)

Description copied from interface: IWorkerContextManager

Get the expansion parameters passed through the terminology server when txServer calls are made Note that the Validation Options override these when they are specified on validateCode

Specified by:

setExpansionParameters in interface IWorkerContextManager

isNoTerminologyServer

public boolean isNoTerminologyServer()

Specified by:

isNoTerminologyServer in interface IWorkerContext

Returns:

true if there is a terminology server supporting the context

setNoTerminologyServer

public void setNoTerminologyServer(boolean noTerminologyServer)

getName

public String getName()

setName

public void setName(String name)

getResourceNames

public List<String> getResourceNames(org.hl7.fhir.utilities.FhirPublication fhirVersion)

getResourceNamesAsSet

public Set<String> getResourceNamesAsSet(org.hl7.fhir.utilities.FhirPublication fhirVersion)

getResourceNamesAsSet

public Set<String> getResourceNamesAsSet()

Specified by:

getResourceNamesAsSet in interface IWorkerContext

Returns:

a set of the resource names defined for this version

fetchResourceWithException

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

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResourceWithException in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

the resource if known (or an exception will be thrown)

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceWithException

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

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceByVersionWithException

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

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceWithException

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

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResourceWithException in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

version - the version. Don't provide both a version and a |version suffix

sourceForReference - where the reference was found (if the reference is in a resource)

Returns:

if the resource is known. Will throw an exception if the resource is not known

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceWithExceptionByVersion

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

Throws:

org.hl7.fhir.exceptions.FHIRException

getPackageForUrl

public PackageInformation getPackageForUrl(String uri)

Description copied from interface: IWorkerContext

Note: take care with this method - there are multiple packages with the same canonical (different sub-packages, different versions)

Specified by:

getPackageForUrl in interface IWorkerContext

Parameters:

uri - - canonical URL

Returns:

- package information for the most recent package with the given canonical

fetchResourceWithExceptionByVersion

public <T extends Resource> T fetchResourceWithExceptionByVersion(String cls,
 String uri,
 String version,
 CanonicalResource source)
                                                           throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourcesByType

public <T extends Resource> List<T> fetchResourcesByType(Class<T> class_,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

fetchResourcesByType

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

Description copied from interface: IWorkerContext

Fetch all the resources of a particular type. if class == (null | Resource | DomainResource | CanonicalResource) return everything Note: this forces every resource to be loaded; this might take a very long time. Some implementations require some flag to be set elsewhere to allow this method to be called for some types to prevent the method from accidentally being called (ValueSets can take minutes to load, since there are so many in scope)

Specified by:

fetchResourcesByType in interface IWorkerContext

Parameters:

class_ - the type of resource to load

Returns:

all the resources

fetchResourceVersionsByTypeAndUrl

public <T extends Resource> List<T> fetchResourceVersionsByTypeAndUrl(Class<T> class_,
 String url)

fetchResourceById

public Resource fetchResourceById(String type,
 String uri,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

fetchResourceById

public Resource fetchResourceById(String type,
 String uri)

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. This is the non-generic version, but the functionality is otherwise the same 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResourceById in interface IWorkerContext

Parameters:

type - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

the resource if known (or null)

fetchResource

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

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResource in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

version - the version. Don't provide both a version and a |version suffix

sourceForReference - where the reference was found (if the reference is in a resource)

Returns:

if the resource is known

fetchResource

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

Description copied from interface: IWorkerContext

Fetch (load if necessary) an identified resource. The most common use of this is to access the standard conformance resources that are part of the standard - structure definitions, value sets, concept maps, etc. 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResource in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

the resource if known (or null)

fetchResource

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

hasResource

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

Description copied from interface: IWorkerContext

find whether a resource is available. the principal use of this method is to find whether a resource is known without actually loading it.

Specified by:

hasResource in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

Returns:

if the resource is known

hasResource

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

hasResourceVersion

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

hasResourceVersion

public <T extends Resource> boolean hasResourceVersion(String cls,
 String uri,
 String version)

hasResource

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

Description copied from interface: IWorkerContext

find whether a resource is available. the principal use of this method is to find whether a resource is known without actually loading it.

Specified by:

hasResource in interface IWorkerContext

Parameters:

class_ - the type of resource

uri - the URL of the resource, optionally with a |version suffix

version - the version. Don't provide both a version and a |version suffix

sourceForReference - where the reference was found (if the reference is in a resource)

Returns:

if the resource is known

hasResourceVersion

public <T extends Resource> boolean hasResourceVersion(String cls,
 String uri,
 String version,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

hasResource

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

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)

listSupportedSystems

public String listSupportedSystems()

totalCount

public int totalCount()

listMaps

public List<ConceptMap> listMaps()

listStructures

public List<StructureDefinition> listStructures()

listValueSets

public List<ValueSet> listValueSets()

listCodeSystems

public List<CodeSystem> listCodeSystems()

getStructure

public StructureDefinition getStructure(String code)

cacheVS

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

getSearchParameter

public SearchParameter getSearchParameter(String code)

getLogger

public ILoggingService getLogger()

Specified by:

getLogger in interface IWorkerContext

Returns:

the logging service configured for the context

fetchTypeDefinition

public StructureDefinition fetchTypeDefinition(String typeName,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

fetchTypeDefinition

public StructureDefinition fetchTypeDefinition(String typeName)

Description copied from interface: IWorkerContext

This is a short cut for fetchResource(StructureDefinition.class, ...) but it accepts a typename - that is, it resolves based on StructureDefinition.type or StructureDefinition.url. This only resolves to http://hl7.org/fhir/StructureDefinition/{typename}

Specified by:

fetchTypeDefinition in interface IWorkerContext

Parameters:

typeName -

Returns:

type (or exception if there is multiple candidates

fetchTypeDefinitions

public List<StructureDefinition> fetchTypeDefinitions(String typeName)

Description copied from interface: IWorkerContext

This finds all the structure definitions that have the given typeName

Specified by:

fetchTypeDefinitions in interface IWorkerContext

Parameters:

typeName -

Returns:

isPrimitiveType

public boolean isPrimitiveType(String type)

Description copied from interface: IWorkerContext

return whether type is primitive type. This is called a lot, and needs a high performance implementation

Specified by:

isPrimitiveType in interface IWorkerContext

Parameters:

type -

Returns:

isDataType

public boolean isDataType(String type)

Description copied from interface: IWorkerContext

return whether type is data type. This is called a lot, and needs a high performance implementation

Specified by:

isDataType in interface IWorkerContext

Parameters:

type -

Returns:

isTlogging

public boolean isTlogging()

setTlogging

public void setTlogging(boolean tlogging)

getUcumService

public org.fhir.ucum.UcumService getUcumService()

Specified by:

getUcumService in interface IWorkerContext

Returns:

Get the UCUM service that provides access to units of measure reasoning services (if available)

setUcumService

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

getLinkForUrl

public String getLinkForUrl(String corePath,
 String url)

allImplementationGuides

public List<ImplementationGuide> allImplementationGuides()

getBinaryKeysAsSet

public Set<String> getBinaryKeysAsSet()

Description copied from interface: IWorkerContext

Returns a set of keys that can be used to get binaries from this context. In general, the binaries come from the loaded packages (mostly the pubpack)

Specified by:

getBinaryKeysAsSet in interface IWorkerContext

Returns:

a set of binaries or null

hasBinaryKey

public boolean hasBinaryKey(String binaryKey)

Description copied from interface: IWorkerContext

Returns true if this worker context contains a binary for this key.

Specified by:

hasBinaryKey in interface IWorkerContext

Parameters:

binaryKey -

Returns:

true if binary is available for this key

getBinaryForKey

public byte[] getBinaryForKey(String binaryKey)

Description copied from interface: IWorkerContext

Returns the binary for the key

Specified by:

getBinaryForKey in interface IWorkerContext

Parameters:

binaryKey -

Returns:

finishLoading

public void finishLoading(boolean genSnapshots)

tail

protected String tail(String url)

getClientRetryCount

public int getClientRetryCount()

Specified by:

getClientRetryCount in interface IWorkerContext

setClientRetryCount

public IWorkerContext setClientRetryCount(int value)

Specified by:

setClientRetryCount in interface IWorkerContext

getTxClientManager

public TerminologyClientManager getTxClientManager()

getCacheId

public String getCacheId()

clock

public org.hl7.fhir.utilities.TimeTracker clock()

Specified by:

clock in interface IWorkerContext

Returns:

time tracker for when the context is being loaded (0 = start of loading)

countAllCaches

public int countAllCaches()

getCodeSystemsUsed

public Set<String> getCodeSystemsUsed()

Specified by:

getCodeSystemsUsed in interface IWorkerContext

Returns:

a list of all the code systems used by the functions above

getLocator

public IWorkerContextManager.ICanonicalResourceLocator getLocator()

setLocator

public void setLocator(IWorkerContextManager.ICanonicalResourceLocator locator)

getUserAgent

public String getUserAgent()

setUserAgent

protected void setUserAgent(String userAgent)

getPackageTracker

public IWorkerContextManager.IPackageLoadingTracker getPackageTracker()

Specified by:

getPackageTracker in interface IWorkerContext

setPackageTracker

public IWorkerContext setPackageTracker(IWorkerContextManager.IPackageLoadingTracker packageTracker)

Specified by:

setPackageTracker in interface IWorkerContext

getProfiledElementBuilder

public PEBuilder getProfiledElementBuilder(PEBuilder.PEElementPropertiesPolicy elementProps,
 boolean fixedProps)

Specified by:

getProfiledElementBuilder in interface IWorkerContext

isForPublication

public boolean isForPublication()

Specified by:

isForPublication in interface IWorkerContext

setForPublication

public void setForPublication(boolean value)

Specified by:

setForPublication in interface IWorkerContext

isCachingAllowed

public boolean isCachingAllowed()

setCachingAllowed

public void setCachingAllowed(boolean cachingAllowed)

urlsForOid

public IOIDServices.OIDSummary urlsForOid(String oid,
 String resourceType)

Specified by:

urlsForOid in interface IOIDServices

urlsForOid

public IOIDServices.OIDSummary urlsForOid(String oid,
 String resourceType,
 boolean retired)

unload

public void unload()

findTxResource

public <T extends Resource> T findTxResource(Class<T> class_,
 String canonical,
 String version,
 Resource sourceOfReference)

Description copied from interface: IWorkerContext

this first does a fetch resource, and if nothing is found, looks in the terminology eco-system for a matching definition for the resource

Specified by:

findTxResource in interface IWorkerContext

findTxResource

public <T extends Resource> T findTxResource(Class<T> class_,
 String canonical)

Description copied from interface: IWorkerContext

this first does a fetch resource, and if nothing is found, looks in the terminology eco-system for a matching definition for the resource

Specified by:

findTxResource in interface IWorkerContext

findTxResource

public <T extends Resource> T findTxResource(Class<T> class_,
 String canonical,
 String version)

fetchResourceVersions

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

Description copied from interface: IWorkerContext

Fetch all the versions of a resource.

Specified by:

fetchResourceVersions in interface IWorkerContext

Parameters:

class_ - the type of resource to load

Returns:

all the resources

setLocale

public void setLocale(Locale locale)

Description copied from interface: IWorkerContextManager

Sets the locale for this worker context.

Specified by:

setLocale in interface IWorkerContextManager

Overrides:

setLocale in class org.hl7.fhir.utilities.i18n.I18nBase

Parameters:

locale - The locale to use.

validateTxResource

public OperationOutcome validateTxResource(org.hl7.fhir.utilities.validation.ValidationOptions options,
 Resource resource)

Description copied from interface: IWorkerContext

Validate the actual terminology resource itself on the appropriate terminology server (used for ECL validation)

Specified by:

validateTxResource in interface IWorkerContext

Parameters:

options -

resource -

Returns:

getSuppressedMappings

public List<String> getSuppressedMappings()

setSuppressedMappings

public void setSuppressedMappings(List<String> suppressedMappings)

getCutils

public ContextUtilities getCutils()

txCacheReport

public String txCacheReport()

isAllowedToIterateTerminologyResources

public static boolean isAllowedToIterateTerminologyResources()

setAllowedToIterateTerminologyResources

public static void setAllowedToIterateTerminologyResources(boolean allowedToIterateTerminologyResources)

oidServices

public IOIDServices oidServices()

Specified by:

oidServices in interface IWorkerContext

Returns:

a handle to provide information about OIDs known to the context (if available)

getManager

public IWorkerContextManager getManager()

Description copied from interface: IWorkerContext

if this returns null, the context is frozen (usually for threading concerns on the server) If you're considering not providing this service, the context can't load stuff on the fly so you need to take care to load everything in advance. In particular, pay attention to cross-version packages Also, beware of the impact of lazy-loading on thread safety

Specified by:

getManager in interface IWorkerContext

Returns:

the manager that can be used to load / unload content from the context