Skip to main content

API Reference

Complete list of all endpoints available on the FHIR ANT server.

Public Endpoints

These endpoints do not require authentication even when Dev Mode is off.

MethodPathDescription
GET/Server info
GET/healthHealth check
GET/metadataFHIR CapabilityStatement
GET/.well-known/smart-configurationSMART discovery
GET/favicon.icoFavicon

Authentication Endpoints

MethodPathDescription
POST/auth/registerRegister new user
POST/auth/loginLogin, returns JWT
POST/auth/tokenToken refresh / code exchange
POST/auth/revokeRevoke a token (RFC 7009)
POST/auth/logoutLogout (revoke current token)
GET/auth/authorizeOAuth authorization (show form)
POST/auth/authorizeOAuth authorization (submit)

Admin Endpoints

MethodPathDescription
POST/admin/unlock/<userId>Unlock locked account

Resource CRUD

MethodPathDescription
POST/<type>Create resource
GET/<type>/<id>Read resource
PUT/<type>/<id>Update resource
PATCH/<type>/<id>JSON Patch resource
DELETE/<type>/<id>Delete resource
DELETE/<type>Conditional delete
MethodPathDescription
GET/<type>Search by type
POST/<type>/_searchPOST-based search
POST/_searchSystem-level search (requires _type)

History

MethodPathDescription
GET/<type>/<id>/_history/<vid>Version read
GET/<type>/<id>/_historyInstance history
GET/<type>/_historyType history
GET/_historySystem history

Bundles

MethodPathDescription
POST/Transaction or batch Bundle

Compartments

MethodPathDescription
GET/<type>/<id>/$everythingCompartment everything
GET/<type>/<id>/<resourceType>Compartment search

Supported compartment types: Patient, Encounter, Practitioner, RelatedPerson, Device.

Operations

MethodPathDescription
ALL/$validateValidate a resource
ALL/<type>/$validateValidate against type
GET/POST/$fhirpathEvaluate FHIRPath
POST/$transformFHIR Mapping Language
GET/Composition/<id>/$documentGenerate document
GET/<type>/<id>/$metaGet resource meta
POST/<type>/<id>/$meta-addAdd meta tags
POST/<type>/<id>/$meta-deleteRemove meta tags
POST/$backupExport all data
POST/$restoreImport data

Terminology

MethodPathDescription
GET/POST/CodeSystem/<id>/$validate-codeValidate code
GET/POST/CodeSystem/$validate-codeValidate code (type-level)
GET/POST/ValueSet/<id>/$validate-codeValidate code in ValueSet
GET/POST/ValueSet/$validate-codeValidate code (type-level)
GET/POST/CodeSystem/<id>/$lookupCode lookup
GET/POST/CodeSystem/$lookupCode lookup (type-level)
GET/POST/ValueSet/<id>/$expandExpand ValueSet
GET/POST/ValueSet/$expandExpand (type-level)

Bulk Data Export

MethodPathDescription
GET/$exportSystem-level export
GET/Patient/$exportPatient-level export
GET/Group/<id>/$exportGroup-level export
GET/$export-poll-status/<id>Poll export job
DELETE/$export-poll-status/<id>Cancel export job
GET/$export-file/<id>/<file>Download export file