redocly logoAPI docs by Redocly

Dexcare slots availability (5.0.0)

Download OpenAPI specification:Download

getSingleProviderTimeslots

Authorizations:
ApiKey
path Parameters
npid
required
string

the provider national ID (NPIs)

query Parameters
daysOfSlots
integer >= 1
Example: daysOfSlots=3

Allows use of getting slots by "page". Retrieve number of days that have slots which can be nonconsecutive days for each "page". Example: 3 entered returns 3 days of slots for today, tomorrow, and next Monday as the dates between tomorrow and Monday do not have slots available.

product
string
Default: "DexCare"

product name assigned to client

visitTypeName
Array of strings
Example: visitTypeName=AdultWellness,PediatricWellness

When visitTypeName is present, only get slots matches visitTypeName. Pass in multiple by repeating param visitTypeName

startDate
string^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|[-+]\...
Default: "today"
Example: startDate=2021-01-01&startDate=2021-01-01T09:30:00-05:00&startDate=2021-01-01T14:30:00Z

start date for slots.

endDate
string^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|[-+]\...
Default: "configured limit such as 90 days"
Example: endDate=2021-01-10&endDate=2021-01-10T09:30:00-05:00&endDate=2021-01-10T14:30:00Z

end date for slots

newOrEstablishedPatient
string
Enum: "newPatient" "establishedPatient" "bothNewAndEstablishedPatient"

Allows filtering of slots by patient type of new or established patient. Both types will be returned by default.

visitTypeEmrId
Array of strings
Example: visitTypeEmrId=100045

Allows filtering slots by visit type ID, also known visitTypeId, the value used by an EMR. Pass in multiple by repeating param visitTypeName. If this is used with visitTypeName, slots will be filtered by both.

departmentEmrId
string
Example: departmentEmrId=100340323

Also known as departmentId, it allows filter by slots by department. This requires departmentEmrSystemId. Otherwise, all department slots are returned.

departmentEmrSystemId
string
Example: departmentEmrSystemId=wellCareSystem.epic

Also known as ehrSystemName or ehrInstance. This is the emrSystem instance that is required for departmentEmrId.

departmentUrlName
string
Example: departmentUrlName=quickCareUrgentCare

Allows filter by slots of by the department's unique url name. This does not require departmentEmrSystemId. You may not use this param with departmentEmrId/departmentEmrSystemId.

Responses

Response samples

Content type
application/json
{
  • "slots": [
    ]
}

slots availability service

search slots availabilities by providers information

Authorizations:
ApiKey
header Parameters
x-api-key
string

Client api key

Request Body schema: application/json
required

criteria for querying slots

startDate
string

start date for slots in YYYY-MM-DD format, this date will be considered as provider's timezone. when startDate is missing, search will start from first available date

endDate
string

end date for slots in YYYY-MM-DD format, this date will be considered as provider's timezone. when endDate is missing, search duration will be n days after startDate, n is configurable in system, default is 30

visitTypeNames
Array of strings

list of visit type names, when visitTypeName is present, only get slots matches to list of visitTypeNames.

required
Array of objects non-empty

list of providers for querying slots

Responses

Request samples

Content type
application/json
{
  • "startDate": "2022-06-01",
  • "endDate": "2022-06-10",
  • "visitTypeNames": [
    ],
  • "criteriaItems": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

slot released

indicate a slot has been released (e.g. slot is cancelled)

Authorizations:
ApiKey
header Parameters
x-api-key
string

Client api key

Request Body schema: application/json
npi
required
string

the provider national IDs (NPIs)

departmentId
required
string non-empty

department id for the required provider

visitTypeId
required
string non-empty

visit type emr id

slotDateTime
required
string <date-time>

specific time slot date time

ehrInstance
required
string non-empty

identifier used to map internally to the correct ehr instance

disableRefresh
boolean
Default: false

optional flag used in automation testing to disable the trigger to refresh slot data from the EHR

Responses

Request samples

Content type
application/json
{
  • "npi": "string",
  • "departmentId": "string",
  • "visitTypeId": "12345",
  • "slotDateTime": "2022-02-04T23:28:05.456Z",
  • "ehrInstance": "pacific.nw",
  • "disableRefresh": true
}

Response samples

Content type
application/json
{
  • "errorCode": 500201,
  • "message": "the value of virtual is not defined"
}

slot taken

indicate a slot has been taken (e.g. the slot has been booked)

Authorizations:
ApiKey
header Parameters
x-api-key
string

Client api key

Request Body schema: application/json
npi
required
string

the provider national IDs (NPIs)

departmentId
required
string non-empty

department id for the required provider

visitTypeId
required
string non-empty

visit type emr id

slotDateTime
required
string <date-time>

specific time slot date time

ehrInstance
required
string non-empty

identifier used to map internally to the correct ehr instance

disableRefresh
boolean
Default: false

optional flag used in automation testing to disable the trigger to refresh slot data from the EHR

Responses

Request samples

Content type
application/json
{
  • "npi": "1245662048",
  • "departmentId": "100005",
  • "visitTypeId": "12345",
  • "slotDateTime": "2022-02-04T23:28:05.456Z",
  • "ehrInstance": "pacific.nw",
  • "disableRefresh": true
}

Response samples

Content type
application/json
{
  • "errorCode": 500201,
  • "message": "the value of virtual is not defined"
}