HAPI FHIR API

HAPI FHIR API as documented publicly: 4 operations. Contract generated from the documentation by API Evangelist (2026-10-14); not the provider's own document.

Operations 4

GET /Patient Search #
POST /Patient Type Level - Create #
PUT /Patient/{patientId} Server Pointcuts #
POST /fhir Submit payer content #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hapi-fhir:hapi-fhir-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hapi-fhir-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: HAPI FHIR API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 4 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HAPI FHIR has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 4
    pages-with-code: 0
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations.html
  - https://hapifhir.io/hapi-fhir/docs/server_jpa/diff.html
  - https://hapifhir.io/hapi-fhir/docs/server_jpa/search.html
  - https://hapifhir.io/hapi-fhir/docs/server_jpa/elastic.html
  - https://hapifhir.io/hapi-fhir/docs/clinical_reasoning/caregaps.html
  - https://hapifhir.io/hapi-fhir/docs/clinical_reasoning/measures.html
  - https://hapifhir.io/hapi-fhir/docs/interceptors/server_pointcuts.html
  - https://hapifhir.io/hapi-fhir/docs/server_jpa_mdm/mdm_operations.html
  - https://hapifhir.io/hapi-fhir/docs/clinical_reasoning/plan_definitions.html
servers:
- url: http://your-server-base
paths:
  /Patient:
    get:
      operationId: get_Patient
      tags:
      - Patient
      summary: Search
      x-source: https://hapifhir.io/hapi-fhir/docs/server_jpa/search.html
      parameters:
      - name: _compartmentLastUpdated
        in: query
        required: false
        schema:
          type: string
        description: Non‑standard search parameter to find patients whose compartment data has changed within a given date range. Accepts a date
          range (e.g., ge2024-01-01&le2024-01-31).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_Patient
      tags:
      - Patient
      summary: Type Level - Create
      x-source: https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations.html
      parameters:
      - name: theConditionalUrl
        in: query
        required: false
        schema:
          type: string
        description: Conditional create URL, annotated with @ConditionalUrlParam String
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPatientRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPatientResponse'
      x-evidence:
        kind: documentation
  /Patient/{patientId}:
    put:
      operationId: put_Patient_patientId
      tags:
      - Patient
      summary: Server Pointcuts
      x-source: https://hapifhir.io/hapi-fhir/docs/interceptors/server_pointcuts.html
      parameters:
      - name: patientId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutPatientPatientidRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /fhir:
    post:
      operationId: post_fhir
      tags:
      - Fhir
      summary: Submit payer content
      x-source: https://hapifhir.io/hapi-fhir/docs/clinical_reasoning/caregaps.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostPatientRequest:
      type: object
      properties:
        Patient:
          type: string
          description: FHIR Patient resource in the POST body
      required:
      - Patient
    PostPatientResponse:
      type: object
      properties:
        MethodOutcome:
          type: string
          description: Contains the identity of the created resource and optional OperationOutcome
    PutPatientPatientidRequest:
      type: object
      properties:
        Content-Type:
          type: string
          description: application/json
      required:
      - Content-Type
tags:
- name: Fhir
- name: Patient