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

Candid Health subpackage_diagnoses API

The subpackage_diagnoses API from Candid Health — 2 operation(s) for subpackage_diagnoses.

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

This API exposes 3 operations across 2 paths, and defines 10 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.

3 operations 2 paths 10 schemas 1 DELETE1 PATCH1 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_diagnoses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 3

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

subpackage_diagnoses 3
POST
/api/diagnoses/v2
Create diagnosis
create 1 param body → 200
PATCH
/api/diagnoses/v2/{diagnosis_id}
Update diagnosis
update 2 params body → 200404422
DELETE
/api/diagnoses/v2/{diagnosis_id}
Delete diagnosis
delete 2 params → 200404422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are type_diagnoses:Diagnosis (8 properties), type_diagnoses:StandaloneDiagnosisCreate (5 properties), type_diagnoses:ServiceLinesMustHaveAtLeastOneDiagnosisError (3 properties), type_diagnoses:DisallowMultiplePrimaryDiagnosisError (3 properties). Each schema is shown below with its type and property counts.

type_diagnoses:DisallowMultiplePrimaryDiagnosisError
object
3 properties 3 required
type_diagnoses:ServiceLinesMustHaveAtLeastOneDiagnosisError
object
3 properties 3 required
type_diagnoses:DiagnosisNotFoundError
object
2 properties 1 required
type_diagnoses:DiagnosisTypeCode
string
type_diagnoses:StandaloneDiagnosisCreate
object
5 properties 3 required
type_diagnoses:Diagnosis
object
8 properties 6 required
type_commons:ServiceLineId
string
type_commons:EncounterId
string
type_diagnoses:DiagnosisId
string
type_yes-no-indicator:YesNoIndicator
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-diagnoses-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
Candid Health Charge Capture API
Candid Health Exports API
Candid Health Patients API
Candid Health Credentialing API
Candid Health Auth API
Candid Health subpackage_auth.subpackage_auth/default API
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API
Candid Health subpackage_contracts.subpackage_contracts/v2 API
Candid Health subpackage_contracts.subpackage_contracts/v3 API