How hapifhir/hapi-fhir works
HAPI FHIR is a Java API and framework for building HL7 FHIR clients and servers. A typical resource workflow begins with a FHIR resource represented using a version-specific model; server requests are captured as request details and can be handled by storage services, while clients construct REST queries. The repository also contains parsing, validation, terminology, narrative, FHIRPath, batch, and specialized server capabilities. The README establishes the client/server product scope; source excerpts and the source index support only a limited set of internal links, so uncertain runtime wiring is omitted.
Main entry points: FhirContext.java Version context · JpaStorageResourceParser.java JPA resource handling · SearchParamExtractorService.java Search indexing · RequestDetails.java Server request
Components 20
FHIR model and context
- FHIR resources
hapi-fhir-base/src/main/java/ca/uhn/fhir/model/api/IResource.java - Version context
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java - Runtime definitions
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java - Search definitions
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeSearchParam.java
Parsing and validation
- FHIR parsers
hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/JsonParser.java - Validation support
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/support/IValidationSupport.java - FHIRPath
hapi-fhir-base/src/main/java/ca/uhn/fhir/fhirpath/IFhirPath.java - Narrative generation
hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative/INarrativeGenerator.java
Client and server APIs
- FHIR client
hapi-fhir-client/src/main/java/ca/uhn/fhir/rest/client/method/BaseQueryParameter.java - Repository queries
hapi-fhir-base/src/main/java/ca/uhn/fhir/repository/impl/MultiMapRepositoryRestQueryBuilder.java - Server request
hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/api/server/RequestDetails.java
Storage and extensions
- DAO registry
hapi-fhir-storage/src/main/java/ca/uhn/fhir/jpa/api/dao/DaoRegistry.java - JPA resource handling
hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/JpaStorageResourceParser.java - Search indexing
hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/extractor/SearchParamExtractorService.java - JPA search queries
hapi-fhir-storage/src/main/java/ca/uhn/fhir/jpa/repository/searchparam/SearchParameterMapRepositoryRestQueryBuilder.java - Master data matching
hapi-fhir-jpaserver-mdm/src/main/java/ca/uhn/fhir/jpa/mdm/svc/MdmControllerSvcImpl.java - CDS Hooks
hapi-fhir-server-cds-hooks/src/main/java/ca/uhn/hapi/fhir/cdshooks/controller/CdsHooksController.java - Bulk export jobs
hapi-fhir-storage-batch2-jobs/src/main/java/ca/uhn/fhir/batch2/jobs/export/BulkExportJobService.java
Other components
- FHIR application
- FHIR database
Connections 9
- FHIR application → FHIR client: uses client
- FHIR application → Server request: sends requests
- Version context → Runtime definitions: scans types
hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java - Search indexing → Version context: uses context
hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/extractor/SearchParamExtractorService.java - Search indexing → Search definitions: reads definitions
hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/extractor/SearchParamExtractorService.java - JPA resource handling → Version context: uses context
hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/JpaStorageResourceParser.java - JPA resource handling → Runtime definitions: uses definitions
hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/JpaStorageResourceParser.java - JPA search queries → Repository queries: implements query builder
hapi-fhir-storage/src/main/java/ca/uhn/fhir/jpa/repository/searchparam/SearchParameterMapRepositoryRestQueryBuilder.java - Server request → FHIR database: handles resources