Powered by HAPI FHIR v7.7.18-SNAPSHOT
Showing documentation for 7.8.0
On this page:
  • Welcome to HAPI FHIR
  • 0.0 Table of Contents
  • 0.1 Changelog: 2023
  • 0.2 Changelog: 2022
  • 0.3 Changelog: 2021
  • 0.4 Changelog: 2020
  • 0.5 Changelog: 2019
  • 0.6 Changelog: 2018
  • 0.7 Changelog: 2017
  • 0.8 Changelog: 2016
  • 0.9 Changelog: 2015
  • 0.10 Changelog: 2014
    • 0.1    Changelog: 2023   
       Table of Contents

    Table of Contents

    0.0.1Table of Contents

     

    Welcome to HAPI FHIR!

    0.0.0 Welcome to HAPI FHIR
    0.0.0 Table of Contents
    0.0.1 Table of Contents
    0.1.0 Changelog: 2023
    0.1.1 Changelog: 2023
    0.1.2 Changelog
    0.1.3 HAPI FHIR 7.8.0 (TBD)
    0.1.4 HAPI FHIR 7.6.1 (Despina)
    0.1.5 HAPI FHIR 7.6.0 (Despina)
    0.1.6 HAPI FHIR 7.4.5 (Copernicus)
    0.1.7 HAPI FHIR 7.4.4 (Copernicus)
    0.1.8 HAPI FHIR 7.4.3 (Copernicus)
    0.1.9 HAPI FHIR 7.4.2 (Copernicus)
    0.1.10 HAPI FHIR 7.4.0 (Copernicus)
    0.1.11 HAPI FHIR 7.2.3 (Borealis)
    0.1.12 HAPI FHIR 7.2.2 (Borealis)
    0.1.13 HAPI FHIR 7.2.1 (Borealis)
    0.1.14 HAPI FHIR 7.2.0 (Borealis)
    0.1.15 HAPI FHIR 7.0.3 (Zed)
    0.1.16 HAPI FHIR 7.0.2 (Zed)
    0.1.17 HAPI FHIR 7.0.1 (Zed)
    0.1.18 HAPI FHIR 7.0.0 (Apollo)
    0.1.19 HAPI FHIR 6.8.7 (Yucatán)
    0.1.20 HAPI FHIR 6.8.6 (Yucatán)
    0.1.21 HAPI FHIR 6.8.5 (Yucatán)
    0.1.22 HAPI FHIR 6.8.4 (Yucatán)
    0.1.23 HAPI FHIR 6.8.3 (Yucatán)
    0.1.24 HAPI FHIR 6.8.2 (Yucatán)
    0.1.25 HAPI FHIR 6.8.1 (Yucatán)
    0.1.26 HAPI FHIR 6.8.0 (Yucatán)
    0.1.27 HAPI FHIR 6.6.2 (Xenon)
    0.1.28 HAPI FHIR 6.6.1 (Xenon)
    0.1.29 HAPI FHIR 6.6.0 (Xenon)
    0.1.30 HAPI FHIR 6.4.6 (Wizard)
    0.1.31 HAPI FHIR 6.4.5 (Wizard)
    0.1.32 HAPI FHIR 6.4.4 (Wizard)
    0.1.33 HAPI FHIR 6.4.3 (Wizard)
    0.1.34 HAPI FHIR 6.4.2 (Wizard)
    0.1.35 HAPI FHIR 6.4.1 (Vishwa)
    0.1.36 HAPI FHIR 6.2.5 (Vishwa)
    0.1.37 HAPI FHIR 6.2.4 (Vishwa)
    0.1.38 HAPI FHIR 6.2.3 (Vishwa)
    0.1.39 HAPI FHIR 6.10.5 (Prerelease)
    0.1.40 HAPI FHIR 6.10.4 (Zed)
    0.1.41 HAPI FHIR 6.10.3 (Zed)
    0.1.42 HAPI FHIR 6.10.2 (Zed)
    0.1.43 HAPI FHIR 6.10.1 (Zed)
    0.1.44 HAPI FHIR 6.10.0 (Zed)
    0.1.45 HAPI FHIR 5.5.0 (Prerelease)
    0.2.0 Changelog: 2022
    0.2.1 Changelog: 2022
    0.2.2 Changelog
    0.2.3 HAPI FHIR 6.4.0 (Vishwa)
    0.2.4 HAPI FHIR 6.2.2 (Vishwa)
    0.2.5 HAPI FHIR 6.2.1 (Vishwa)
    0.2.6 HAPI FHIR 6.2.0 (Vishwa)
    0.2.7 HAPI FHIR 6.1.3 (Unicorn)
    0.2.8 HAPI FHIR 6.1.2 (Unicorn)
    0.2.9 HAPI FHIR 6.1.1 (Unicorn)
    0.2.10 HAPI FHIR 6.1.0 (Unicorn)
    0.2.11 HAPI FHIR 6.0.5 (Tanuki)
    0.2.12 HAPI FHIR 6.0.4 (Tanuki)
    0.2.13 HAPI FHIR 6.0.3 (Tanuki)
    0.2.14 HAPI FHIR 6.0.2 (Tanuki)
    0.2.15 HAPI FHIR 6.0.1 (Tanuki)
    0.2.16 HAPI FHIR 6.0.0 (Tanuki)
    0.2.17 HAPI FHIR 5.7.6 (Sojourner)
    0.2.18 HAPI FHIR 5.7.5 (Sojourner)
    0.2.19 HAPI FHIR 5.7.4 (Sojourner)
    0.2.20 HAPI FHIR 5.7.3 (Sojourner)
    0.2.21 HAPI FHIR 5.7.2 (Sojourner)
    0.2.22 HAPI FHIR 5.7.1 (Sojourner)
    0.2.23 HAPI FHIR 5.7.0 (Sojourner)
    0.2.24 HAPI FHIR 5.6.4 (Raccoon)
    0.2.25 HAPI FHIR 5.6.3 (Raccoon)
    0.2.26 HAPI FHIR 5.5.7 (Quasar)
    0.2.27 HAPI FHIR 5.5.6 (Quasar)
    0.2.28 HAPI FHIR 5.5.5 (Quasar)
    0.3.0 Changelog: 2021
    0.3.1 Changelog: 2021
    0.3.2 Changelog
    0.3.3 HAPI FHIR 5.6.2 (Raccoon)
    0.3.4 HAPI FHIR 5.6.1 (Raccoon)
    0.3.5 HAPI FHIR 5.6.0 (Raccoon)
    0.3.6 HAPI FHIR 5.5.4 (Quasar)
    0.3.7 HAPI FHIR 5.5.3 (Quasar)
    0.3.8 HAPI FHIR 5.5.2 (Quasar)
    0.3.9 HAPI FHIR 5.5.1 (Quasar)
    0.3.10 HAPI FHIR 5.4.2 (Pangolin)
    0.3.11 HAPI FHIR 5.4.1 (Pangolin)
    0.3.12 HAPI FHIR 5.4.0 (Pangolin)
    0.3.13 HAPI FHIR 5.3.3 (Odyssey)
    0.3.14 HAPI FHIR 5.3.2 (Odyssey)
    0.3.15 HAPI FHIR 5.3.1 (Odyssey)
    0.3.16 HAPI FHIR 5.3.0 (Odyssey)
    0.3.17 HAPI FHIR 5.2.1 (Numbats)
    0.4.0 Changelog: 2020
    0.4.1 Changelog: 2020
    0.4.2 Changelog
    0.4.3 HAPI FHIR 5.2.0 (Numbat)
    0.4.4 HAPI FHIR 5.1.0 (Manticore)
    0.4.5 HAPI FHIR 5.0.2 (Labrador)
    0.4.6 HAPI FHIR 5.0.1 (Labrador)
    0.4.7 HAPI FHIR 5.0.0 (Labrador)
    0.4.8 HAPI FHIR 4.2.0 (Koala)
    0.5.0 Changelog: 2019
    0.5.1 Changelog: 2019
    0.5.2 Changelog
    0.5.3 HAPI FHIR 4.1.0 (Jitterbug)
    0.5.4 HAPI FHIR 4.0.3 (Igloo (Point Release))
    0.5.5 HAPI FHIR 4.0.0 (Igloo)
    0.5.6 HAPI FHIR 3.8.0 (Hippo)
    0.5.7 HAPI FHIR 3.7.0 (Gale)
    0.6.0 Changelog: 2018
    0.6.1 Changelog: 2018
    0.6.2 Changelog
    0.6.3 HAPI FHIR 3.6.0 (Food)
    0.6.4 HAPI FHIR 3.5.0
    0.6.5 HAPI FHIR 3.4.0
    0.6.6 HAPI FHIR 3.3.0
    0.6.7 HAPI FHIR 3.2.0
    0.7.0 Changelog: 2017
    0.7.1 Changelog: 2017
    0.7.2 Changelog
    0.7.3 HAPI FHIR 3.1.0
    0.7.4 HAPI FHIR 3.0.0
    0.7.5 HAPI FHIR 2.5
    0.7.6 HAPI FHIR 2.4
    0.7.7 HAPI FHIR 2.3
    0.8.0 Changelog: 2016
    0.8.1 Changelog: 2016
    0.8.2 Changelog
    0.8.3 HAPI FHIR 2.2
    0.8.4 HAPI FHIR 2.1
    0.8.5 HAPI FHIR 2.0
    0.8.6 HAPI FHIR 1.6
    0.8.7 HAPI FHIR 1.5
    0.8.8 HAPI FHIR 1.4
    0.9.0 Changelog: 2015
    0.9.1 Changelog: 2015
    0.9.2 Changelog
    0.9.3 HAPI FHIR 1.3
    0.9.4 HAPI FHIR 1.2
    0.9.5 HAPI FHIR 1.1
    0.9.6 HAPI FHIR 1.0
    0.9.7 HAPI FHIR 0.9
    0.10.0 Changelog: 2014
    0.10.1 Changelog: 2014
    0.10.2 Changelog
    0.10.3 HAPI FHIR 0.8
    0.10.4 HAPI FHIR 0.7
    0.10.5 HAPI FHIR 0.6
    0.10.6 HAPI FHIR 0.5
    0.10.7 HAPI FHIR 0.4
    0.10.8 HAPI FHIR 0.3
    0.10.9 HAPI FHIR 0.2
    0.10.10 HAPI FHIR 0.1
    1.0.0 Getting Started
    1.0.0 Introduction
    1.0.1 Introduction to HAPI FHIR
    1.0.2 Getting Started
    1.0.3 JSON Encoding
    1.1.0 FHIR and HAPI FHIR Versions
    1.1.1 FHIR and HAPI FHIR Versions
    1.2.0 HAPI FHIR Modules
    1.2.1 HAPI FHIR Modules
    1.3.0 Downloading and Importing
    1.3.1 Downloading/Importing HAPI FHIR
    1.3.2 Maven Users
    1.3.3 Gradle Users
    1.3.4 Snapshot Builds
    1.3.5 Dependencies
    1.4.0 FHIR R4B Support
    1.4.1 FHIR R4B
    2.0.0 Working With The FHIR Model
    2.0.0 Working With Resources
    2.0.1 Working with Resources
    2.0.2 Navigating Structures
    2.0.3 Convenience Methods
    2.0.4 Examples
    2.1.0 Parsing and Serializing
    2.1.1 Parsers and Serializers
    2.1.2 Parsing (aka Deserializing)
    2.1.3 Encoding (aka Serializing)
    2.1.4 Global Parser Configuration
    2.2.0 Resource References
    2.2.1 Resource References
    2.2.2 References in Client Code
    2.2.3 References in Server Code
    2.2.4 Versioned References
    2.2.5 Automatically Versioned References
    2.3.0 Profiles and Extensions
    2.3.1 Profiles and Extensions
    2.3.2 Extensions
    2.3.3 Sub-Extensions
    2.3.4 Retrieving Extension Values
    2.3.5 Custom Resource Structures
    2.4.0 Version Converters
    2.4.1 HL7 FHIR Converter
    2.5.0 Custom Structures
    2.5.1 Custom Structures
    2.5.2 Extending FHIR Resource Classes
    2.5.3 Using Custom Types in a Client
    2.5.4 Using Custom Types in a Server
    2.5.5 Custom Composite Extension Classes
    2.5.6 Custom Resource Structure
    2.6.0 Narrative Generation
    2.6.1 Narrative Generation
    2.6.2 Automatic Narrative Generation
    2.6.3 Built-in Narrative Templates
    2.6.4 Creating your own Templates
    2.6.5 Fragments Expressions in Thymeleaf Templates
    2.6.6 FHIRPath Expressions in Thymeleaf Templates
    2.7.0 Bundle Builder
    2.7.1 Bundle Builder
    2.7.2 Transaction Resource Create
    2.7.3 Transaction Resource Updates
    2.7.4 Transaction Patch
    2.7.5 Customizing the Bundle
    3.0.0 Client
    3.0.0 Introduction
    3.0.1 Client Introduction
    3.0.2 HTTP Providers
    3.1.0 Get Started ⚡
    3.1.1 Getting Started with the Client
    3.2.0 Generic (Fluent) Client
    3.2.1 Generic (Fluent) Client
    3.2.2 Fluent Calls
    3.2.3 Search
    3.2.4 Create - Type
    3.2.5 Read/VRead - Instance
    3.2.6 Delete - Instance
    3.2.7 Update - Instance
    3.2.8 Patch - Instance
    3.2.9 History - Server/Type/Instance
    3.2.10 Transaction - Server
    3.2.11 Capability Statement (metadata) - Server
    3.2.12 Extended Operations
    3.2.13 Built-In Operations - Process-Message
    3.2.14 Additional Properties
    3.2.15 ETags
    3.3.0 Annotation Client
    3.3.1 Annotation Client
    3.3.2 Configuring Encoding (JSON/XML)
    3.4.0 Client Configuration
    3.4.1 Client Configuration
    3.4.2 Performance
    3.4.3 Configuring the HTTP Client
    3.5.0 Client Examples
    3.5.1 Client Examples
    3.5.2 Transaction With Conditional Create
    3.5.3 Fetch all Pages of a Bundle
    3.5.4 Create Composition and Generate Document
    4.0.0 Plain Server
    4.0.0 REST Server Types
    4.0.1 HAPI FHIR Server Introduction
    4.1.0 Plain Server Introduction
    4.1.1 Creating A Plain Server
    4.1.2 Defining Resource Providers
    4.1.3 Deploying
    4.1.4 Testing Using Jetty
    4.1.5 Server Base URL (Web Address)
    4.1.6 Capability Statement / Server Metadata
    4.1.7 Controlling Response Contents / Encoding / Formatting
    4.2.0 Get Started ⚡
    4.2.1 Getting Started with HAPI FHIR Plain Server
    4.3.0 Resource Providers and Plain Providers
    4.3.1 Resource Providers and Plain Providers
    4.3.2 Resource Providers
    4.3.3 Plain Providers
    4.3.4 Common Method Parameters
    4.3.5 REST Exception/Error Handling
    4.3.6 Server Lifecycle Methods
    4.4.0 REST Operations: Overview
    4.4.1 REST Operations: Overview
    4.4.2 Instance Level - Read
    4.4.3 Instance Level - VRead
    4.4.4 Instance Level - Update
    4.4.5 Instance Level - Delete
    4.4.6 Instance Level - Patch
    4.4.7 Type Level - Create
    4.4.8 Type Level - Search
    4.4.9 Type Level - Validate
    4.4.10 System Level - Capabilities
    4.4.11 System Level - Transaction
    4.4.12 System Level - Search
    4.4.13 History (Instance, Type, Server)
    4.4.14 Exceptions
    4.4.15 Tags
    4.4.16 Handling _summary and _elements
    4.4.17 Compartments
    4.5.0 REST Operations: Search
    4.5.1 Rest Operations: Search
    4.5.2 Search with No Parameters
    4.5.3 Search Parameters: String Introduction
    4.5.4 Search Parameters: Token/Identifier
    4.5.5 Search Parameters: Date (Simple)
    4.5.6 Search Parameters: Date (Ranges)
    4.5.7 Search Parameters: Quantity
    4.5.8 Search Parameters: Resource Reference
    4.5.9 Search Parameters: Filter
    4.5.10 Chained Resource References
    4.5.11 Search Parameters: Composite
    4.5.12 Combining Multiple Parameters
    4.5.13 Multi-Valued (AND/OR) Parameters
    4.5.14 AND Relationship Query Parameters for Dates
    4.5.15 Resource Includes (_include)
    4.5.16 Reverse Resource Includes (_revinclude)
    4.5.17 Named Queries (_query)
    4.5.18 Sorting (_sort)
    4.5.19 Limiting results ()
    4.5.20 Paging
    4.5.21 Adding Descriptions
    4.6.0 REST Operations: Extended Operations
    4.6.1 REST Operations: Extended Operations
    4.6.2 Type-Level Operations
    4.6.3 Instance-Level Operations
    4.6.4 Server-Level Operations
    4.6.5 Using Search Parameter Types
    4.6.6 Returning Multiple OUT Parameters
    4.6.7 Accepting HTTP GET
    4.6.8 Manually handing Request/Response
    4.7.0 Paging Search Results
    4.7.1 Paging Responses
    4.7.2 Bundle Providers
    4.8.0 Web Testpage Overlay
    4.8.1 Web Testpage Overlay
    4.8.2 Adding the Overlay
    4.8.3 Customizing the Overlay
    4.8.4 A Complete Example
    4.8.5 Authentication
    4.9.0 Multitenancy
    4.9.1 Multitenancy
    4.9.2 URL Base Multitenancy
    4.10.0 JAX-RS Support
    4.10.1 JAX-RS Server
    4.10.2 JAX-RS Implementation specifics
    4.10.3 A Complete Example
    4.11.0 Customizing the CapabilityStatement
    4.11.1 Customizing the CapabilityStatement
    4.12.0 OpenAPI / Swagger
    4.12.1 OpenAPI / Swagger Support
    4.12.2 Enabling OpenAPI
    4.12.3 Demonstration
    5.0.0 JPA Server
    5.0.0 Introduction
    5.0.1 JPA Server Introduction
    5.1.0 Get Started ⚡
    5.1.1 Getting Started with HAPI FHIR JPA Server
    5.2.0 Architecture
    5.2.1 HAPI FHIR JPA Architecture
    5.2.2 Schema
    5.3.0 Database Support
    5.3.1 Database Support
    5.3.2 Experimental Support
    5.4.0 Database Schema
    5.4.1 HAPI FHIR JPA Schema
    5.4.2 Background: Persistent IDs (PIDs)
    5.4.3 HFJ_RESOURCE: Resource Master Table
    5.4.4 HFJ_RES_VER: Resource Versions and Contents
    5.4.5 HFJ_RES_LINK: Search Links
    5.4.6 Background: Search Indexes
    5.4.7 HFJ_SPIDX_DATE: Date Search Parameters
    5.4.8 HFJ_SPIDX_NUMBER: Number Search Parameters
    5.4.9 HFJ_SPIDX_QUANTITY: Quantity Search Parameters
    5.4.10 HFJ_SPIDX_QUANTITY_NRML: Normalized Quantity Search Parameters
    5.4.11 HFJ_SPIDX_STRING: String Search Parameters
    5.4.12 HFJ_SPIDX_TOKEN: Token Search Parameters
    5.4.13 HFJ_SPIDX_URI: URI Search Parameters
    5.4.14 HFJ_IDX_CMB_TOK_NU: Combo Non-Unique Search Param
    5.4.15 HFJ_IDX_CMP_STRING_UNIQ: Combo Unique Search Param
    5.5.0 Configuration
    5.5.1 JPA Server Configuration Options
    5.5.2 Search Result Caching
    5.5.3 Additional Information
    5.5.4 Cascading Deletes
    5.5.5 Version Conflicts
    5.5.6 Controlling Delete with Expunge size
    5.5.7 Disabling Non Resource DB History
    5.5.8 Prevent Conditional Updates to Invalidate Match Criteria
    5.6.0 Search
    5.6.1 JPA Server Search
    5.6.2 Limitations
    5.6.3 Uplifted Refchains and Chaining Performance
    5.6.4 Document and Message Search Parameters
    5.6.5 Chained Sorting
    5.6.6 _include and _revinclude order
    5.6.7 Custom Search Parameters
    5.7.0 Performance
    5.7.1 Performance
    5.7.2 History Counting
    5.7.3 Bulk Loading
    5.7.4 Disabling :text Indexing
    5.7.5 Disable Upsert Existence Check
    5.7.6 Disabling Non Resource DB History
    5.7.7 Enabling Index Storage Optimization
    5.8.0 Upgrade Guide
    5.8.1 HAPI FHIR JPA Upgrade Guide
    5.8.2 Database Partition Mode
    5.8.3 Oracle Support
    5.8.4 Oracle and Sql Server Locking Note
    5.8.5 Database Migration
    5.9.0 Diff Operation
    5.9.1 Diff Operation
    5.9.2 Diff Instance
    5.9.3 Diff Server
    5.10.0 LastN Operation
    5.10.1 LastN Operation
    5.10.2 Functional Overview and Parameters
    5.10.3 Limitations
    5.10.4 Deployment and Configuration
    5.11.0 Lucene/Elasticsearch Indexing
    5.11.1 HAPI FHIR JPA Lucene/Elasticsearch Indexing
    5.11.2 Performing Fulltext Search in Lucene/Elasticsearch
    5.11.3 Experimental Extended Lucene/Elasticsearch Indexing
    5.11.4 Synchronous Writes
    5.11.5 Sorting
    5.12.0 Terminology
    5.12.1 Terminology
    5.12.2 Versioning of Terminology
    5.12.3 Terminology Schemas
    5.13.0 International Patient Summary (IPS)
    5.13.1 International Patient Summary (IPS) Generator
    5.13.2 Overview
    5.13.3 Generation Strategy
    5.13.4 Narrative Templates
    5.13.5 Credits
    6.0.0 JPA Server: MDM
    6.0.0 MDM Getting Started
    6.0.1 MDM Getting Started
    6.1.0 MDM Rules
    6.1.1 Rules
    6.2.0 MDM Enterprise Identifiers
    6.2.1 MDM Enterprise Identifiers
    6.3.0 MDM Operations
    6.3.1 MDM Operations
    6.3.2 Querying The MDM
    6.4.0 MDM Technical Details
    6.4.1 MDM Implementation Details
    6.4.2 Automatic Linking
    6.4.3 HAPI MDM Technical Details
    6.5.0 MDM Search Expansion
    6.5.1 MDM Expansion
    6.6.0 MDM Customizations
    6.6.1 MDM Customizations
    6.6.2 Interceptors
    7.0.0 JPA Server: Partitioning and Multitenancy
    7.0.0 Partitioning and Multitenancy
    7.0.1 Partitioning and Multitenancy
    7.0.2 Architecture
    7.0.3 Partitioning and Resource IDs
    7.0.4 Partition Interceptors
    7.0.5 Complete Example: Using Request Tenants
    7.0.6 Limitations
    7.1.0 Partition Interceptor Examples
    7.1.1 Partition Interceptor Examples
    7.1.2 Example: Partitioning based on Tenant ID
    7.1.3 Example: Partitioning based on headers
    7.1.4 Example: Using Resource Contents
    7.1.5 Example: Always Read All Partitions
    7.1.6 Example: Smile CDR SMART Scopes
    7.2.0 Partitioning Management Operations
    7.2.1 Partition Mapping Operations
    7.2.2 Creating a Partition
    7.2.3 Updating a Partition
    7.2.4 Deleting a Partition
    7.2.5 Reading a Partition
    7.2.6 Listing all Partitions
    7.3.0 Enabling Partitioning in HAPI FHIR
    7.3.1 Enabling Partitioning in HAPI FHIR
    7.4.0 Database Partition Mode
    7.4.1 Database Partition Mode Introduction
    7.4.2 Database Partitioning
    7.4.3 Initializing and Upgrading your Database
    8.0.0 JPA Server: Batch Processing
    8.0.0 Batch Introduction
    8.0.1 HAPI-FHIR Batch Processing
    9.0.0 JPA Server: HFQL (SQL) Driver
    9.0.0 HFQL Module
    9.0.1 HFQL Driver: SQL For FHIR Repositories
    9.0.2 Syntax
    9.0.3 JDBC Driver
    10.0.0 Clinical Reasoning
    10.0.0 Clinical Reasoning Overview
    10.0.1 Clinical Reasoning
    10.1.0 CQL
    10.1.1 CQL
    10.2.0 Care Gaps
    10.2.1 Care Gaps
    10.3.0 Measures
    10.3.1 Measures
    10.4.0 ActivityDefinitions
    10.4.1 ActivityDefinition
    10.5.0 PlanDefinitions
    10.5.1 PlanDefinition
    10.6.0 Questionnaires
    10.6.1 Questionnaires
    11.0.0 Interceptors
    11.0.0 Interceptors Overview
    11.0.1 Interceptors: Overview
    11.0.2 Creating Interceptors
    11.1.0 Client Interceptors
    11.1.1 Client Interceptors
    11.1.2 Registering Client Interceptors
    11.2.0 Client Pointcuts
    11.2.1 Client Pointcuts
    11.3.0 Built-In Client Interceptors
    11.3.1 Built-In Client Interceptors
    11.3.2 Logging: Logging Interceptor
    11.3.3 Security: HTTP Basic Authorization
    11.3.4 Security: HTTP Bearer Token Authorization
    11.3.5 Misc: Add Headers to Request
    11.3.6 Misc: Add Cookies to Request
    11.3.7 Multitenancy: Add tenant ID to path
    11.3.8 Performance: GZip Outgoing Request Bodies
    11.3.9 Capture: Programmatically Capturing Request/Response Details
    11.4.0 Server Interceptors
    11.4.1 Server Interceptors
    11.4.2 Example: Clearing Tags
    11.5.0 Server Pointcuts
    11.5.1 Plain Server Pointcuts
    11.5.2 Storage / JPA Server Pointcuts
    11.6.0 Built-In Server Interceptors
    11.6.1 Built-In Server Interceptors
    11.6.2 Logging: Logging Interceptor
    11.6.3 Partitioning: Multitenant Request Partition
    11.6.4 Response Customizing: Syntax Highlighting
    11.6.5 Response Customizing: Exception Handling
    11.6.6 Response Customizing: Evaluate FHIRPath
    11.6.7 Response Customizing: Static CapabilityStatement
    11.6.8 Validation: Request and Response Validation
    11.6.9 Search: Allow Lenient Searching
    11.6.10 Security: CORS
    11.6.11 Security: Audit
    11.6.12 Security: Authorization
    11.6.13 Security: Binary Resources
    11.6.14 Security: Consent
    11.6.15 Security: Search Narrowing
    11.6.16 Security: Rejecting Unsupported HTTP Verbs
    11.6.17 Server: OpenAPI / Swagger Support
    11.6.18 Server: Interaction Blocking
    11.6.19 Subscription: Subscription Debug Log Interceptor
    11.6.20 Request Pre-Processing: Override Meta.source
    11.6.21 Terminology: Map Response Terminology
    11.6.22 Terminology: Populate Code Display Names
    11.6.23 Utility: ResponseSizeCapturingInterceptor
    11.6.24 JPA Server: Allow Cascading Deletes
    11.6.25 JPA Server: Disable Referential Integrity for Some Paths
    11.6.26 JPA Server: Block Resource Updates Changing Patient Compartment
    11.6.27 JPA Server: Retry on Version Conflicts
    11.6.28 JPA Server: Validate Data Being Stored
    11.6.29 Data Standardization
    11.6.30 Validation: Address Validation
    11.6.31 Validation: Field-Level Validation
    11.7.0 7.0.0 Migration Guide
    11.7.1 7.0.0 Interceptor Upgrade Guide
    12.0.0 Security
    12.0.0 Introduction
    12.0.1 REST Server Security: Introduction
    12.0.2 Authentication vs Authorization
    12.0.3 Authentication Interceptors
    12.1.0 Authorization Interceptor
    12.1.1 Authorization Interceptor
    12.1.2 Authorizing Read Operations
    12.1.3 Authorizing Write Operations
    12.1.4 Authorizing Sub-Operations
    12.1.5 Authorizing Patch Operations
    12.1.6 Authorizing Multitenant Servers
    12.1.7 Authorizing Bulk Export Operations
    12.1.8 Advanced Compartment authorization
    12.2.0 Consent Interceptor
    12.2.1 Consent Interceptor
    12.3.0 Search Narrowing Interceptor
    12.3.1 Search Narrowing Interceptor
    12.3.2 Narrowing Conditional URLs
    12.3.3 Constraining by ValueSet Membership
    12.3.4 ResultSet Narrowing
    12.4.0 CORS
    12.4.1 CORS (Cross-Origin Resource Sharing)
    12.4.2 HAPI FHIR CORS Interceptor
    12.4.3 CORS Servlet Filter
    12.5.0 Basic Audit Log Pattern (BALP)
    12.5.1 Basic Audit Log Patterns (BALP) Interceptor
    12.5.2 Architecture
    12.5.3 Audit Event Sink
    12.5.4 Audit Context Services
    12.5.5 Example
    12.6.0 Binary Resource Security Interceptor
    12.6.1 Binary Security Interceptor
    13.0.0 Validation
    13.0.0 Introduction
    13.0.1 Validation Introduction
    13.1.0 Parser Error Handler
    13.1.1 Parser Error Handler
    13.2.0 Instance Validator
    13.2.1 Instance Validator
    13.2.2 FHIR Conformance Concepts
    13.2.3 FHIR Instance Validator
    13.2.4 Running the Validator
    13.2.5 Validating Using Packages
    13.2.6 Migrating to HAPI FHIR 5.x
    13.3.0 Validation Support Modules
    13.3.1 Validation Support Modules
    13.3.2 Built-In Validation Support Classes
    13.3.3 ValidationSupportChain
    13.3.4 DefaultProfileValidationSupport
    13.3.5 InMemoryTerminologyServerValidationSupport
    13.3.6 PrePopulatedValidationSupport
    13.3.7 NpmPackageValidationSupport
    13.3.8 SnapshotGeneratingValidationSupport
    13.3.9 CommonCodeSystemsTerminologyService
    13.3.10 RemoteTerminologyServiceValidationSupport
    13.3.11 UnknownCodeSystemWarningValidationSupport
    13.3.12 CachingValidationSupport
    13.3.13 Recipes
    13.3.14 Recipe: Supplying Custom Definitions
    13.3.15 Recipe: Using a Remote Terminology Server
    13.4.0 Schema/Schematron Validator
    13.4.1 Schema / Schematron Validator
    13.4.2 Preparation
    13.4.3 Validating a Resource
    13.5.0 Repository Validating Interceptor
    13.5.1 Repository Validating Interceptor
    13.5.2 Benefits and Limitations
    13.5.3 Using the Repository Validating Interceptor
    13.5.4 Rules: Require Profile Declarations
    13.5.5 Rules: Require Validation to Declared Profiles
    13.5.6 Rules: Disallow Specific Profiles
    13.5.7 Adding Validation Outcome to HTTP Response
    13.6.0 Validation Examples
    13.6.1 Validation Examples
    14.0.0 Android
    14.0.0 Android Client
    14.0.1 Android Client
    14.0.2 Performance
    14.0.3 Examples
    15.0.0 Tools
    15.0.0 Command Line Interface (CLI) Tool
    15.0.1 Command Line Tool for HAPI FHIR
    15.0.2 Server (run-server)
    15.0.3 Upload Example Resources (upload-examples)
    15.0.4 Upload Terminology
    15.0.5 Migrate Database
    15.0.6 Clear Migration lock
    15.0.7 Reindex Terminology
    16.0.0 Contributing to HAPI FHIR
    16.0.0 Hacking Guide
    16.0.1 Hacking HAPI FHIR
    16.0.2 Understanding the HAPI FHIR Codebase
    16.0.3 Getting the Sources
    16.0.4 Building HAPI FHIR
    16.0.5 Rebuilding the Database Schema
    16.0.6 Troubleshooting
    16.0.7 Importing into Eclipse
    17.0.0 Appendix
    17.0.0 Logging
    17.0.1 Logging
    17.0.2 Configuring HAPI's Logging - SLF4j
    17.0.3 Client Payload Logging
    17.0.4 Server Request Logging
    17.0.5 Hibernate SQL Log Filtering
    17.1.0 FAQ
    17.1.1 Frequently Asked Questions
    17.1.2 Getting Help
    17.1.3 Using HAPI FHIR
    17.1.4 JPA Server
    17.1.5 Contributing
    17.2.0 JavaDocs
    17.2.1 JavaDocs
  • Welcome to HAPI FHIR
  • 0.0 Table of Contents
  • 0.1 Changelog: 2023
  • 0.2 Changelog: 2022
  • 0.3 Changelog: 2021
  • 0.4 Changelog: 2020
  • 0.5 Changelog: 2019
  • 0.6 Changelog: 2018
  • 0.7 Changelog: 2017
  • 0.8 Changelog: 2016
  • 0.9 Changelog: 2015
  • 0.10 Changelog: 2014
    • 0.1    Changelog: 2023