How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amigo FHIR API

The FHIR API from Amigo — 15 operation(s) for fhir.

Amigo FHIR API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FHIR. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 15 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

17 operations 15 paths 28 schemas 13 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo FHIR API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 13 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

FHIR 17
GET
/v1/{workspace_id}/fhir/status
Get clinical data status
fhir-status 1 param → 200404401
POST
/v1/{workspace_id}/fhir/import
Import FHIR Bundle
fhir-import 1 param body → 200400422
POST
/v1/{workspace_id}/fhir/import-stream
Import FHIR resources via NDJSON streaming
fhir-import-stream 6 params → 200400422
GET
/v1/{workspace_id}/fhir/views/patients
List patients (clinical view)
fhir-patients-view 5 params → 200422
GET
/v1/{workspace_id}/fhir/views/practitioners
List practitioners
fhir-practitioners-view 5 params → 200422
GET
/v1/{workspace_id}/fhir/views/locations
List locations
fhir-locations-view 5 params → 200422
GET
/v1/{workspace_id}/fhir/views/appointments
List appointments
fhir-appointments-view 5 params → 200422
GET
/v1/{workspace_id}/fhir/views/slots
List availability slots
fhir-slots-view 12 params → 200422
GET
/v1/{workspace_id}/fhir/views/organizations
List organizations
fhir-organizations-view 5 params → 200422
GET
/v1/{workspace_id}/fhir/patients
Search patients
fhir-patient-search 7 params → 200422
GET
/v1/{workspace_id}/fhir/patients/{patient_id}/timeline
Patient timeline
fhir-patient-timeline 5 params → 200422
GET
/v1/{workspace_id}/fhir/patients/{patient_id}/summary
Patient summary
fhir-patient-summary 2 params → 200422
GET
/v1/{workspace_id}/fhir/resources/{resource_type}
Search FHIR resources
fhir-search-resources 11 params → 200400422
POST
/v1/{workspace_id}/fhir/resources/{resource_type}
Create a FHIR resource
fhir-create-resource 2 params body → 201400422
GET
/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}/history
Get FHIR resource history
fhir-get-resource-history 5 params → 200400404422
GET
/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}
Get a FHIR resource
fhir-get-resource 3 params → 200400404422
PUT
/v1/{workspace_id}/fhir/resources/{resource_type}/{resource_id}
Update a FHIR resource
fhir-update-resource 3 params body → 200400404422

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are FhirPatientView (29 properties), FhirLocationView (18 properties), FhirAppointmentView (16 properties), FhirSlotView (15 properties). Each schema is shown below with its type and property counts.

FhirLocationView
object
18 properties 1 required
FhirStatusResponse
object
9 properties 3 required
FhirResourceResponse
object
4 properties 3 required
FhirSearchResponse
object
4 properties 3 required
FhirUnsupportedResourcePolicy
string
FhirImportRequest
object
6 properties 1 required
FhirPractitionerListResponse
object
4 properties 2 required
FhirWriteRequest
object
2 properties 1 required
FhirAppointmentView
object
16 properties 1 required
FhirPractitionerView
object
12 properties 1 required
PatientListItem
object
Typed patient list item — replaces untyped dict.
9 properties 1 required
FhirOrganizationListResponse
object
4 properties 2 required
PatientTimelineResponse
object
3 properties 3 required
FhirPatientListResponse
object
4 properties 2 required
FhirResourceHistoryResponse
object
6 properties 4 required
HTTPValidationError
object
1 property
FhirPatientView
object
29 properties 1 required
FhirImportResponse
object
13 properties 3 required
FhirAppointmentListResponse
object
4 properties 2 required
ValidationError
object
5 properties 3 required
FhirUnsupportedResourceItem
object
4 properties 2 required
FhirLocationListResponse
object
4 properties 2 required
FhirSlotListResponse
object
4 properties 2 required
FhirOrganizationView
object
10 properties 1 required
FhirSlotView
object
15 properties 1 required
FhirResourceHistoryEntry
object
12 properties 3 required
PatientSummaryResponse
object
12 properties 5 required
PatientSearchResponse
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-fhir-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo FHIR API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.