FHIR

Get clinical data status

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/status

Get event and entity counts for the workspace's clinical data.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses

200

Successful Response

application/json

configuredbooleanRequired

ehr_typeany ofOptional

stringOptional

or

nullOptional

fhir_store_urlany ofOptional

stringOptional

or

nullOptional

event_countintegerRequired

entity_countintegerRequired

last_poll_atany ofOptional

stringOptional

or

nullOptional

last_change_atany ofOptional

stringOptional

or

nullOptional

sync_healthyany ofOptional

booleanOptional

or

nullOptional

sync_failure_countintegerOptionalDefault: 0

401

Missing or invalid API key.

404

Workspace not found.

get

/v1/{workspace_id}/fhir/status

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/status HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configured": true,
  "ehr_type": "text",
  "fhir_store_url": "text",
  "event_count": 1,
  "entity_count": 1,
  "entity_type_counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "resource_type_counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "last_poll_at": "text",
  "last_change_at": "text",
  "sync_healthy": true,
  "sync_failure_count": 0
}

List sync failures

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/sync-failures

Get events that permanently failed to sync to the external EHR. These need manual attention.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

limitinteger · min: 1 · max: 100OptionalDefault: 50

Responses

200

Successful Response

application/json

totalintegerRequired

401

Missing or invalid API key.

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/sync-failures

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/sync-failures HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "failures": [
    {
      "event_id": "text",
      "event_type": "text",
      "fhir_resource_type": "text",
      "fhir_resource_id": "text",
      "sync_error": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "entity_id": "text",
      "synced_at": "text",
      "created_at": "text"
    }
  ],
  "total": 1
}

Import FHIR Bundle

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/import

Import a FHIR Bundle. Decomposes into events and creates patient entities.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Body

application/json

sourcestringOptionalDefault: fhir_import

source_systemany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

events_createdintegerRequired

events_skippedintegerOptionalDefault: 0

events_updatedintegerOptionalDefault: 0

entities_createdintegerRequired

entities_updatedintegerRequired

errorsstring[]Optional

400

Invalid bundle format.

422

Validation Error

application/json

post

/v1/{workspace_id}/fhir/import

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/fhir/import HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "bundle": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "source": "fhir_import",
  "source_system": "text"
}

{
  "events_created": 1,
  "events_skipped": 0,
  "events_updated": 0,
  "entities_created": 1,
  "entities_updated": 1,
  "errors": [
    "text"
  ]
}

Search patients

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/patients

Search patient entities by name, MRN, or phone.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

qany ofOptional

Search by name

stringOptional

or

nullOptional

mrnany ofOptional

Search by MRN

stringOptional

or

nullOptional

phoneany ofOptional

Search by phone

stringOptional

or

nullOptional

limitinteger · min: 1 · max: 100OptionalDefault: 20

offsetintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

totalintegerRequired

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/patients

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/patients HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "patients": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "total": 1
}

Patient timeline

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/patients/{patient_id}/timeline

Get the full event timeline for a patient entity.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

patient_idstringRequired

Query parameters

domainany ofOptional

stringOptional

or

nullOptional

limitinteger · min: 1 · max: 200OptionalDefault: 50

offsetintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

entity_idstringRequired

totalintegerRequired

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/patients/{patient_id}/timeline

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/patients/{patient_id}/timeline HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entity_id": "text",
  "events": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "total": 1
}

Patient summary

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/patients/{patient_id}/summary

Get the agent-maintained world model state for a patient.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

patient_idstringRequired

Responses

200

Successful Response

application/json

entity_idstringRequired

entity_typestringRequired

display_nameany ofRequired

stringOptional

or

nullOptional

event_countintegerRequired

last_event_atany ofRequired

string · date-timeOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/patients/{patient_id}/summary

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/patients/{patient_id}/summary HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entity_id": "text",
  "entity_type": "text",
  "display_name": "text",
  "state": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "event_count": 1,
  "last_event_at": "2026-03-22T05:03:42.369Z"
}

Search FHIR resources

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/resources/{resource_type}

Search FHIR resources by type with standard search parameters.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

resource_typestringRequired

Query parameters

_countinteger · min: 1 · max: 100OptionalDefault: 20

_offsetintegerOptionalDefault: 0

nameany ofOptional

stringOptional

or

nullOptional

identifierany ofOptional

stringOptional

or

nullOptional

birthdateany ofOptional

stringOptional

or

nullOptional

dateany ofOptional

stringOptional

or

nullOptional

patientany ofOptional

stringOptional

or

nullOptional

statusany ofOptional

stringOptional

or

nullOptional

qany ofOptional

General search text

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

resource_typestringRequired

totalany ofRequired

integerOptional

or

nullOptional

next_urlany ofOptional

stringOptional

or

nullOptional

400

Invalid resource type.

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/resources/{resource_type}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/resources/{resource_type} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resource_type": "text",
  "total": 1,
  "entries": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "next_url": "text"
}

Create a FHIR resource

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/resources/{resource_type}

Create a new FHIR resource. Automatically creates patient entities.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

resource_typestringRequired

Body

application/json

Responses

201

Successful Response

application/json

400

Invalid resource type or payload.

422

Validation Error

application/json

post

/v1/{workspace_id}/fhir/resources/{resource_type}

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/fhir/resources/{resource_type} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "resource_type": "text",
  "resource_id": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get a FHIR resource

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}

Fetch a single FHIR resource by type and ID.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

resource_typestringRequired

resource_idstringRequired

Responses

200

Successful Response

application/json

resource_typestringRequired

resource_idstringRequired

400

Invalid resource type.

404

Resource not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resource_type": "text",
  "resource_id": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update a FHIR resource

put

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}

Update a FHIR resource. Creates a new event that supersedes the old one.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

resource_typestringRequired

resource_idstringRequired

Body

application/json

Responses

200

Successful Response

application/json

resource_typestringRequired

resource_idstringRequired

400

Invalid resource type or payload.

404

Resource not found.

422

Validation Error

application/json

put

/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "resource_type": "text",
  "resource_id": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}