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/amerihealth-caritas-encounter-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: 3.2.0
info:
title: AmeriHealth Caritas Encounter API
contact: {}
version: 1.0.0
description: The Encounter FHIR resource type
servers:
- url: https://api-ext.amerihealthcaritas.com/0500/patient-api
description: AmeriHealth Caritas
security:
- openId:
- openid
- fhirUser
tags:
- name: Encounter
description: The Encounter FHIR resource type
paths:
/Encounter/{id}:
get:
tags:
- Encounter
summary: 'read-instance: Read Encounter instance'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounterById
x-operation-id-source: derived
put:
tags:
- Encounter
summary: 'update-instance: Update an existing Encounter instance, or create using a…'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Encounter\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Encounter xmlns="http://hl7.org/fhir"/>
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: putEncounterById
x-operation-id-source: derived
delete:
tags:
- Encounter
summary: 'instance-delete: Perform a logical delete on a resource instance'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: deleteEncounterById
x-operation-id-source: derived
patch:
tags:
- Encounter
summary: 'instance-patch: Patch a resource instance of type Encounter by ID'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: "<Parameters xmlns=\"http://hl7.org/fhir\">\n <parameter>\n <name value=\"operation\"/>\n <part>\n <name value=\"type\"/>\n <valueString value=\"add\"/>\n </part>\n <part>\n <name value=\"path\"/>\n <valueString value=\"Patient\"/>\n </part>\n <part>\n <name value=\"name\"/>\n <valueString value=\"birthDate\"/>\n </part>\n <part>\n <name value=\"value\"/>\n <valueDate value=\"1930-01-01\"/>\n </part>\n </parameter>\n</Parameters>"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: patchEncounterById
x-operation-id-source: derived
/Encounter/{id}/_history/{version_id}:
get:
tags:
- Encounter
summary: 'vread-instance: Read Encounter instance with specific version'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '1'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounterByIdHistoryByVersionId
x-operation-id-source: derived
/Encounter:
get:
tags:
- Encounter
summary: 'search-type: Search for Encounter instances'
description: This is a search type
parameters:
- name: date
in: query
description: A date within the period the Encounter lasted
style: simple
- name: participant-type
in: query
description: Role of participant in encounter
style: simple
- name: subject
in: query
description: The patient or group present at the encounter
style: simple
- name: resource-placeholder
in: query
description: Search for resources of type [Encounter] populated with the resource-placeholder extension
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
style: simple
- name: appointment
in: query
description: The appointment that scheduled this encounter
style: simple
- name: part-of
in: query
description: Another Encounter this encounter is part of
style: simple
- name: type
in: query
description: Specific type of encounter
style: simple
- name: participant
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: reason-code
in: query
description: Coded reason the encounter takes place
style: simple
- name: based-on
in: query
description: The ServiceRequest that initiated this encounter
style: simple
- name: patient
in: query
description: The patient or group present at the encounter
style: simple
- name: identifier-system-tx-unique
in: query
style: simple
- name: location-period
in: query
description: Time period during which the patient was present at the location
style: simple
- name: special-arrangement
in: query
description: Wheelchair, translator, stretcher, etc.
style: simple
- name: class
in: query
description: Classification of patient encounter
style: simple
- name: identifier
in: query
description: Identifier(s) by which this encounter is known
style: simple
- name: practitioner
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: episode-of-care
in: query
description: Episode(s) of care that this encounter should be recorded against
style: simple
- name: length
in: query
description: Length of encounter in days
style: simple
- name: _security
in: query
description: Search for resources which have the given security labels
style: simple
- name: diagnosis
in: query
description: The diagnosis or procedure relevant to the encounter
style: simple
- name: identifier-system-tx
in: query
description: An encounter identifier with system TX
style: simple
- name: _profile
in: query
description: Search for resources which have the given profile
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _tag
in: query
description: Search for resources which have the given tag
style: simple
- name: reason-reference
in: query
description: Reason the encounter takes place (reference)
style: simple
- name: service-provider
in: query
description: The organization (facility) responsible for this encounter
style: simple
- name: location
in: query
description: Location the encounter takes place
style: simple
- name: _source
in: query
description: Search for resources which have the given source value (Resource.meta.source)
style: simple
- name: _id
in: query
description: The ID of the resource
style: simple
- name: _content
in: query
description: Search the contents of the resource's data using a fulltext search
style: simple
- name: _text
in: query
description: Search the contents of the resource's narrative using a fulltext search
style: simple
- name: account
in: query
description: The set of accounts that may be used for billing for this Encounter
style: simple
- name: status
in: query
description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounter
x-operation-id-source: derived
post:
tags:
- Encounter
summary: 'create-type: Create a new Encounter instance'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Encounter\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Encounter xmlns="http://hl7.org/fhir"/>
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: postEncounter
x-operation-id-source: derived
/Encounter/_history:
get:
tags:
- Encounter
summary: 'type-history: Fetch the resource change history for all resources of type…'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounterHistory
x-operation-id-source: derived
/Encounter/{id}/_history:
get:
tags:
- Encounter
summary: 'instance-history: Fetch the resource change history for all resources of type…'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounterByIdHistory
x-operation-id-source: derived
/Encounter/$validate:
get:
tags:
- Encounter
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter $validate
x-summary-source: derived
operationId: getEncounter$validate
x-operation-id-source: derived
/Encounter/{id}/$validate:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter by id $validate
x-summary-source: derived
operationId: getEncounterById$validate
x-operation-id-source: derived
/Encounter/{id}/$meta-delete:
post:
tags:
- Encounter
description: Delete tags, profiles, and/or security labels from a resource
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n }, {\n \"name\": \"return\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Create encounter by id $meta delete
x-summary-source: derived
operationId: postEncounterById$metaDelete
x-operation-id-source: derived
/Encounter/{id}/$meta-add:
post:
tags:
- Encounter
description: Add tags, profiles, and/or security labels to a resource
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n }, {\n \"name\": \"return\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Create encounter by id $meta add
x-summary-source: derived
operationId: postEncounterById$metaAdd
x-operation-id-source: derived
/Encounter/$meta:
get:
tags:
- Encounter
description: Request a list of tags, profiles, and security labels for a specfic resource instance
parameters:
- name: return
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter $meta
x-summary-source: derived
operationId: getEncounter$meta
x-operation-id-source: derived
/Encounter/{id}/$meta:
get:
tags:
- Encounter
description: Request a list of tags, profiles, and security labels for a specfic resource instance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: return
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter by id $meta
x-summary-source: derived
operationId: getEncounterById$meta
x-operation-id-source: derived
/Encounter/$expunge:
post:
tags:
- Encounter
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n }, {\n \"name\": \"count\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Create encounter $expunge
x-summary-source: derived
operationId: postEncounter$expunge
x-operation-id-source: derived
/Encounter/{id}/$expunge:
post:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n }, {\n \"name\": \"count\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Create encounter by id $expunge
x-summary-source: derived
operationId: postEncounterById$expunge
x-operation-id-source: derived
/Encounter/$everything:
get:
tags:
- Encounter
parameters:
- name: _count
in: query
description: Results from this method are returned across multiple pages. This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
required: false
style: simple
- name: _content
in: query
description: Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _text
in: query
description: Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _filter
in: query
description: Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _type
in: query
description: Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter $everything
x-summary-source: derived
operationId: getEncounter$everything
x-operation-id-source: derived
/Encounter/{id}/$everything:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: _count
in: query
description: Results from this method are returned across multiple pages. This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
required: false
style: simple
- name: _content
in: query
description: Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _text
in: query
description: Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _filter
in: query
description: Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _type
in: query
description: Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter by id $everything
x-summary-source: derived
operationId: getEncounterById$everything
x-operation-id-source: derived
/Encounter/{id}/$graphql:
get:
tags:
- Encounter
description: This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter by id $graphql
x-summary-source: derived
operationId: getEncounterById$graphql
x-operation-id-source: derived
/Encounter/{id}/$binary-access-write:
post:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"path\",\n \"valueString\": \"example\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Create encounter by id $binary access write
x-summary-source: derived
operationId: postEncounterById$binaryAccessWrite
x-operation-id-source: derived
/Encounter/{id}/$binary-access-read:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: path
in: query
required: true
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
summary: Get encounter by id $binary access read
x-summary-source: derived
operationId: getEncounterById$binaryAccessRead
x-operation-id-source: derived
/Encounter/{id}/$diff:
get:
tags:
- Encounter
summary: Comparte two resources or two versions of a single resource
description: This operation examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: from
in: query
description: The resource ID and version to diff from
required: true
style: simple
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
style: simple
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in the diff
required: false
style: simple
example: 'false'
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
style: simple
example: Patient/example/version/1
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
operationId: getEncounterById$diff
x-operation-id-source: derived
components:
schemas:
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
securitySchemes:
openId:
type: openIdConnect
openIdConnectUrl: https://api-ext.amerihealthcaritas.com/0500/patient-api/.well-known/smart-configuration