AmeriHealth Caritas Healthcare Service API

The HealthcareService FHIR resource type

Documentation GitHub OpenAPI

Operations 21

GET /HealthcareService/{id} read-instance: Read HealthcareService instance #

PUT /HealthcareService/{id} update-instance: Update an existing HealthcareService instance, or create using… #

DELETE /HealthcareService/{id} instance-delete: Perform a logical delete on a resource instance #

PATCH /HealthcareService/{id} instance-patch: Patch a resource instance of type HealthcareService by ID #

GET /HealthcareService/{id}/_history/{version_id} vread-instance: Read HealthcareService instance with specific version #

GET /HealthcareService search-type: Search for HealthcareService instances #

POST /HealthcareService create-type: Create a new HealthcareService instance #

GET /HealthcareService/_history type-history: Fetch the resource change history for all resources of type… #

GET /HealthcareService/{id}/_history instance-history: Fetch the resource change history for all resources of type… #

GET /HealthcareService/$validate Get healthcare service $validate #

GET /HealthcareService/{id}/$validate Get healthcare service by id $validate #

POST /HealthcareService/{id}/$meta-delete Create healthcare service by id $meta delete #

POST /HealthcareService/{id}/$meta-add Create healthcare service by id $meta add #

GET /HealthcareService/$meta Get healthcare service $meta #

GET /HealthcareService/{id}/$meta Get healthcare service by id $meta #

POST /HealthcareService/$expunge Create healthcare service $expunge #

POST /HealthcareService/{id}/$expunge Create healthcare service by id $expunge #

GET /HealthcareService/{id}/$graphql Get healthcare service by id $graphql #

POST /HealthcareService/{id}/$binary-access-write Create healthcare service by id $binary access write #

GET /HealthcareService/{id}/$binary-access-read Get healthcare service by id $binary access read #

GET /HealthcareService/{id}/$diff Comparte two resources or two versions of a single resource #

Work with this as data

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-healthcare-service-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AmeriHealth Caritas Healthcare Service API
  contact: {}
  version: 1.0.0
  description: The HealthcareService FHIR resource type
servers:
- url: https://api-ext.amerihealthcaritas.com/0500/patient-api
  description: AmeriHealth Caritas
security:
- openId:
  - openid
  - fhirUser
tags:
- name: Healthcare Service
  description: The HealthcareService FHIR resource type
paths:
  /HealthcareService/{id}:
    get:
      tags:
      - Healthcare Service
      summary: 'read-instance: Read HealthcareService 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: getHealthcareServiceById
      x-operation-id-source: derived
    put:
      tags:
      - Healthcare Service
      summary: 'update-instance: Update an existing HealthcareService instance, or create using…'
      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\": \"HealthcareService\"\n}"
          application/fhir+xml:
            schema:
              $ref: '#/components/schemas/FHIR-XML-RESOURCE'
            example: <HealthcareService 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: putHealthcareServiceById
      x-operation-id-source: derived
    delete:
      tags:
      - Healthcare Service
      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: deleteHealthcareServiceById
      x-operation-id-source: derived
    patch:
      tags:
      - Healthcare Service
      summary: 'instance-patch: Patch a resource instance of type HealthcareService 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: patchHealthcareServiceById
      x-operation-id-source: derived
  /HealthcareService/{id}/_history/{version_id}:
    get:
      tags:
      - Healthcare Service
      summary: 'vread-instance: Read HealthcareService 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: getHealthcareServiceByIdHistoryByVersionId
      x-operation-id-source: derived
  /HealthcareService:
    get:
      tags:
      - Healthcare Service
      summary: 'search-type: Search for HealthcareService instances'
      description: This is a search type
      parameters:
      - name: identifier-system-hcs-unique
        in: query
        style: simple
      - name: identifier
        in: query
        description: External identifiers for this item
        style: simple
      - name: specialty
        in: query
        description: The specialty of the service provided by this healthcare service
        style: simple
      - name: service-category
        in: query
        description: Service Category of the Healthcare Service
        style: simple
      - name: resource-placeholder
        in: query
        description: Search for resources of type [HealthcareService] populated with the resource-placeholder extension
        style: simple
      - name: service-type
        in: query
        description: The type of service provided by this healthcare service
        style: simple
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by the given range
        style: simple
      - name: _security
        in: query
        description: Search for resources which have the given security labels
        style: simple
      - name: active
        in: query
        description: The Healthcare Service is currently marked as active
        style: simple
      - name: program
        in: query
        description: One of the Programs supported by this HealthcareService
        style: simple
      - name: characteristic
        in: query
        description: One of the HealthcareService's characteristics
        style: simple
      - name: endpoint
        in: query
        description: Technical endpoints providing access to electronic services operated for the healthcare service
        style: simple
      - name: identifier-system-hcs
        in: query
        description: A healthcare service identifier with system HCS
        style: simple
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        style: simple
      - name: coverage-area
        in: query
        description: Location(s) service is intended for/available to
        style: simple
      - name: organization
        in: query
        description: The organization that provides this Healthcare Service
        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: name
        in: query
        description: A portion of the Healthcare service name
        style: simple
      - name: location
        in: query
        description: The location of the Healthcare Service
        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
      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: getHealthcareService
      x-operation-id-source: derived
    post:
      tags:
      - Healthcare Service
      summary: 'create-type: Create a new HealthcareService instance'
      requestBody:
        content:
          application/fhir+json:
            schema:
              $ref: '#/components/schemas/FHIR-JSON-RESOURCE'
            example: "{\n  \"resourceType\": \"HealthcareService\"\n}"
          application/fhir+xml:
            schema:
              $ref: '#/components/schemas/FHIR-XML-RESOURCE'
            example: <HealthcareService 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: postHealthcareService
      x-operation-id-source: derived
  /HealthcareService/_history:
    get:
      tags:
      - Healthcare Service
      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: getHealthcareServiceHistory
      x-operation-id-source: derived
  /HealthcareService/{id}/_history:
    get:
      tags:
      - Healthcare Service
      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: getHealthcareServiceByIdHistory
      x-operation-id-source: derived
  /HealthcareService/$validate:
    get:
      tags:
      - Healthcare Service
      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 healthcare service $validate
      x-summary-source: derived
      operationId: getHealthcareService$validate
      x-operation-id-source: derived
  /HealthcareService/{id}/$validate:
    get:
      tags:
      - Healthcare Service
      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 healthcare service by id $validate
      x-summary-source: derived
      operationId: getHealthcareServiceById$validate
      x-operation-id-source: derived
  /HealthcareService/{id}/$meta-delete:
    post:
      tags:
      - Healthcare Service
      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 healthcare service by id $meta delete
      x-summary-source: derived
      operationId: postHealthcareServiceById$metaDelete
      x-operation-id-source: derived
  /HealthcareService/{id}/$meta-add:
    post:
      tags:
      - Healthcare Service
      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 healthcare service by id $meta add
      x-summary-source: derived
      operationId: postHealthcareServiceById$metaAdd
      x-operation-id-source: derived
  /HealthcareService/$meta:
    get:
      tags:
      - Healthcare Service
      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 healthcare service $meta
      x-summary-source: derived
      operationId: getHealthcareService$meta
      x-operation-id-source: derived
  /HealthcareService/{id}/$meta:
    get:
      tags:
      - Healthcare Service
      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 healthcare service by id $meta
      x-summary-source: derived
      operationId: getHealthcareServiceById$meta
      x-operation-id-source: derived
  /HealthcareService/$expunge:
    post:
      tags:
      - Healthcare Service
      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 healthcare service $expunge
      x-summary-source: derived
      operationId: postHealthcareService$expunge
      x-operation-id-source: derived
  /HealthcareService/{id}/$expunge:
    post:
      tags:
      - Healthcare Service
      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 healthcare service by id $expunge
      x-summary-source: derived
      operationId: postHealthcareServiceById$expunge
      x-operation-id-source: derived
  /HealthcareService/{id}/$graphql:
    get:
      tags:
      - Healthcare Service
      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 healthcare service by id $graphql
      x-summary-source: derived
      operationId: getHealthcareServiceById$graphql
      x-operation-id-source: derived
  /HealthcareService/{id}/$binary-access-write:
    post:
      tags:
      - Healthcare Service
      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 healthcare service by id $binary access write
      x-summary-source: derived
      operationId: postHealthcareServiceById$binaryAccessWrite
      x-operation-id-source: derived
  /HealthcareService/{id}/$binary-access-read:
    get:
      tags:
      - Healthcare Service
      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 healthcare service by id $binary access read
      x-summary-source: derived
      operationId: getHealthcareServiceById$binaryAccessRead
      x-operation-id-source: derived
  /HealthcareService/{id}/$diff:
    get:
      tags:
      - Healthcare Service
      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: getHealthcareServiceById$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

AmeriHealth Caritas Healthcare Service API

Operations 21

Documentation

Specifications

Schemas & Data

Other Resources