java.lang.Object
- org.hl7.fhir.utilities.i18n.I18nBase
- - org.hl7.fhir.r4.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.r4.context.IWorkerContext
  IWorkerContext.ILoggingService, IWorkerContext.ValidationResult

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<MetadataResource>`	`allConformanceResources()`
`List<StructureDefinition>`	`allStructures()`
`void`	`cacheResource(Resource theRes)`	cache a resource for later retrieval using fetchResource.
`static ca.uhn.fhir.context.support.ConceptValidationOptions`	`convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)`
`ValueSetExpander.ValueSetExpansionOutcome`	`expandVS(ElementDefinition.ElementDefinitionBindingComponent theBinding, boolean theCacheOk, boolean theHierarchical)`	ValueSet Expansion - see $expand, but resolves the binding first
`ValueSetExpander.ValueSetExpansionOutcome`	`expandVS(ValueSet.ConceptSetComponent theInc, boolean theHierarchical)`	Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.
`ValueSetExpander.ValueSetExpansionOutcome`	`expandVS(ValueSet theSource, boolean theCacheOk, boolean theHierarchical)`	ValueSet Expansion - see $expand
`CodeSystem`	`fetchCodeSystem(String theSystem)`	Find the code system definition for the nominated system uri.
`<T extends Resource> T`	`fetchResource(Class<T> theClass, String theUri)`	Find an identified resource.
`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.
`<T extends Resource> T`	`fetchResourceWithException(Class<T> theClass, String theUri)`
`StructureDefinition`	`fetchTypeDefinition(String typeName)`
`List<ConceptMap>`	`findMapsForSource(String theUrl)`	find concept maps for a source
`void`	`generateSnapshot(StructureDefinition p)`
`String`	`getAbbreviation(String theName)`	returns the recommended tla for the type
`Parameters`	`getExpansionParameters()`
`String`	`getLinkForUrl(String corePath, String url)`
`IWorkerContext.ILoggingService`	`getLogger()`
`INarrativeGenerator`	`getNarrativeGenerator(String thePrefix, String theBasePath)`	Get a generator that can generate narrative for the instance
`String`	`getOverrideVersionNs()`
`IParser`	`getParser(String theType)`	Get a parser to read/write instances.
`IParser`	`getParser(ParserType theType)`	Get a parser to read/write instances.
`List<String>`	`getResourceNames()`
`Set<String>`	`getResourceNamesAsSet()`
`List<StructureDefinition>`	`getStructures()`
`StructureMap`	`getTransform(String url)`
`List<String>`	`getTypeNames()`
`org.fhir.ucum.UcumService`	`getUcumService()`
`String`	`getVersion()`	Get the versions of the definitions loaded in context
`boolean`	`hasCache()`
`<T extends Resource> boolean`	`hasResource(Class<T> theClass_, String theUri)`	find whether a resource is available.
`boolean`	`isNoTerminologyServer()`
`List<StructureMap>`	`listTransforms()`
`IParser`	`newJsonParser()`	Get a JSON parser
`IResourceValidator`	`newValidator()`	Get a validator that can check whether a resource is valid
`IParser`	`newXmlParser()`	Get an XML parser
`String`	`oid2Uri(String theCode)`
`void`	`setExpansionProfile(Parameters theExpParameters)`
`void`	`setLogger(IWorkerContext.ILoggingService theLogger)`
`void`	`setOverrideVersionNs(String value)`
`void`	`setUcumService(org.fhir.ucum.UcumService ucumService)`
`boolean`	`supportsSystem(String theSystem)`	True if the underlying terminology service provider will do expansion and code validation for the terminology.
`org.hl7.fhir.utilities.TranslationServices`	`translator()`
`Set<String>`	`typeTails()`
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theCode, String theDisplay)`	Validation of a code - consult the terminology service to see whether it is known.
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theCode, String theDisplay, ValueSet theVs)`	Validation of a code - consult the terminology service to see whether it is known.
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String theSystem, String theCode, String theDisplay, ValueSet.ConceptSetComponent theVsi)`	Validation of a code - consult the terminology service to see whether it is known.
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, String code, ValueSet vs)`
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, CodeableConcept theCode, ValueSet theVs)`
`IWorkerContext.ValidationResult`	`validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions, Coding theCode, ValueSet theVs)`

Methods inherited from class org.hl7.fhir.utilities.i18n.I18nBase
formatMessage, getLocale, isWarnAboutMissingMessages, setLocale, setValidationMessageLanguage, setWarnAboutMissingMessages

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.r4.context.IWorkerContext
formatMessage, getLocale, setLocale, setValidationMessageLanguage

- Constructor Detail
  - HapiWorkerContext
```
public HapiWorkerContext(ca.uhn.fhir.context.FhirContext theCtx,
                         ca.uhn.fhir.context.support.IValidationSupport theValidationSupport)
```
- Method Detail
  - allStructures
```
public List<StructureDefinition> allStructures()
```
    Specified by:
    
    allStructures in interface IWorkerContext
  - getStructures
```
public List<StructureDefinition> getStructures()
```
    Specified by:
    
    getStructures in interface IWorkerContext
  - 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)
    
    Specified by:
    
    fetchCodeSystem in interface IWorkerContext
    
    Returns:
  - findMapsForSource
```
public List<ConceptMap> findMapsForSource(String theUrl)
```
    Description copied from interface: IWorkerContext
    
    find concept maps for a source
    
    Specified by:
    
    findMapsForSource in interface IWorkerContext
    
    Returns:
  - getAbbreviation
```
public String getAbbreviation(String theName)
```
    Description copied from interface: IWorkerContext
    
    returns the recommended tla for the type
    
    Specified by:
    
    getAbbreviation in interface IWorkerContext
    
    Returns:
  - getNarrativeGenerator
```
public INarrativeGenerator getNarrativeGenerator(String thePrefix,
                                                 String theBasePath)
```
    Description copied from interface: IWorkerContext
    
    Get a generator that can generate narrative for the instance
    
    Specified by:
    
    getNarrativeGenerator in interface IWorkerContext
    
    Returns:
    
    a prepared generator
  - getParser
```
public IParser getParser(ParserType theType)
```
    Description copied from interface: IWorkerContext
    
    Get a parser to read/write instances. Use the defined type (will be extended as further types are added, though the only currently anticipate type is RDF) XML/JSON - the standard renderers XHTML - render the narrative only (generate it if necessary)
    
    Specified by:
    
    getParser in interface IWorkerContext
    
    Returns:
  - getParser
```
public IParser getParser(String theType)
```
    Description copied from interface: IWorkerContext
    
    Get a parser to read/write instances. Determine the type from the stated type. Supported value for type: - the recommended MIME types - variants of application/xml and application/json - _format values xml, json
    
    Specified by:
    
    getParser in interface IWorkerContext
    
    Returns:
  - getResourceNames
```
public List<String> getResourceNames()
```
    Specified by:
    
    getResourceNames in interface IWorkerContext
  - newJsonParser
```
public IParser newJsonParser()
```
    Description copied from interface: IWorkerContext
    
    Get a JSON parser
    
    Specified by:
    
    newJsonParser in interface IWorkerContext
    
    Returns:
  - 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
  - newXmlParser
```
public IParser newXmlParser()
```
    Description copied from interface: IWorkerContext
    
    Get an XML parser
    
    Specified by:
    
    newXmlParser in interface IWorkerContext
    
    Returns:
  - oid2Uri
```
public String oid2Uri(String theCode)
```
    Specified by:
    
    oid2Uri 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
    
    Specified by:
    
    supportsSystem in interface IWorkerContext
    
    Returns:
  - typeTails
```
public Set<String> typeTails()
```
    Specified by:
    
    typeTails in interface IWorkerContext
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    CodeableConcept theCode,
                                                    ValueSet theVs)
```
    Specified by:
    
    validateCode in interface IWorkerContext
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    Coding theCode,
                                                    ValueSet theVs)
```
    Specified by:
    
    validateCode in interface IWorkerContext
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    String theSystem,
                                                    String theCode,
                                                    String theDisplay)
```
    Description copied from interface: IWorkerContext
    
    Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it note: always return a result, with either an error or a code description corresponds to 2 terminology service calls: $validate-code and $lookup
    
    Specified by:
    
    validateCode in interface IWorkerContext
    
    Returns:
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    String theSystem,
                                                    String theCode,
                                                    String theDisplay,
                                                    ValueSet.ConceptSetComponent theVsi)
```
    Description copied from interface: IWorkerContext
    
    Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it Also, check whether it's in the provided value set fragment (for supported systems with no value set definition) note: always return a result, with either an error or a code description, or both (e.g. known code, but not in the value set) corresponds to 2 terminology service calls: $validate-code and $lookup
    
    Specified by:
    
    validateCode in interface IWorkerContext
    
    Returns:
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    String theSystem,
                                                    String theCode,
                                                    String theDisplay,
                                                    ValueSet theVs)
```
    Description copied from interface: IWorkerContext
    
    Validation of a code - consult the terminology service to see whether it is known. If known, return a description of it Also, check whether it's in the provided value set note: always return a result, with either an error or a code description, or both (e.g. known code, but not in the value set) corresponds to 2 terminology service calls: $validate-code and $lookup
    
    Specified by:
    
    validateCode in interface IWorkerContext
    
    Returns:
  - validateCode
```
public IWorkerContext.ValidationResult validateCode(org.hl7.fhir.utilities.validation.ValidationOptions theOptions,
                                                    String code,
                                                    ValueSet vs)
```
    Specified by:
    
    validateCode in interface IWorkerContext
  - allConformanceResources
```
public List<MetadataResource> allConformanceResources()
```
    Specified by:
    
    allConformanceResources in interface IWorkerContext
  - generateSnapshot
```
public void generateSnapshot(StructureDefinition p)
                      throws org.hl7.fhir.exceptions.FHIRException
```
    Specified by:
    
    generateSnapshot in interface IWorkerContext
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getExpansionParameters
```
public Parameters getExpansionParameters()
```
    Specified by:
    
    getExpansionParameters in interface IWorkerContext
  - setExpansionProfile
```
public void setExpansionProfile(Parameters theExpParameters)
```
    Specified by:
    
    setExpansionProfile in interface IWorkerContext
  - hasCache
```
public boolean hasCache()
```
    Specified by:
    
    hasCache in interface IWorkerContext
  - expandVS
```
public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet theSource,
                                                          boolean theCacheOk,
                                                          boolean theHierarchical)
```
    Description copied from interface: IWorkerContext
    
    ValueSet Expansion - see $expand
    
    Specified by:
    
    expandVS in interface IWorkerContext
    
    Returns:
  - expandVS
```
public ValueSetExpander.ValueSetExpansionOutcome expandVS(ValueSet.ConceptSetComponent theInc,
                                                          boolean theHierarchical)
                                                   throws org.hl7.fhir.exceptions.TerminologyServiceException
```
    Description copied from interface: IWorkerContext
    
    Value set expanion inside the internal expansion engine - used for references to supported system (see "supportsSystem") for which there is no value set.
    
    Specified by:
    
    expandVS in interface IWorkerContext
    
    Returns:
    
    Throws:
    
    org.hl7.fhir.exceptions.TerminologyServiceException
  - getLogger
```
public IWorkerContext.ILoggingService getLogger()
```
    Specified by:
    
    getLogger in interface IWorkerContext
  - setLogger
```
public void setLogger(IWorkerContext.ILoggingService theLogger)
```
    Specified by:
    
    setLogger in interface IWorkerContext
  - getVersion
```
public String getVersion()
```
    Description copied from interface: IWorkerContext
    
    Get the versions of the definitions loaded in context
    
    Specified by:
    
    getVersion in interface IWorkerContext
    
    Returns:
  - getUcumService
```
public org.fhir.ucum.UcumService getUcumService()
```
    Specified by:
    
    getUcumService in interface IWorkerContext
  - setUcumService
```
public void setUcumService(org.fhir.ucum.UcumService ucumService)
```
    Specified by:
    
    setUcumService in interface IWorkerContext
  - isNoTerminologyServer
```
public boolean isNoTerminologyServer()
```
    Specified by:
    
    isNoTerminologyServer in interface IWorkerContext
  - translator
```
public org.hl7.fhir.utilities.TranslationServices translator()
```
    Specified by:
    
    translator in interface IWorkerContext
  - listTransforms
```
public List<StructureMap> listTransforms()
```
    Specified by:
    
    listTransforms in interface IWorkerContext
  - getTransform
```
public StructureMap getTransform(String url)
```
    Specified by:
    
    getTransform in interface IWorkerContext
  - getOverrideVersionNs
```
public String getOverrideVersionNs()
```
    Specified by:
    
    getOverrideVersionNs in interface IWorkerContext
  - setOverrideVersionNs
```
public void setOverrideVersionNs(String value)
```
    Specified by:
    
    setOverrideVersionNs in interface IWorkerContext
  - fetchTypeDefinition
```
public StructureDefinition fetchTypeDefinition(String typeName)
```
    Specified by:
    
    fetchTypeDefinition in interface IWorkerContext
  - getLinkForUrl
```
public String getLinkForUrl(String corePath,
                            String url)
```
    Specified by:
    
    getLinkForUrl in interface IWorkerContext
  - getTypeNames
```
public List<String> getTypeNames()
```
    Specified by:
    
    getTypeNames 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 resouce, return null, not an error The URI can have one of 3 formats: - a full URL e.g. http://acme.org/fhir/ValueSet/[id] - a relative URL e.g. ValueSet/[id] - a logical id e.g. [id] It's an error if the second form doesn't agree with class_. It's an error if class_ is null for the last form
    
    Specified by:
    
    fetchResource in interface IWorkerContext
    
    Returns:
  - 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
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Specified by:
    
    cacheResource in interface IWorkerContext
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getResourceNamesAsSet
```
public Set<String> getResourceNamesAsSet()
```
    Specified by:
    
    getResourceNamesAsSet in interface IWorkerContext
  - expandVS
```
public ValueSetExpander.ValueSetExpansionOutcome expandVS(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
  - convertConceptValidationOptions
```
public static ca.uhn.fhir.context.support.ConceptValidationOptions convertConceptValidationOptions(org.hl7.fhir.utilities.validation.ValidationOptions theOptions)
```

Class HapiWorkerContext

Nested Class Summary

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

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

Constructor Detail

HapiWorkerContext

Method Detail

allStructures

getStructures

fetchCodeSystem

findMapsForSource

getAbbreviation

getNarrativeGenerator

getParser

getParser

getResourceNames

newJsonParser

newValidator

newXmlParser

oid2Uri

supportsSystem

typeTails

validateCode

validateCode

validateCode

validateCode

validateCode

validateCode

allConformanceResources

generateSnapshot

getExpansionParameters

setExpansionProfile

hasCache

expandVS

expandVS

getLogger

setLogger

getVersion

getUcumService

setUcumService

isNoTerminologyServer

translator

listTransforms

getTransform

getOverrideVersionNs

setOverrideVersionNs

fetchTypeDefinition

getLinkForUrl

getTypeNames

fetchResource

fetchResourceWithException

fetchResourceById

hasResource

cacheResource

getResourceNamesAsSet

expandVS

convertConceptValidationOptions