FhirContext (HAPI FHIR - Core Library 1.4 API)

java.lang.Object
- ca.uhn.fhir.context.FhirContext

```
public class FhirContext
extends Object
```
The FHIR context is the central starting point for the use of the HAPI FHIR API. It should be created once, and then used as a factory for various other types of objects (parsers, clients, etc.).
Important usage notes:
- Thread safety: This class is thread safe and may be shared between multiple processing threads.
- Performance: This class is expensive to create, as it scans every resource class it needs to parse or encode to build up an internal model of those classes. For that reason, you should try to create one FhirContext instance which remains for the life of your application and reuse that instance. Note that it will not cause problems to create multiple instances (ie. resources originating from one FhirContext may be passed to parsers originating from another) but you will incur a performance penalty if a new FhirContext is created for every message you parse/encode.

Constructor Summary

Constructors
Constructor and Description
`FhirContext()` Default constructor.
`FhirContext(Class<?>... theResourceTypes)`
`FhirContext(Class<? extends IBaseResource> theResourceType)`
`FhirContext(Collection<Class<? extends IBaseResource>> theResourceTypes)`
`FhirContext(FhirVersionEnum theVersion)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FhirContext`	`forDstu1()` Creates and returns a new FhirContext with version `FhirVersionEnum.DSTU1`
`static FhirContext`	`forDstu2()` Creates and returns a new FhirContext with version `DSTU 2`
`static FhirContext`	`forDstu2Hl7Org()`
`static FhirContext`	`forDstu3()` Creates and returns a new FhirContext with version `DSTU 3`
`BaseRuntimeElementDefinition<?>`	`getElementDefinition(Class<? extends IBase> theElementType)` Returns the scanned runtime model for the given type.
`BaseRuntimeElementDefinition<?>`	`getElementDefinition(String theElementName)` Returns the scanned runtime model for the given type.
`Collection<BaseRuntimeElementDefinition<?>>`	`getElementDefinitions()` Returns all element definitions (resources, datatypes, etc.)
`HapiLocalizer`	`getLocalizer()` This feature is not yet in its final state and should be considered an internal part of HAPI for now - use with caution
`INarrativeGenerator`	`getNarrativeGenerator()`
`RuntimeResourceDefinition`	`getResourceDefinition(Class<? extends IBaseResource> theResourceType)` Returns the scanned runtime model for the given type.
`RuntimeResourceDefinition`	`getResourceDefinition(FhirVersionEnum theVersion, String theResourceName)`
`RuntimeResourceDefinition`	`getResourceDefinition(IBaseResource theResource)` Returns the scanned runtime model for the given type.
`RuntimeResourceDefinition`	`getResourceDefinition(String theResourceName)` Returns the scanned runtime model for the given type.
`RuntimeResourceDefinition`	`getResourceDefinitionById(String theId)` Returns the scanned runtime model for the given type.
`Collection<RuntimeResourceDefinition>`	`getResourceDefinitions()` Returns the scanned runtime models.
`IRestfulClientFactory`	`getRestfulClientFactory()`
`RuntimeChildUndeclaredExtensionDefinition`	`getRuntimeChildUndeclaredExtensionDefinition()`
`IFhirVersion`	`getVersion()`
`IVersionSpecificBundleFactory`	`newBundleFactory()` This method should be considered experimental and will likely change in future releases of HAPI.
`IParser`	`newJsonParser()` Create and return a new JSON parser.
`<T extends IRestfulClient> T`	`newRestfulClient(Class<T> theClientType, String theServerBase)` Instantiates a new client instance.
`IGenericClient`	`newRestfulGenericClient(String theServerBase)` Instantiates a new generic client.
`FhirTerser`	`newTerser()`
`FhirValidator`	`newValidator()` Create a new validator instance.
`ViewGenerator`	`newViewGenerator()`
`IParser`	`newXmlParser()` Create and return a new XML parser.
`void`	`setLocalizer(HapiLocalizer theMessages)` This feature is not yet in its final state and should be considered an internal part of HAPI for now - use with caution
`void`	`setNarrativeGenerator(INarrativeGenerator theNarrativeGenerator)`
`void`	`setParserErrorHandler(IParserErrorHandler theParserErrorHandler)` Sets a parser error handler to use by default on all parsers

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

- Constructor Detail
  - FhirContext
```
public FhirContext()
```
    Default constructor. In most cases this is the right constructor to use.
  - FhirContext
```
public FhirContext(Class<? extends IBaseResource> theResourceType)
```
  - FhirContext
```
public FhirContext(Class<?>... theResourceTypes)
```
  - FhirContext
```
public FhirContext(Collection<Class<? extends IBaseResource>> theResourceTypes)
```
  - FhirContext
```
public FhirContext(FhirVersionEnum theVersion)
```
- Method Detail
  - getElementDefinition
```
public BaseRuntimeElementDefinition<?> getElementDefinition(Class<? extends IBase> theElementType)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getElementDefinition
```
public BaseRuntimeElementDefinition<?> getElementDefinition(String theElementName)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getElementDefinitions
```
public Collection<BaseRuntimeElementDefinition<?>> getElementDefinitions()
```
    Returns all element definitions (resources, datatypes, etc.)
  - getLocalizer
```
public HapiLocalizer getLocalizer()
```
    This feature is not yet in its final state and should be considered an internal part of HAPI for now - use with caution
  - getNarrativeGenerator
```
public INarrativeGenerator getNarrativeGenerator()
```
  - getResourceDefinition
```
public RuntimeResourceDefinition getResourceDefinition(Class<? extends IBaseResource> theResourceType)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getResourceDefinition
```
public RuntimeResourceDefinition getResourceDefinition(FhirVersionEnum theVersion,
                                                       String theResourceName)
```
  - getResourceDefinition
```
public RuntimeResourceDefinition getResourceDefinition(IBaseResource theResource)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getResourceDefinition
```
public RuntimeResourceDefinition getResourceDefinition(String theResourceName)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getResourceDefinitionById
```
public RuntimeResourceDefinition getResourceDefinitionById(String theId)
```
    Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library.
  - getResourceDefinitions
```
public Collection<RuntimeResourceDefinition> getResourceDefinitions()
```
    Returns the scanned runtime models. This is an advanced feature which is generally only needed for extending the core library.
  - getRestfulClientFactory
```
public IRestfulClientFactory getRestfulClientFactory()
```
  - getRuntimeChildUndeclaredExtensionDefinition
```
public RuntimeChildUndeclaredExtensionDefinition getRuntimeChildUndeclaredExtensionDefinition()
```
  - getVersion
```
public IFhirVersion getVersion()
```
  - newBundleFactory
```
public IVersionSpecificBundleFactory newBundleFactory()
```
    This method should be considered experimental and will likely change in future releases of HAPI. Use with caution!
  - newJsonParser
```
public IParser newJsonParser()
```
    Create and return a new JSON parser.
    Thread safety: Parsers are not guaranteed to be thread safe. Create a new parser instance for every thread or every message being parsed/encoded.
    
    Performance Note: This method is cheap to call, and may be called once for every message being processed without incurring any performance penalty
  - newRestfulClient
```
public <T extends IRestfulClient> T newRestfulClient(Class<T> theClientType,
                                                     String theServerBase)
```
    Instantiates a new client instance. This method requires an interface which is defined specifically for your use cases to contain methods for each of the RESTful operations you wish to implement (e.g. "read ImagingStudy", "search Patient by identifier", etc.). This interface must extend IRestfulClient (or commonly its sub-interface IBasicClient). See the RESTful Client documentation for more information on how to define this interface.
    Performance Note: This method is cheap to call, and may be called once for every operation invocation without incurring any performance penalty
    
    Parameters:
    
    theClientType - The client type, which is an interface type to be instantiated
    
    theServerBase - The URL of the base for the restful FHIR server to connect to
    
    Returns:
    
    A newly created client
    
    Throws:
    
    ConfigurationException - If the interface type is not an interface
  - newRestfulGenericClient
```
public IGenericClient newRestfulGenericClient(String theServerBase)
```
    Instantiates a new generic client. A generic client is able to perform any of the FHIR RESTful operations against a compliant server, but does not have methods defining the specific functionality required (as is the case with non-generic clients).
    Performance Note: This method is cheap to call, and may be called once for every operation invocation without incurring any performance penalty
    
    Parameters:
    
    theServerBase - The URL of the base for the restful FHIR server to connect to
  - newTerser
```
public FhirTerser newTerser()
```
  - newValidator
```
public FhirValidator newValidator()
```
    Create a new validator instance.
    Note on thread safety: Validators are thread safe, you may use a single validator in multiple threads. (This is in contrast to parsers)
  - newViewGenerator
```
public ViewGenerator newViewGenerator()
```
  - newXmlParser
```
public IParser newXmlParser()
```
    Create and return a new XML parser.
    Thread safety: Parsers are not guaranteed to be thread safe. Create a new parser instance for every thread or every message being parsed/encoded.
    
    Performance Note: This method is cheap to call, and may be called once for every message being processed without incurring any performance penalty
  - setLocalizer
```
public void setLocalizer(HapiLocalizer theMessages)
```
    This feature is not yet in its final state and should be considered an internal part of HAPI for now - use with caution
  - setNarrativeGenerator
```
public void setNarrativeGenerator(INarrativeGenerator theNarrativeGenerator)
```
  - setParserErrorHandler
```
public void setParserErrorHandler(IParserErrorHandler theParserErrorHandler)
```
    Sets a parser error handler to use by default on all parsers
    
    Parameters:
    
    theParserErrorHandler - The error handler
  - forDstu1
```
public static FhirContext forDstu1()
```
    Creates and returns a new FhirContext with version FhirVersionEnum.DSTU1
  - forDstu2
```
public static FhirContext forDstu2()
```
    Creates and returns a new FhirContext with version DSTU 2
  - forDstu3
```
public static FhirContext forDstu3()
```
    Creates and returns a new FhirContext with version DSTU 3
    
    Since:
    
    1.4
  - forDstu2Hl7Org
```
public static FhirContext forDstu2Hl7Org()
```

Class FhirContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FhirContext

FhirContext

FhirContext

FhirContext

FhirContext

Method Detail

getElementDefinition

getElementDefinition

getElementDefinitions

getLocalizer

getNarrativeGenerator

getResourceDefinition

getResourceDefinition

getResourceDefinition

getResourceDefinition

getResourceDefinitionById

getResourceDefinitions

getRestfulClientFactory

getRuntimeChildUndeclaredExtensionDefinition

getVersion

newBundleFactory

newJsonParser

newRestfulClient

newRestfulGenericClient

newTerser

newValidator

newViewGenerator

newXmlParser

setLocalizer

setNarrativeGenerator

setParserErrorHandler

forDstu1

forDstu2

forDstu3

forDstu2Hl7Org