Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Candid Health

Candid Health subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 API

The subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 API from Candid Health — 10 operation(s) for subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 API is one of 54 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 10 base URLs: https://pre-api.joincandidhealth.com, https://pre-api-staging.joincandidhealth.com, https://sandbox-pre-api.joincandidhealth.com, https://staging-pre-api.joincandidhealth.com, http://localhost:4000, https://api.joincandidhealth.com, https://api-staging.joincandidhealth.com, https://sandbox-api.joincandidhealth.com, https://staging-api.joincandidhealth.com, http://localhost:5050.

13 operations 10 paths 0 schemas 1 DELETE8 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.joincandidhealth.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Candid Health subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1 13
POST
/patients/v1
Create
create 2 params body → 200409
GET
/patients/v1
Search
search 3 params → 200
POST
/patients/v1/with_mrn
Create With Mrn
create-with-mrn 2 params body → 200400409
GET
/patients/v1/get_multi
Get Multi
get-multi 7 params → 200
GET
/patients/v1/search_providers
Search Providers
search-providers 2 params → 200
GET
/patients/v1/{id}
Get
get 2 params → 200404
GET
/patients/v1/mrn/{mrn}
Get By Mrn
get-by-mrn 2 params → 200404
GET
/patients/v1/{id}/history
Get History
get-history 2 params → 200404
GET
/patients/v1/{id}/snapshot
Get Coverage Snapshot
get-coverage-snapshot 3 params → 200404
PUT
/patients/v1/{id}/{version}
Update
update 3 params body → 200404409
DELETE
/patients/v1/{id}/{version}
Deactivate
deactivate 3 params → 200404409
PATCH
/patients/v1/{id}/{version}
Reactivate
reactivate 3 params → 200404409
GET
/patients/v1/updates/scan
Scan
scan 3 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-pre-encounter-subpackage-pre-encounter-patients-subpackage-pre-encounter-patients-v1-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
AE Profile APIs.io
Candid Health Charge Capture API
AE Profile APIs.io
Candid Health Exports API
AE Profile APIs.io
Candid Health Patients API
AE Profile APIs.io
Candid Health Credentialing API
AE Profile APIs.io
Candid Health Auth API
AE Profile APIs.io
Candid Health subpackage_auth.subpackage_auth/default API
AE Profile APIs.io
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
AE Profile APIs.io
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
AE Profile APIs.io
Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v2 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v3 API
AE Profile APIs.io
#subpackage_pre-encounter.subpackage_pre-encounter/patients.subpackage_pre-encounter/patients/v1
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-pre-encounter-subpackage-pre-encounter-patients-subpackage-pre-encounter-patients-v1-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network