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_encounters.subpackage_encounters/v4 API

The subpackage_encounters.subpackage_encounters/v4 API from Candid Health — 6 operation(s) for subpackage_encounters.subpackage_encounters/v4.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_encounters.subpackage_encounters/v4 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_encounters.subpackage_encounters/v4. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 33 schemas. 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.

8 operations 6 paths 33 schemas 2 GET2 PATCH4 POST

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_encounters.subpackage_encounters/v4 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 2 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_encounters.subpackage_encounters/v4 8
GET
/api/encounters/v4
Get all encounters
get-all 18 params → 200422500
POST
/api/encounters/v4
Create professional encounter
create 1 param body → 200403404422
GET
/api/encounters/v4/{encounter_id}
Get encounter
get 2 params → 200
PATCH
/api/encounters/v4/{encounter_id}
Update professional encounter
update 2 params body → 200403404422
POST
/api/encounters/v4/universal
Create institutional or professional encounter
create-universal 1 param body → 200403404422
POST
/api/encounters/v4/create-from-pre-encounter/universal
Create institutional or professional encounter from pre-encounter patient and appointment
create-from-pre-encounter-patient-universal 1 param body → 200403404422
POST
/api/encounters/v4/create-from-pre-encounter
Create professional encounter from pre-encounter patient and appointment
create-from-pre-encounter-patient 1 param body → 200403404422
PATCH
/api/encounters/v4/{encounter_id}/universal
Update institutional or professional encounter
update-universal 2 params body → 200403404422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are type_encounters-universal:UniversalEncounterCreate (63 properties), type_encounters-universal:UniversalEncounterUpdate (57 properties), type_encounters-universal:UniversalEncounterCreateFromPreEncounter (52 properties), type_individual:PatientUpdate (13 properties). Each schema is shown below with its type and property counts.

type_commons:State
string
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:StreetAddressShortZip
object
6 properties 4 required
type_commons:DelayReasonCode
string
Code indicating the reason why a request was delayed
type_commons:EncounterExternalId
string
type_commons:UnauthorizedErrorMessage
object
1 property
type_commons:FacilityTypeCode
string
Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.…
type_individual:SubscriberCreate
object
7 properties 5 required
type_encounters-universal:UniversalEncounterUpdate
object
57 properties
type_service-facility:EncounterServiceFacilityBase
object
Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility ca…
5 properties 2 required
type_commons:EncounterId
string
type_tags:TagId
string
type_claims:ClaimStatus
string
type_commons:PhoneNumber
object
2 properties 2 required
type_commons:WorkQueueId
string
type_commons:PhoneNumberType
string
type_commons:PreEncounterPatientId
string
type_commons:StreetAddressLongZip
object
6 properties 5 required
type_individual:PatientUpdate
object
13 properties
type_commons:PreEncounterAppointmentId
string
type_commons:PatientRelationshipToInsuredCodeAll
string
type_commons:PageToken
string
type_individual:PatientClinicalTrialInfoCreate
object
2 properties 1 required
type_commons:Email
string
type_commons:InternalErrorMessage
object
1 property
type_individual:PatientNonInsurancePayerInfoCreate
object
3 properties 1 required
type_commons:ClinicalTrialId
string
type_encounters-universal:UniversalEncounterCreateFromPreEncounter
object
52 properties 9 required
type_service-facility:EncounterServiceFacilityUpdate
object
5 properties
type_commons:RequestValidationError
object
2 properties 1 required
type_encounters-universal:UniversalEncounterCreate
object
63 properties 9 required
type_individual:PatientCreate
object
13 properties 6 required
type_individual:Gender
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-encounters-subpackage-encounters-v4-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_encounters.subpackage_encounters/v4
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-encounters-subpackage-encounters-v4-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