Medplum

Medplum Fhir API

Medplum's FHIR R4 REST API, as described by its own OpenAPI (https://api.medplum.com/openapi.json): batch/transaction, search, create (incl. conditional create via If-None-Exist), conditional update (upsert), $validate, read, update, patch, delete and history; OAuth2 / OpenID Connect, bearer and basic security schemes.

Documentation GitHub OpenAPI

Business capability

Healthcare Interoperability Operations BC-2900.60

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /fhir/R4 Batch or Transaction #

GET /fhir/R4/{resourceType} Search FHIR resources of a given type · Search #

Ask an LLM

“How do I list all the Patient resources stored in my Medplum project?”

“Can I pull back every Observation of one resource type in a single FHIR search?”

Tell an agent

Search all {resourceType} resources in the FHIR store.

Return a search bundle of every Practitioner record.

POST /fhir/R4/{resourceType} Create a new FHIR resource · Create Resource #

Ask an LLM

“How do I add a brand-new Patient record to the FHIR server?”

“Can I post a new Encounter resource and have the server assign its id?”

Tell an agent

Create a new {resourceType} resource in the FHIR store.

Add a new Patient record for the person I'm registering.

PUT /fhir/R4/{resourceType} Conditional Update #

POST /fhir/R4/{resourceType}/$validate Validate Resource #

GET /fhir/R4/{resourceType}/{id} Fetch one FHIR resource by its id · Read Resource #

Ask an LLM

“How do I fetch a single Patient by its FHIR id?”

“What does the current version of a specific FHIR resource look like right now?”

Tell an agent

Get the current {resourceType} with id {id}.

Open Patient {id} and show me its details.

PUT /fhir/R4/{resourceType}/{id} Replace an existing FHIR resource · Update Resource #

Ask an LLM

“How do I overwrite an existing FHIR resource with a complete new copy?”

“Can I send the whole updated Patient body to replace the stored one?”

Tell an agent

Replace {resourceType} {id} with the full updated resource I provide.

Save my fully edited version of Patient {id} over the stored record.

DELETE /fhir/R4/{resourceType}/{id} Delete a FHIR resource · Delete Resource #

Ask an LLM

“How do I remove a FHIR resource from my Medplum project?”

“Can I delete a duplicate Patient record by its id?”

Tell an agent destructive · confirm first

Delete {resourceType} {id}.

Remove the duplicate Patient with id {id}.

PATCH /fhir/R4/{resourceType}/{id} Partially update a FHIR resource · Patch Resource #

Ask an LLM

“How do I change just one field on a FHIR resource without resending the whole thing?”

“Can I update only a couple of fields on an existing Observation in place?”

Tell an agent

Patch only the changed fields on {resourceType} {id}.

Apply a partial patch to Patient {id} to fix its phone number.

GET /fhir/R4/{resourceType}/{id}/_history List the version history of a FHIR resource · Read Resource History #

Ask an LLM

“How can I see every change ever made to a Patient record?”

“Which past versions exist for a given FHIR resource?”

Tell an agent

Show the full version history of {resourceType} {id}.

List all past revisions of Patient {id}.

GET /fhir/R4/{resourceType}/{id}/_history/{versionId} Fetch a specific past version of a FHIR resource · Read Version #

Ask an LLM

“How do I retrieve an older version of a FHIR resource by its version id?”

“Can I see exactly what a Patient record looked like at a particular revision?”

Tell an agent

Get version {versionId} of {resourceType} {id}.

Show me Patient {id} as it was at version {versionId}.

Medplum Fhir API

Operations 11

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification