Aggregated in-person and virtual appointment discovery across a health system, returning available providers and timeslots filtered by location, specialty, visit type and date range. OpenAPI 3.0.3, version 1.0.0, 3 operations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/dexcare-care-options-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.0.3
info:
title: Care Options
description: DexCare Care Options API v1
version: 1.0.0
security:
- ApiKey: []
servers:
- url: https://api.{customerShorthand}.dexcare.io/v1
description: mTLS External Ingress
variables:
customerShorthand:
default: frosh
description: Customer's Short Name
paths:
/availability/providers:
post:
description: Search providers with availability by location
operationId: availableProvidersV1
security:
- ApiKey: []
summary: get available providers
tags:
- external
parameters:
- in: header
name: correlation-id
description: Unique id to correlate call logs between our microservices
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- description: Request body for searching available providers using latitude and longitude
for location.
type: object
required:
- latitude
- longitude
properties:
patient:
description: Patient information used to correlate a search request to an appointment
being booked
type: object
required:
- patientId
- patientIdType
- ehrInstance
properties:
patientId:
description: Patient EHR or DexCare identifier from , e.g. MRN
type: string
example: '900332632'
patientIdType:
description: EHR or DexCare identifier type for lookup
type: string
example: MRN
ehrInstance:
description: Patient EHR instance
type: string
example: ehr.region
ehrInstances:
description: EHR Instance Identifiers filter
type: array
items:
type: string
example:
- ehr.region.1
- ehr.region.2
visitTypeNames:
description: Health system defined visit type name filter.
type: array
items:
type: string
example:
- video
- phone
- in-clinic
departmentIds:
description: Department identifier filter.
type: array
items:
type: string
example:
- '5000101001'
- '5000311000'
specialty:
description: Provider specialty filter
type: string
example: Pediatrics
gender:
description: Provider gender filter
type: string
example: Female
latitude:
description: Latitude of target visit location
type: number
format: double
minimum: -90
maximum: 90
example: 47.610692
longitude:
description: Longitude of target visit location
type: number
format: double
minimum: -180
maximum: 180
example: -122.321216
radius:
description: Radius around target visit location in miles
type: integer
minimum: 1
maximum: 100
example: 30
default: 30
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Retail
- Primary Care
sortBy:
type: string
enum:
- nextAvailable
- mostAvailable
default: mostAvailable
description: "Sort By:\n * `nextAvailable` - Sort results by soonest available provider\n\
\ * `mostAvailable` - Sort results by most available provider\n"
- description: Request body for searching available providers using departments for location.
type: object
required:
- departmentIds
properties:
patient:
description: Patient information used to correlate a search request to an appointment
being booked
type: object
required:
- patientId
- patientIdType
- ehrInstance
properties:
patientId:
description: Patient EHR or DexCare identifier from , e.g. MRN
type: string
example: '900332632'
patientIdType:
description: EHR or DexCare identifier type for lookup
type: string
example: MRN
ehrInstance:
description: Patient EHR instance
type: string
example: ehr.region
ehrInstances:
description: EHR Instance Identifiers filter
type: array
items:
type: string
example:
- ehr.region.1
- ehr.region.2
visitTypeNames:
description: Health system defined visit type name filter.
type: array
items:
type: string
example:
- video
- phone
- in-clinic
departmentIds:
description: Department identifier filter.
type: array
items:
type: string
example:
- '5000101001'
- '5000311000'
specialty:
description: Provider specialty filter
type: string
example: Pediatrics
gender:
description: Provider gender filter
type: string
example: Female
latitude:
description: Latitude of target visit location
type: number
format: double
minimum: -90
maximum: 90
example: 47.610692
longitude:
description: Longitude of target visit location
type: number
format: double
minimum: -180
maximum: 180
example: -122.321216
postalCode:
description: Zip code of the target visit location. Cannot use in tandem with latitude
and longitude.
type: string
example: '98104'
radius:
description: Radius around target visit location in miles
type: integer
minimum: 1
maximum: 100
example: 30
default: 30
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Retail
- Primary Care
sortBy:
type: string
enum:
- nextAvailable
- mostAvailable
default: mostAvailable
description: "Sort By:\n * `nextAvailable` - Sort results by soonest available provider\n\
\ * `mostAvailable` - Sort results by most available provider\n"
- description: Request body for searching available providers using zip code for location.
type: object
required:
- postalCode
properties:
patient:
description: Patient information used to correlate a search request to an appointment
being booked
type: object
required:
- patientId
- patientIdType
- ehrInstance
properties:
patientId:
description: Patient EHR or DexCare identifier from , e.g. MRN
type: string
example: '900332632'
patientIdType:
description: EHR or DexCare identifier type for lookup
type: string
example: MRN
ehrInstance:
description: Patient EHR instance
type: string
example: ehr.region
ehrInstances:
description: EHR Instance Identifiers filter
type: array
items:
type: string
example:
- ehr.region.1
- ehr.region.2
visitTypeNames:
description: Health system defined visit type name filter.
type: array
items:
type: string
example:
- video
- phone
- in-clinic
departmentIds:
description: Department identifier filter.
type: array
items:
type: string
example:
- '5000101001'
- '5000311000'
specialty:
description: Provider specialty filter
type: string
example: Pediatrics
gender:
description: Provider gender filter
type: string
example: Female
postalCode:
description: Zip code of the target visit location.
type: string
example: '98104'
radius:
description: Radius around target visit location in miles
type: integer
minimum: 1
maximum: 100
example: 30
default: 30
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Retail
- Primary Care
sortBy:
type: string
enum:
- nextAvailable
- mostAvailable
default: mostAvailable
description: "Sort By:\n * `nextAvailable` - Sort results by soonest available provider\n\
\ * `mostAvailable` - Sort results by most available provider\n"
examples:
search-providers-by-location-using-departmentids:
summary: Request available providers using departments for location.
value:
patient:
patientId: '900332632'
patientIdType: MRN
ehrInstance: ehr.region
departmentIds:
- '3200080024'
- '405517000'
ehrInstances:
- ehr.region.1
- ehr.region.2
visitTypeNames:
- NewPatient
- NewSymptoms
clinicTypes:
- Primary Care
gender: female
specialty: Pediatrics
radius: 30
sortBy: mostAvailable
search-providers-by-location-using-lat-lon:
summary: Request available providers using latitude and longitude for location.
value:
patient:
patientId: '900332632'
patientIdType: MRN
ehrInstance: ehr.region
ehrInstances:
- ehr.region.1
- ehr.region.2
visitTypeNames:
- NewPatient
- NewSymptoms
clinicTypes:
- Primary Care
gender: female
specialty: Pediatrics
latitude: 47.610692
longitude: -122.321216
radius: 30
sortBy: mostAvailable
search-providers-by-location-using-zipcode:
summary: Request available providers using postal code for location
value:
patient:
patientId: '900332632'
patientIdType: MRN
ehrInstance: ehr.region
ehrInstances:
- ehr.region.1
- ehr.region.2
visitTypeNames:
- NewPatient
- NewSymptoms
clinicTypes:
- Primary Care
gender: female
specialty: Pediatrics
postalCode: '98104'
radius: 30
sortBy: mostAvailable
responses:
'200':
description: Search providers with availability by location response body
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
description: Search available providers successful response body
required:
- npi
- name
- specialties
- gender
- departmentId
- departmentName
- ehrInstance
- address
- timezone
- distanceFrom
- visitTypes
properties:
npi:
description: National provider id
type: string
example: '1245662048'
name:
description: Provider name
type: string
example: Jane Doe
gender:
description: Provider gender
type: string
nullable: true
example: Female
specialties:
description: Provider specialties
type: array
items:
type: string
example:
- Family Medicine
- Internal Medicine
departmentId:
description: Provider's department id
type: string
example: '3200080024'
departmentName:
description: Provider's department name
type: string
example: Seattle Medical Center
ehrInstance:
description: Department EHR Instance
type: string
example: ehr.region
clinicType:
description: Clinic type
type: string
example: Primary Care
address:
type: object
description: Department address
properties:
line1:
type: string
example: 2324 Eastlake Ave E
line2:
type: string
example: Suite 500
city:
type: string
example: Seattle
state:
type: string
example: WA
zipCode:
type: string
example: '98102'
postalCode:
type: string
example: '98102'
timezone:
description: Department timezone
type: string
example: America/Los_Angeles
distanceFrom:
description: Distance (in miles) from target visit location argument
type: number
format: decimal
example: 10.4
visitTypes:
type: array
items:
description: Aggregated slot availability for a provider by health system
defined visit type
type: object
required:
- visitTypeId
- visitTypeName
- availability
properties:
visitTypeId:
type: string
description: Health system defined visit type id
example: '124532'
visitTypeName:
type: string
description: Health system defined visit type name
example: Video
availability:
description: Aggregated slot availability for a provider for a health
system defined visit type
type: object
properties:
windowDays:
type: integer
example: 40
description: Window in days used to calculate slot availability for
provider
slotCount:
description: Number of available slots for provider across windowDays
value
type: integer
example: 250
'400':
description: Invalid request
content:
application/json:
schema:
type: object
description: Invalid request error
properties:
message:
type: string
description: Error message
example: radius is required
errorCode:
type: number
description: Error code
example: 40001
examples:
missing-search-field:
summary: error response when missing a required search field
value:
message: radius is required
errorCode: 40001
'403':
description: Invalid API Key
content:
application/json:
schema:
type: object
description: Forbidden error
properties:
message:
type: string
description: Error message
example: Forbidden
errorCode:
type: number
description: Error code
example: 40301
'500':
description: Unknown error
/availability/slots:
post:
description: Search aggregated slots by location POST API
operationId: aggregatedSlotsV1
security:
- ApiKey: []
summary: get available slots POST API
tags:
- external
parameters:
- in: header
name: correlation-id
description: Unique id to correlate call logs between our microservices
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- description: Request body for searching aggregated slots using latitude and longitude
for location.
type: object
required:
- latitude
- longitude
- visitTypeNames
properties:
latitude:
description: Latitude of target visit location
type: number
format: double
minimum: -90
maximum: 90
example: 47.610692
longitude:
description: Longitude of target visit location
type: number
format: double
minimum: -180
maximum: 180
example: -122.321216
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Retail
- Primary Care
radius:
description: Radius around target visit location in miles
type: integer
minimum: 1
maximum: 100
example: 30
default: 30
visitTypeNames:
description: Health system defined visit type name filter.
type: array
minItems: 1
items:
type: string
example:
- video
- phone
- in-clinic
startDate:
description: Start date of slots with yyyy-MM-dd format, default set to today if not
present.
type: string
example: '2022-08-01'
endDate:
description: End date of slots with yyyy-MM-dd format, end days will be certain days
after start date if not present.
type: string
example: '2022-08-01'
patient:
description: Patient information used to correlate a search request to an appointment
being booked
type: object
required:
- patientId
- patientIdType
- ehrInstance
properties:
patientId:
description: Patient EHR or DexCare identifier from , e.g. MRN
type: string
example: '900332632'
patientIdType:
description: EHR or DexCare identifier type for lookup
type: string
example: MRN
ehrInstance:
description: Patient EHR instance
type: string
example: ehr.region
ehrInstances:
description: EHR Instance Identifiers filter
type: array
items:
type: string
example:
- ehr.region.1
- ehr.region.2
departmentIds:
description: Department identifier filter.
type: array
items:
type: string
example:
- '5000101001'
- '5000311000'
clinicianNPIs:
description: Clinician identifier filter.
type: array
items:
type: string
example:
- '1295268407'
- '1710330808'
specialty:
description: Provider specialty filter
type: string
example: Pediatrics
gender:
description: Provider gender filter
type: string
example: Female
newOrEstablishedPatient:
description: Allows filter by slots of patient type of new or established patient.
Both types will be returned by default.
type: string
enum:
- newPatient
- establishedPatient
- bothNewAndEstablishedPatient
- description: Request body for searching aggregated slots using departments for location.
type: object
required:
- departmentIds
- visitTypeNames
properties:
latitude:
description: Latitude of target visit location
type: number
format: double
minimum: -90
maximum: 90
example: 47.610692
longitude:
description: Longitude of target visit location
type: number
format: double
minimum: -180
maximum: 180
example: -122.321216
postalCode:
description: Zip code of the target visit location. Cannot use in tandem with latitude
and longitude.
type: string
example: '98104'
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Retail
- Primary Care
radius:
description: Radius around target visit location in miles
type: integer
minimum: 1
maximum: 100
example: 30
default: 30
visitTypeNames:
description: Health system defined visit type name filter.
type: array
minItems: 1
items:
type: string
example:
- video
- phone
- in-clinic
startDate:
description: Start date of slots with yyyy-MM-dd format, default set to today if not
present.
type: string
example: '2022-08-01'
endDate:
description: End date of slots with yyyy-MM-dd format, end days will be certain days
after start date if not present.
type: string
example: '2022-08-01'
patient:
description: Patient information used to correlate a search request to an appointment
being booked
type: object
required:
- patientId
- patientIdType
- ehrInstance
properties:
patientId:
description: Patient EHR or DexCare identifier from , e.g. MRN
type: string
example: '900332632'
patientIdType:
description: EHR or DexCare identifier type for lookup
type: string
example: MRN
ehrInstance:
description: Patient EHR instance
type: string
example: ehr.region
ehrInstances:
description: EHR Instance Identifiers filter
type: array
items:
type: string
example:
- ehr.region.1
- ehr.region.2
departmentIds:
description: Department identifier filter.
type: array
items:
type: string
example:
- '5000101001'
- '5000311000'
clinicianNPIs:
description: Clinician identifier filter.
type: array
items:
type: string
example:
- '1295268407'
- '1710330808'
specialty:
description: Provider specialty filter
type: string
example: Pediatrics
gender:
description: Provider gender filter
type: string
example: Female
newOrEstablishedPatient:
description: Allows filter by slots of patient type of new or established patient.
Both types will be returned by default.
type: string
enum:
- newPatient
- establishedPatient
- bothNewAndEstablishedPatient
- description: Request body for searching aggregated slots using zip code for location.
type: object
required:
- postalCode
- visitTypeNames
properties:
postalCode:
description: Zip code of the target visit location.
type: string
example: '98104'
clinicTypes:
description: Clinic type filter.
type: array
items:
type: string
example:
- Ret
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dexcare/refs/heads/main/openapi/dexcare-care-options-openapi.yml