java.lang.Object

org.hl7.fhir.utilities.i18n.I18nBase

org.hl7.fhir.r5.hapi.ctx.HapiWorkerContext

All Implemented Interfaces:: IWorkerContext

public final class HapiWorkerContext extends org.hl7.fhir.utilities.i18n.I18nBase implements IWorkerContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.context.IWorkerContext
IWorkerContext.ILoggingService, IWorkerContext.OIDDefinition, IWorkerContext.OIDDefinitionComparer, IWorkerContext.OIDSummary
Field Summary

Fields inherited from class org.hl7.fhir.utilities.i18n.I18nBase
KEY_DELIMITER, locale, PLURAL_SUFFIX
Constructor Summary

Constructors

Constructor

Description

HapiWorkerContext(ca.uhn.fhir.context.FhirContext theCtx, ca.uhn.fhir.context.support.IValidationSupport theValidationSupport)
Method Summary

Modifier and Type

Method

Description

void

cachePackage(PackageInformation packageInformation)

Inform the cache about package dependencies.

void

cacheResource(Resource theRes)

cache a resource for later retrieval using fetchResource.

void

cacheResourceFromPackage(Resource res, PackageInformation packageDetails)

cache a resource for later retrieval using fetchResource.

org.hl7.fhir.utilities.TimeTracker

clock()

static ca.uhn.fhir.context.support.ConceptValidationOptions

convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)

ValueSetExpansionOutcome

expandVS(Resource src, ElementDefinition.ElementDefinitionBindingComponent theBinding, boolean theCacheOk, boolean theHierarchical)

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

ValueSetExpansionOutcome

expandVS(ValueSet.ConceptSetComponent theInc, boolean theHierarchical, boolean theNoInactive)

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 theSource, boolean theCacheOk, boolean theHierarchical)

ValueSet Expansion - see $expand

ValueSetExpansionOutcome

expandVS(ValueSet theValueSet, boolean cacheOk, boolean heiarchical, boolean incompleteOk)

ValueSet Expansion - see $expand

CodeSystem

fetchCodeSystem(String theSystem)

Find the code system definition for the nominated system uri.

CodeSystem

fetchCodeSystem(String theSystem, 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> theClass, String theUri)

Find an identified resource.

<T extends Resource> T

fetchResource(Class<T> theClass, String theUri, String theVersion)

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

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 theType, String theUri)

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

fetchResourceRaw(Class<T> class_, String uri)

<T extends Resource> List<T>

fetchResourcesByType(Class<T> theClass)

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

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

<T extends Resource> T

fetchResourceWithException(Class<T> theClass, String theUri)

<T extends Resource> T

fetchResourceWithException(Class<T> theClass, String uri, Resource sourceOfReference)

CodeSystem

fetchSupplementedCodeSystem(String theS)

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

CodeSystem

fetchSupplementedCodeSystem(String theS, String theS1)

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

This finds all the structure definitions that have the given typeName

List<StructureDefinition>

fetchTypeDefinitions(String n, org.hl7.fhir.utilities.FhirPublication fhirPublication)

<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

byte[]

getBinaryForKey(String s)

Returns the binary for the key

Set<String>

getBinaryKeysAsSet()

Returns a set of keys that can be used to get binaries from this context.

int

getClientRetryCount()

Set<String>

getCodeSystemsUsed()

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

Locale

getLocale()

get/set the locale used when creating messages todo: what's the difference?

ILoggingService

getLogger()

Map<String,NamingSystem>

getNSUrlMap()

PackageInformation

getPackage(String id, String ver)

PackageInformation

getPackageForUrl(String s)

IWorkerContextManager.IPackageLoadingTracker

getPackageTracker()

PEBuilder

getProfiledElementBuilder(PEBuilder.PEElementPropertiesPolicy thePEElementPropertiesPolicy, boolean theB)

List<String>

getResourceNames()

List<String>

getResourceNames(org.hl7.fhir.utilities.FhirPublication fhirVersion)

Set<String>

getResourceNamesAsSet()

Set<String>

getResourceNamesAsSet(org.hl7.fhir.utilities.FhirPublication fhirVersion)

String

getSpecUrl()

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

getVersion()

Get the version of the base definitions loaded in context This *does not* have to be 5.0 (R5) - the context can load other versions Note that more than one version might be loaded at once, but one version is always the default / master

boolean

hasBinaryKey(String s)

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

boolean

hasPackage(String id, String ver)

boolean

hasPackage(PackageInformation packageVersion)

<T extends Resource> boolean

hasResource(Class<T> theClass_, String theUri)

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)

boolean

isDataType(String s)

return whether type is data type.

boolean

isForPublication()

boolean

isNoTerminologyServer()

boolean

isPrimitiveType(String s)

return whether type is primitive type.

boolean

isServerSideSystem(String url)

int

loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader)

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource

int

loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader, List<String> types)

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource Deprecated - use the simpler method where the types come from the loader.

int

loadFromPackageAndDependencies(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader, org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm)

Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource This method also loads all the packages that the package depends on (recursively)

IResourceValidator

newValidator()

Get a validator that can check whether a resource is valid

IWorkerContext

setClientRetryCount(int value)

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

setExpansionProfile(Parameters theExpParameters)

void

setForPublication(boolean b)

void

setLocale(Locale locale)

void

setLogger(ILoggingService theLogger)

IWorkerContext

setPackageTracker(IWorkerContextManager.IPackageLoadingTracker theIPackageLoadingTracker)

void

setUcumService(org.fhir.ucum.UcumService ucumService)

Boolean

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

ask the terminology system whether parent subsumes child.

boolean

supportsSystem(String theSystem)

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)

IWorkerContext.OIDSummary

urlsForOid(String oid, String resourceType)

ValidationResult

validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theVersion, String theCode, String theDisplay)

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 theOptions, String theSystem, String theVersion, String theCode, String theDisplay, ValueSet theVs)

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 theOptions, 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 theOptions, CodeableConcept theCode, ValueSet theVs)

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 theOptions, Coding theCode, ValueSet theVs)

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, 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 validationOptions, List<? extends CodingValidationRequest> list, String s)

Methods inherited from class org.hl7.fhir.utilities.i18n.I18nBase
formatMessage, formatMessagePlural, getMessagesSourceFileName, getPluralKey, getPluralKeys, getPluralSuffixes, getRootKeyFromPlural, isWarnAboutMissingMessages, messageKeyExistsForLocale, 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
formatMessage, formatMessagePlural, setValidationMessageLanguage

Constructor Details
- HapiWorkerContext
  
  public HapiWorkerContext(ca.uhn.fhir.context.FhirContext theCtx, ca.uhn.fhir.context.support.IValidationSupport theValidationSupport)
Method Details
- fetchCodeSystem
  
  public CodeSystem fetchCodeSystem(String theSystem)
  
  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:
  
  theSystem -
  
  Returns:
- fetchCodeSystem
  
  public CodeSystem fetchCodeSystem(String theSystem, String version)
  
  Specified by:
  
  fetchCodeSystem in interface IWorkerContext
- fetchCodeSystem
  
  public CodeSystem fetchCodeSystem(String system, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  fetchCodeSystem in interface IWorkerContext
- fetchCodeSystem
  
  public CodeSystem fetchCodeSystem(String system, String version, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  fetchCodeSystem in interface IWorkerContext
- fetchSupplementedCodeSystem
  
  public CodeSystem fetchSupplementedCodeSystem(String theS)
  
  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:
  
  theS -
  
  Returns:
- fetchSupplementedCodeSystem
  
  public CodeSystem fetchSupplementedCodeSystem(String theS, String theS1)
  
  Specified by:
  
  fetchSupplementedCodeSystem 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
- getResourceNames
  
  public List<String> getResourceNames()
  
  Specified by:
  
  getResourceNames in interface IWorkerContext
  
  Returns:
  
  a list of the resource names defined for this version
- getResourceNames
  
  public List<String> getResourceNames(org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  getResourceNames in interface IWorkerContext
- newValidator
  
  public IResourceValidator newValidator()
  
  Description copied from interface: IWorkerContext
  
  Get a validator that can check whether a resource is valid
  
  Specified by:
  
  newValidator in interface IWorkerContext
  
  Returns:
  
  a prepared generator
- getNSUrlMap
  
  public Map<String,NamingSystem> getNSUrlMap()
  
  Specified by:
  
  getNSUrlMap in interface IWorkerContext
- supportsSystem
  
  public boolean supportsSystem(String theSystem)
  
  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:
  
  theSystem -
  
  Returns:
- 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
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, CodeableConcept theCode, ValueSet theVs)
  
  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:
  
  theOptions - - validation options (required)
  
  theCode - - CodeableConcept to validate
  
  theVs - the applicable valueset (optional)
  
  Returns:
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, Coding theCode, ValueSet theVs)
  
  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:
  
  theOptions - - validation options (required)
  
  theCode - - Coding to validate
  
  theVs - the applicable valueset (optional)
  
  Returns:
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions options, 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:
  
  options -
  
  code -
  
  vs -
  
  ctxt -
  
  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 validationOptions, List<? extends CodingValidationRequest> list, String s)
  
  Specified by:
  
  validateCodeBatchByRef in interface IWorkerContext
- expandVS
  
  public ValueSetExpansionOutcome expandVS(ValueSet theValueSet, boolean cacheOk, boolean heiarchical, boolean incompleteOk)
  
  Description copied from interface: IWorkerContext
  
  ValueSet Expansion - see $expand
  
  Specified by:
  
  expandVS in interface IWorkerContext
  
  Parameters:
  
  theValueSet -
  
  Returns:
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theVersion, String theCode, String theDisplay)
  
  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:
  
  theOptions - - validation options (required)
  
  theSystem - - equals Coding.system (required)
  
  theCode - - equals Coding.code (required)
  
  theDisplay - - equals Coding.display (optional)
  
  Returns:
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theVersion, String theCode, String theDisplay, ValueSet theVs)
  
  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:
  
  theOptions - - validation options (required)
  
  theSystem - - equals Coding.system (required)
  
  theCode - - equals Coding.code (required)
  
  theDisplay - - equals Coding.display (optional)
  
  theVs - the applicable valueset (optional)
  
  Returns:
- validateCode
  
  public ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, 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:
  
  theOptions - - validation options (required)
  
  code - he code to validate (required)
  
  vs - the applicable valueset (required)
  
  Returns:
- 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
- setExpansionProfile
  
  public void setExpansionProfile(Parameters theExpParameters)
- expandVS
  
  public ValueSetExpansionOutcome expandVS(ValueSet theSource, boolean theCacheOk, boolean theHierarchical)
  
  Description copied from interface: IWorkerContext
  
  ValueSet Expansion - see $expand
  
  Specified by:
  
  expandVS in interface IWorkerContext
  
  Parameters:
  
  theSource -
  
  Returns:
- expandVS
  
  public ValueSetExpansionOutcome expandVS(ValueSet.ConceptSetComponent theInc, boolean theHierarchical, boolean theNoInactive) 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:
  
  theInc -
  
  Returns:
  
  Throws:
  
  org.hl7.fhir.exceptions.TerminologyServiceException
- getLocale
  
  public Locale getLocale()
  
  Description copied from interface: IWorkerContext
  
  get/set the locale used when creating messages todo: what's the difference?
  
  Specified by:
  
  getLocale in interface IWorkerContext
  
  Overrides:
  
  getLocale in class org.hl7.fhir.utilities.i18n.I18nBase
  
  Returns:
- setLocale
  
  public void setLocale(Locale locale)
  
  Specified by:
  
  setLocale in interface IWorkerContext
  
  Overrides:
  
  setLocale in class org.hl7.fhir.utilities.i18n.I18nBase
- getLogger
  
  public ILoggingService getLogger()
  
  Specified by:
  
  getLogger in interface IWorkerContext
- setLogger
  
  public void setLogger(ILoggingService theLogger)
  
  Specified by:
  
  setLogger in interface IWorkerContext
- getVersion
  
  public String getVersion()
  
  Description copied from interface: IWorkerContext
  
  Get the version of the base definitions loaded in context This *does not* have to be 5.0 (R5) - the context can load other versions Note that more than one version might be loaded at once, but one version is always the default / master
  
  Specified by:
  
  getVersion in interface IWorkerContext
  
  Returns:
- 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
- isNoTerminologyServer
  
  public boolean isNoTerminologyServer()
  
  Specified by:
  
  isNoTerminologyServer in interface IWorkerContext
- getCodeSystemsUsed
  
  public Set<String> getCodeSystemsUsed()
  
  Specified by:
  
  getCodeSystemsUsed 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:
- isPrimitiveType
  
  public boolean isPrimitiveType(String s)
  
  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:
  
  s -
  
  Returns:
- isDataType
  
  public boolean isDataType(String s)
  
  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:
  
  s -
  
  Returns:
- fetchTypeDefinition
  
  public StructureDefinition fetchTypeDefinition(String typeName, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  fetchTypeDefinition in interface IWorkerContext
- fetchTypeDefinitions
  
  public List<StructureDefinition> fetchTypeDefinitions(String n)
  
  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 n, org.hl7.fhir.utilities.FhirPublication fhirPublication)
  
  Specified by:
  
  fetchTypeDefinitions in interface IWorkerContext
- fetchResourceRaw
  
  public <T extends Resource> T fetchResourceRaw(Class<T> class_, String uri)
  
  Specified by:
  
  fetchResourceRaw in interface IWorkerContext
- fetchResource
  
  public <T extends Resource> T fetchResource(Class<T> theClass, String theUri)
  
  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, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  fetchResource in interface IWorkerContext
- fetchResourceWithException
  
  public <T extends Resource> T fetchResourceWithException(Class<T> theClass, String theUri) 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(Class<T> theClass, String uri, Resource sourceOfReference) throws org.hl7.fhir.exceptions.FHIRException
  
  Specified by:
  
  fetchResourceWithException in interface IWorkerContext
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fetchResource
  
  public <T extends Resource> T fetchResource(Class<T> theClass, String theUri, String theVersion)
  
  Specified by:
  
  fetchResource in interface IWorkerContext
- 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, Resource canonicalForSource)
  
  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:
- 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:
- fetchResourceById
  
  public Resource fetchResourceById(String theType, String theUri)
  
  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:
  
  theType -
  
  theUri -
  
  Returns:
- fetchResourceById
  
  public Resource fetchResourceById(String type, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  fetchResourceById in interface IWorkerContext
- hasResource
  
  public <T extends Resource> boolean hasResource(Class<T> theClass_, String theUri)
  
  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:
  
  theClass_ -
  
  theUri -
  
  Returns:
- hasResource
  
  public <T extends Resource> boolean hasResource(Class<T> class_, String uri, Resource sourceOfReference)
  
  Specified by:
  
  hasResource in interface IWorkerContext
- hasResource
  
  public <T extends Resource> boolean hasResource(Class<T> class_, String uri, org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  hasResource in interface IWorkerContext
- cacheResource
  
  public void cacheResource(Resource theRes) 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:
  
  theRes -
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- cacheResourceFromPackage
  
  public void cacheResourceFromPackage(Resource res, PackageInformation packageDetails) 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:
  
  res -
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- cachePackage
  
  public void cachePackage(PackageInformation packageInformation)
  
  Description copied from interface: IWorkerContext
  
  Inform the cache about package dependencies. This can be used to help resolve references Note that the cache doesn't load dependencies
  
  Specified by:
  
  cachePackage in interface IWorkerContext
  
  Parameters:
  
  packageInformation -
- getResourceNamesAsSet
  
  public Set<String> getResourceNamesAsSet()
  
  Specified by:
  
  getResourceNamesAsSet in interface IWorkerContext
  
  Returns:
  
  a set of the resource names defined for this version
- getResourceNamesAsSet
  
  public Set<String> getResourceNamesAsSet(org.hl7.fhir.utilities.FhirPublication fhirVersion)
  
  Specified by:
  
  getResourceNamesAsSet in interface IWorkerContext
- expandVS
  
  public ValueSetExpansionOutcome expandVS(Resource src, ElementDefinition.ElementDefinitionBindingComponent theBinding, boolean theCacheOk, boolean theHierarchical) 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
- 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 s)
  
  Description copied from interface: IWorkerContext
  
  Returns true if this worker context contains a binary for this key.
  
  Specified by:
  
  hasBinaryKey in interface IWorkerContext
  
  Parameters:
  
  s -
  
  Returns:
  
  true if binary is available for this key
- getBinaryForKey
  
  public byte[] getBinaryForKey(String s)
  
  Description copied from interface: IWorkerContext
  
  Returns the binary for the key
  
  Specified by:
  
  getBinaryForKey in interface IWorkerContext
  
  Parameters:
  
  s -
  
  Returns:
- loadFromPackage
  
  public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader) throws org.hl7.fhir.exceptions.FHIRException
  
  Description copied from interface: IWorkerContext
  
  Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource
  
  Specified by:
  
  loadFromPackage in interface IWorkerContext
  
  Parameters:
  
  pi - - the package to load
  
  loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).
  
  Returns:
  
  the number of resources loaded
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- loadFromPackage
  
  public int loadFromPackage(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader, List<String> types) throws FileNotFoundException, IOException, org.hl7.fhir.exceptions.FHIRException
  
  Description copied from interface: IWorkerContext
  
  Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource Deprecated - use the simpler method where the types come from the loader.
  
  Specified by:
  
  loadFromPackage in interface IWorkerContext
  
  Parameters:
  
  pi - - the package to load
  
  loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).
  
  types - - which types of resources to load
  
  Returns:
  
  the number of resources loaded
  
  Throws:
  
  FileNotFoundException
  
  IOException
  
  org.hl7.fhir.exceptions.FHIRException
- loadFromPackageAndDependencies
  
  public int loadFromPackageAndDependencies(org.hl7.fhir.utilities.npm.NpmPackage pi, IContextResourceLoader loader, org.hl7.fhir.utilities.npm.BasePackageCacheManager pcm) throws org.hl7.fhir.exceptions.FHIRException
  
  Description copied from interface: IWorkerContext
  
  Load relevant resources of the appropriate types (as specified by the loader) from the nominated package note that the package system uses lazy loading; the loader will be called later when the classes that use the context need the relevant resource This method also loads all the packages that the package depends on (recursively)
  
  Specified by:
  
  loadFromPackageAndDependencies in interface IWorkerContext
  
  Parameters:
  
  pi - - the package to load
  
  loader - - an implemenation of IContextResourceLoader that knows how to read the resources in the package (e.g. for the appropriate version).
  
  pcm - - used to find and load additional dependencies
  
  Returns:
  
  the number of resources loaded
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasPackage
  
  public boolean hasPackage(String id, String ver)
  
  Specified by:
  
  hasPackage in interface IWorkerContext
- hasPackage
  
  public boolean hasPackage(PackageInformation packageVersion)
  
  Specified by:
  
  hasPackage in interface IWorkerContext
- getPackage
  
  public PackageInformation getPackage(String id, String ver)
  
  Specified by:
  
  getPackage in interface IWorkerContext
- getClientRetryCount
  
  public int getClientRetryCount()
  
  Specified by:
  
  getClientRetryCount in interface IWorkerContext
- setClientRetryCount
  
  public IWorkerContext setClientRetryCount(int value)
  
  Specified by:
  
  setClientRetryCount in interface IWorkerContext
- clock
  
  public org.hl7.fhir.utilities.TimeTracker clock()
  
  Specified by:
  
  clock in interface IWorkerContext
- getPackageTracker
  
  public IWorkerContextManager.IPackageLoadingTracker getPackageTracker()
  
  Specified by:
  
  getPackageTracker in interface IWorkerContext
- getPackageForUrl
  
  public PackageInformation getPackageForUrl(String s)
  
  Specified by:
  
  getPackageForUrl in interface IWorkerContext
- convertConceptValidationOptions
  
  public static ca.uhn.fhir.context.support.ConceptValidationOptions convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)
- fetchResourcesByType
  
  public <T extends Resource> List<T> fetchResourcesByType(Class<T> theClass)
  
  Specified by:
  
  fetchResourcesByType in interface IWorkerContext
- fetchResourcesByUrl
  
  public <T extends Resource> List<T> fetchResourcesByUrl(Class<T> class_, String url)
  
  Description copied from interface: IWorkerContext
  
  Fetch all the resources for the given URL - all matching versions
  
  Specified by:
  
  fetchResourcesByUrl in interface IWorkerContext
  
  Parameters:
  
  url -
  
  Returns:
- setPackageTracker
  
  public IWorkerContext setPackageTracker(IWorkerContextManager.IPackageLoadingTracker theIPackageLoadingTracker)
  
  Specified by:
  
  setPackageTracker in interface IWorkerContext
- getSpecUrl
  
  public String getSpecUrl()
  
  Specified by:
  
  getSpecUrl in interface IWorkerContext
- getProfiledElementBuilder
  
  public PEBuilder getProfiledElementBuilder(PEBuilder.PEElementPropertiesPolicy thePEElementPropertiesPolicy, boolean theB)
  
  Specified by:
  
  getProfiledElementBuilder in interface IWorkerContext
- isForPublication
  
  public boolean isForPublication()
  
  Specified by:
  
  isForPublication in interface IWorkerContext
- setForPublication
  
  public void setForPublication(boolean b)
  
  Specified by:
  
  setForPublication in interface IWorkerContext
- 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:
- 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
- subsumes
  
  public Boolean subsumes(org.hl7.fhir.utilities.validation.ValidationOptions optionsArg, Coding parent, Coding child)
  
  Description copied from interface: IWorkerContext
  
  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
- isServerSideSystem
  
  public boolean isServerSideSystem(String url)
  
  Specified by:
  
  isServerSideSystem in interface IWorkerContext

Class HapiWorkerContext

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

HapiWorkerContext

Method Details

fetchCodeSystem

fetchCodeSystem

fetchCodeSystem

fetchCodeSystem

fetchSupplementedCodeSystem

fetchSupplementedCodeSystem

fetchSupplementedCodeSystem

fetchSupplementedCodeSystem

getResourceNames

getResourceNames

newValidator

getNSUrlMap

supportsSystem

supportsSystem

validateCode

validateCode

validateCode

validateCodeBatch

validateCodeBatchByRef

expandVS

validateCode

validateCode

validateCode

getExpansionParameters

setExpansionParameters

setExpansionProfile

expandVS

expandVS

getLocale

setLocale

getLogger

setLogger

getVersion

getUcumService

setUcumService

isNoTerminologyServer

getCodeSystemsUsed

fetchTypeDefinition

isPrimitiveType

isDataType

fetchTypeDefinition

fetchTypeDefinitions

fetchTypeDefinitions

fetchResourceRaw

fetchResource

fetchResource

fetchResourceWithException

fetchResourceWithException

fetchResource

fetchResource

fetchResource

fetchResourcesByType

fetchResourceById

fetchResourceById

hasResource

hasResource

hasResource

cacheResource

cacheResourceFromPackage

cachePackage

getResourceNamesAsSet

getResourceNamesAsSet

expandVS

getBinaryKeysAsSet

hasBinaryKey

getBinaryForKey

loadFromPackage