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:

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.MetadataResourceVersionComparator<T extends CanonicalResource>
static class	BaseWorkerContext.ResourceProxy

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

IWorkerContext.ILoggingService, IWorkerContext.OIDDefinition, IWorkerContext.OIDDefinitionComparer, IWorkerContext.OIDSummary

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,byte[]>	binaries
protected boolean	canRunWithoutTerminology
protected org.hl7.fhir.utilities.TimeTracker	clock
protected Parameters	expParameters
protected ILoggingService	logger
protected String	name
protected boolean	noTerminologyServer
protected Map<String,Set<IWorkerContext.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, locale, PLURAL_SUFFIX

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
protected void	addServerValidationParameters(TerminologyClientContext terminologyClientContext, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options)
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(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, String vsUrl)
protected Parameters	constructParameters(org.hl7.fhir.utilities.validation.ValidationOptions options, CodingValidationRequest codingValidationRequest, ValueSet valueSet)
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(Resource src, ElementDefinition.ElementDefinitionBindingComponent binding, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand, but resolves the binding first
ValueSetExpansionOutcome	expandVS(ValueSet.ConceptSetComponent inc, boolean hierarchical, boolean noInactive)	Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical)	ValueSet Expansion - see $expand
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean heirarchical, boolean incompleteOk)	ValueSet Expansion - see $expand
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean hierarchical, boolean incompleteOk, Parameters pIn)
ValueSetExpansionOutcome	expandVS(ValueSet vs, boolean cacheOk, boolean hierarchical, boolean incompleteOk, Parameters pIn, boolean noLimits)
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, org.hl7.fhir.utilities.FhirPublication fhirVersion)
CodeSystem	fetchCodeSystem(String system, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<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, String version, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> T	fetchResource(Class<T> class_, String uri, Resource sourceForReference)	has the same functionality as fetchResource, but passes in information about the source of the reference (this may affect resolution of version)
<T extends Resource> T	fetchResource(Class<T> class_, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
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.
Resource	fetchResourceById(String type, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> List<T>	fetchResourcesByType(Class<T> class_)
<T extends Resource> List<T>	fetchResourcesByType(Class<T> class_, org.hl7.fhir.utilities.FhirPublication fhirVersion)	Fetch all the resources of a particular type.
<T extends Resource> List<T>	fetchResourcesByUrl(Class<T> class_, String uri)	Fetch all the resources for the given URL - all matching versions
<T extends Resource> T	fetchResourceWithException(Class<T> class_, String uri)
<T extends Resource> T	fetchResourceWithException(Class<T> class_, String uri, Resource sourceForReference)
<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
CodeSystem	fetchSupplementedCodeSystem(String system, String version)
CodeSystem	fetchSupplementedCodeSystem(String system, String version, org.hl7.fhir.utilities.FhirPublication fhirVersion)
CodeSystem	fetchSupplementedCodeSystem(String system, org.hl7.fhir.utilities.FhirPublication fhirVersion)
StructureDefinition	fetchTypeDefinition(String typeName)	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.
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
List<StructureDefinition>	fetchTypeDefinitions(String typeName, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> T	findTxResource(Class<T> class_, String canonical)
<T extends Resource> T	findTxResource(Class<T> class_, String canonical, String version)
<T extends Resource> T	findTxResource(Class<T> class_, String canonical, 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 usually used (and so far only tested with) ValueSet.class
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()
int	getExpandCodesLimit()
Parameters	getExpansionParameters()	Set 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
String	getLinkForUrl(String corePath, String url)
IWorkerContextManager.ICanonicalResourceLocator	getLocator()
ILoggingService	getLogger()
String	getName()
Map<String,NamingSystem>	getNSUrlMap()
PackageInformation	getPackageForUrl(String uri)
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)
TerminologyClientManager	getTxClientManager()
org.fhir.ucum.UcumService	getUcumService()	Get the UCUM service that provides access to units of measure reasoning services This service might not be available
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.
<T extends Resource> boolean	hasResource(Class<T> class_, String uri, Resource sourceOfReference)
<T extends Resource> boolean	hasResource(Class<T> class_, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> boolean	hasResource(String cls, String uri)
<T extends Resource> boolean	hasResource(String cls, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<T extends Resource> boolean	hasResourceVersion(Class<T> class_, String uri, String version)
<T extends Resource> boolean	hasResourceVersion(Class<T> class_, String uri, String version, org.hl7.fhir.utilities.FhirPublication fhirVersion)
<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)
boolean	isAllowLoadingDuplicates()
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	isServerSideSystem(String url)
boolean	isTlogging()
List<ConceptMap>	listMaps()
List<StructureDefinition>	listStructures()
String	listSupportedSystems()
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)
void	setAllowLoadingDuplicates(boolean allowLoadingDuplicates)
void	setCachingAllowed(boolean cachingAllowed)
void	setCanRunWithoutTerminology(boolean canRunWithoutTerminology)
IWorkerContext	setClientRetryCount(int value)
void	setExpandCodesLimit(int expandCodesLimit)
void	setExpansionParameters(Parameters expParameters)	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	setLocator(IWorkerContextManager.ICanonicalResourceLocator locator)
void	setLogger(ILoggingService logger)
void	setName(String name)
void	setNoTerminologyServer(boolean noTerminologyServer)
IWorkerContext	setPackageTracker(IWorkerContextManager.IPackageLoadingTracker packageTracker)
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.
boolean	supportsSystem(String system)	True if the underlying terminology service provider will do expansion and code validation for the terminology.
boolean	supportsSystem(String system, org.hl7.fhir.utilities.FhirPublication fhirVersion)
protected String	tail(String url)
int	totalCount()
protected void	txLog(String msg)
void	unload()
IWorkerContext.OIDSummary	urlsForOid(String oid, String resourceType)
IWorkerContext.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)	Batch validate code - reduce latency and do a bunch of codes in a single server call.
void	validateCodeBatchByRef(org.hl7.fhir.utilities.validation.ValidationOptions options, List<? extends CodingValidationRequest> codes, String vsUrl)
protected ValidationResult	validateOnServer(TerminologyClientContext tc, ValueSet vs, Parameters pin, org.hl7.fhir.utilities.validation.ValidationOptions options)

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

formatMessage, formatMessagePlural, getLocale, getMessagesSourceFileName, getPluralKey, getPluralKeys, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, messageKeyExistsForLocale, setLocale, setPluralRules, 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

cachePackage, fetchResourceRaw, formatMessage, formatMessagePlural, getLocale, getPackage, getResourceNames, getSpecUrl, getVersion, hasPackage, hasPackage, loadFromPackage, loadFromPackage, loadFromPackageAndDependencies, newValidator, setLocale, setValidationMessageLanguage

Field Details

version

protected String version

terminologyClientManager

protected final TerminologyClientManager terminologyClientManager

transforms

protected CanonicalResourceManager<StructureMap> transforms

binaries

protected Map<String,byte[]> binaries

oidCacheManual

protected Map<String,Set<IWorkerContext.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

expParameters

protected Parameters expParameters

txCache

protected TerminologyCache txCache

clock

protected org.hl7.fhir.utilities.TimeTracker clock

userAgent

protected String userAgent

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

Specified by:

cacheResource in interface IWorkerContext

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: IWorkerContext

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 IWorkerContext

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,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchCodeSystem in interface IWorkerContext

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...)

Specified by:

fetchCodeSystem in interface IWorkerContext

Parameters:

system -

Returns:

fetchCodeSystem

public CodeSystem fetchCodeSystem(String system,
 String version,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchCodeSystem in interface IWorkerContext

fetchCodeSystem

public CodeSystem fetchCodeSystem(String system,
 String version)

Specified by:

fetchCodeSystem in interface IWorkerContext

fetchSupplementedCodeSystem

public CodeSystem fetchSupplementedCodeSystem(String system,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchSupplementedCodeSystem in interface IWorkerContext

fetchSupplementedCodeSystem

public CodeSystem fetchSupplementedCodeSystem(String system,
 String version,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchSupplementedCodeSystem 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

Specified by:

fetchSupplementedCodeSystem in interface IWorkerContext

Parameters:

system -

Returns:

fetchSupplementedCodeSystem

public CodeSystem fetchSupplementedCodeSystem(String system,
 String version)

Specified by:

fetchSupplementedCodeSystem in interface IWorkerContext

supportsSystem

public boolean supportsSystem(String system,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)
                       throws org.hl7.fhir.exceptions.TerminologyServiceException

Specified by:

supportsSystem in interface IWorkerContext

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

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 Not that not all supported code systems have an available CodeSystem resource

Specified by:

supportsSystem in interface IWorkerContext

Parameters:

system -

Returns:

Throws:

org.hl7.fhir.exceptions.TerminologyServiceException

isServerSideSystem

public boolean isServerSideSystem(String url)

Specified by:

isServerSideSystem in interface IWorkerContext

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

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

expandVS

public ValueSetExpansionOutcome expandVS(ValueSet.ConceptSetComponent inc,
 boolean hierarchical,
 boolean noInactive)
                                  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 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 ValueSetExpansionOutcome expandVS(ValueSet vs,
 boolean cacheOk,
 boolean heirarchical,
 boolean incompleteOk)

Description copied from interface: IWorkerContext

ValueSet Expansion - see $expand

Specified by:

expandVS in interface IWorkerContext

Parameters:

vs -

Returns:

expandVS

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

expandVS

public ValueSetExpansionOutcome expandVS(ValueSet vs,
 boolean cacheOk,
 boolean hierarchical,
 boolean incompleteOk,
 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 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:

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 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)

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 corresponds to 2 terminology service calls: $validate-code and $lookup 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 - he 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)

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 -

validateCodeBatchByRef

public void validateCodeBatchByRef(org.hl7.fhir.utilities.validation.ValidationOptions options,
 List<? extends CodingValidationRequest> codes,
 String vsUrl)

Specified by:

validateCodeBatchByRef in interface IWorkerContext

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 corresponds to 2 terminology service calls: $validate-code and $lookup 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 - - 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(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,
 ValueSet valueSet)

constructParameters

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

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 corresponds to 2 terminology service calls: $validate-code and $lookup 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

addServerValidationParameters

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

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)

Specified by:

setLogger in interface IWorkerContext

getExpansionParameters

public Parameters getExpansionParameters()

Description copied from interface: IWorkerContext

Set 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:

getExpansionParameters in interface IWorkerContext

setExpansionParameters

public void setExpansionParameters(Parameters expParameters)

Description copied from interface: IWorkerContext

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 IWorkerContext

isNoTerminologyServer

public boolean isNoTerminologyServer()

Specified by:

isNoTerminologyServer in interface IWorkerContext

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)

Specified by:

getResourceNames in interface IWorkerContext

getResourceNamesAsSet

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

Specified by:

getResourceNamesAsSet in interface IWorkerContext

getResourceNamesAsSet

public Set<String> getResourceNamesAsSet()

Specified by:

getResourceNamesAsSet in interface IWorkerContext

Returns:

a set of the resource names defined for this version

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

fetchResourceWithException

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

Throws:

org.hl7.fhir.exceptions.FHIRException

fetchResourceWithException

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

Specified by:

fetchResourceWithException in interface IWorkerContext

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)

Specified by:

getPackageForUrl in interface IWorkerContext

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)

Description copied from interface: IWorkerContext

Fetch all the resources of a particular type. if class == (null | Resource | DomainResource | CanonicalResource) return everything

Specified by:

fetchResourcesByType in interface IWorkerContext

Type Parameters:

T -

Parameters:

class_ -

Returns:

fetchResourcesByType

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

Specified by:

fetchResourcesByType in interface IWorkerContext

fetchResourceById

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

Specified by:

fetchResourceById in interface IWorkerContext

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,
 Resource sourceForReference)

Description copied from interface: IWorkerContext

has the same functionality as fetchResource, but passes in information about the source of the reference (this may affect resolution of version)

Specified by:

fetchResource in interface IWorkerContext

Type Parameters:

T -

Parameters:

class_ -

uri -

Returns:

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchResource in interface IWorkerContext

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 resource, 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 class can be Resource, DomainResource or CanonicalResource, which means resource of all kinds

Specified by:

fetchResource in interface IWorkerContext

Returns:

fetchResource

public <T extends Resource> T fetchResource(Class<T> class_,
 String uri,
 String version,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchResource 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:

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,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

hasResource in interface IWorkerContext

hasResource

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

hasResourceVersion

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

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)

Specified by:

hasResource in interface IWorkerContext

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()

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

fetchTypeDefinition

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

Specified by:

fetchTypeDefinition in interface IWorkerContext

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:

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

Returns:

fetchTypeDefinitions

public List<StructureDefinition> fetchTypeDefinitions(String typeName,
 org.hl7.fhir.utilities.FhirPublication fhirVersion)

Specified by:

fetchTypeDefinitions in interface IWorkerContext

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()

Description copied from interface: IWorkerContext

Get the UCUM service that provides access to units of measure reasoning services This service might not be available

Specified by:

getUcumService in interface IWorkerContext

Returns:

setUcumService

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

Specified by:

setUcumService in interface IWorkerContext

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. 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

countAllCaches

public int countAllCaches()

getCodeSystemsUsed

public Set<String> getCodeSystemsUsed()

Specified by:

getCodeSystemsUsed in interface IWorkerContext

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 IWorkerContext.OIDSummary urlsForOid(String oid,
 String resourceType)

Specified by:

urlsForOid in interface IWorkerContext

Parameters:

oid -

resourceType - - null to search on all resource types

Returns:

urlsForOid

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

unload

public void unload()

findTxResource

public <T extends Resource> T findTxResource(Class<T> class_,
 String canonical,
 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 usually used (and so far only tested with) ValueSet.class

Specified by:

findTxResource in interface IWorkerContext

Returns:

findTxResource

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

Specified by:

findTxResource in interface IWorkerContext

findTxResource

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

Specified by:

findTxResource in interface IWorkerContext

fetchResourcesByUrl

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

Description copied from interface: IWorkerContext

Fetch all the resources for the given URL - all matching versions

Specified by:

fetchResourcesByUrl in interface IWorkerContext

Parameters:

uri -

Returns: