Candid Health V1 API
The v1 API from Candid Health — 105 operation(s) for v1.
Candid Health V1 API is one of 12 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 150 operations across 105 paths, and defines 585 schemas. It is described by OpenAPI 3.2.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.
150 operations
105 paths
585 schemas
15 DELETE72 GET15 PATCH35 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Candid Health V1 API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuthScheme).
OAuthScheme— OAuth 2.0 authentication
Paths & Operations 150
Across 105 paths, the API surfaces 150 operations — 15 DELETE, 72 GET, 15 PATCH, 35 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.
v1 150
POST
/eligibility-checks/v1
Post
POST
/eligibility-checks/v1/batch
Batch
GET
/eligibility-checks/v1/batch/{batch_id}
Poll Batch
GET
/eligibility-checks/v1/payer/search
Payer Search
GET
/eligibility-checks/v1/recommendation
Recommendation
POST
/eligibility-checks/v1/recommendation
Create Recommendation
PUT
/eligibility-checks/v1/recommendation/{recommendation_id}/{version}/vote
Vote Recommendation
GET
/eligibility-checks/v1/get-multi/
Get Multi
POST
/eligibility-checks/v1/insurance-discovery
Insurance Discovery
POST
/eligibility-checks/v1/coordination-of-benefits
Coordination Of Benefits
POST
/appointments/v1
Create
GET
/appointments/v1/visits
Get Visits
GET
/appointments/v1/visits/counts
Get Counts
GET
/appointments/v1/{id}
Get
GET
/appointments/v1/{id}/history
Get History
PUT
/appointments/v1/{id}/{version}
Update
DELETE
/appointments/v1/{id}/{version}
Deactivate
GET
/appointments/v1/updates/scan
Scan
POST
/coverages/v1/
Create
GET
/coverages/v1/
Get Multi
PUT
/coverages/v1//{id}/{version}
Update
GET
/coverages/v1//get-multi-paginated
Get Multi Paginated
GET
/coverages/v1//{id}
Get
GET
/coverages/v1//{id}/history
Get History
GET
/coverages/v1//updates/scan
Scan
POST
/coverages/v1//batch-update-ppg/{ppg_id}
Batch Update Ppg
POST
/coverages/v1//{id}/eligibility
Check Eligibility
GET
/coverages/v1//{id}/eligibility/{check_id}
Get Eligibility
POST
/images/v1
Create
GET
/images/v1
Get Multi
GET
/images/v1/{id}
Get
PUT
/images/v1/{id}/{version}
Update
DELETE
/images/v1/{id}/{version}
Deactivate
GET
/lists/v1/patient
Get Patient List
GET
/lists/v1/appointment
Get Appointment List
GET
/notes/v1/{id}
Get
POST
/notes/v1
Create
PUT
/notes/v1/{id}/{version}
Update
DELETE
/notes/v1/{id}/{version}
Deactivate
GET
/organization-external-providers/v1/{id}
Get
GET
/organization-external-providers/v1
Get Multi
POST
/organization-external-providers/v1
Create
PUT
/organization-external-providers/v1/{id}/{version}
Update
DELETE
/organization-external-providers/v1/{id}/{version}
Deactivate
GET
/organization-external-providers/v1/updates/scan
Scan
POST
/patient-merge/v1
Create
GET
/patient-merge/v1/status/{mrn_or_id}
Get Status
GET
/patient-merge/v1/all/{mrn}
Get All By Mrn
DELETE
/patient-merge/v1/{id}/{version}
Deactivate
GET
/patient-merge/v1/updates/scan
Scan
POST
/patients/v1
Create
GET
/patients/v1
Search
POST
/patients/v1/with_mrn
Create With Mrn
GET
/patients/v1/get_multi
Get Multi
GET
/patients/v1/search_providers
Search Providers
GET
/patients/v1/{id}
Get
GET
/patients/v1/mrn/{mrn}
Get By Mrn
GET
/patients/v1/{id}/history
Get History
GET
/patients/v1/{id}/snapshot
Get Coverage Snapshot
GET
/patients/v1/{id}/eligibility-timeline
Get Eligibility Timeline
PUT
/patients/v1/{id}/{version}
Update
DELETE
/patients/v1/{id}/{version}
Deactivate
PATCH
/patients/v1/{id}/{version}
Reactivate
GET
/patients/v1/updates/scan
Scan
GET
/tags/v1/{id}
Get
GET
/tags/v1
Get All
POST
/tags/v1
Create
PUT
/tags/v1/{id}/{version}
Update
DELETE
/tags/v1/{id}/{version}
Deactivate
POST
/api/import-invoice/v1
Import Invoice
GET
/api/import-invoice/v1
Get Multi
GET
/api/import-invoice/v1/{invoice_id}
Get
PATCH
/api/import-invoice/v1/{invoice_id}
Update
GET
/api/patient-ar/v1/inventory
List Inventory Records
GET
/api/patient-ar/v1/invoice-itemization/{claim_id}
Invoice Itemization
GET
/api/patient-refunds/v1
Get patient refunds
POST
/api/patient-refunds/v1
Create patient refund
GET
/api/patient-refunds/v1/{patient_refund_id}
Get patient refund
PATCH
/api/patient-refunds/v1/{patient_refund_id}
Update
DELETE
/api/patient-refunds/v1/{patient_refund_id}
Delete patient refund
GET
/api/charge_capture_claim_creation/v1/{charge_capture_claim_creation_id}
Get Charge Capture Claim Creation
GET
/api/charge_capture_claim_creation/v1/all/summary
Get Charge Capture Claim Creation Summary
PATCH
/api/charge_capture_claim_creation/v1/error/{charge_capture_bundle_error_id}
Mark a ClaimCreationAttempt error as resolved
GET
/api/charge_capture_claim_creation/v1
Get all Charge Capture Claim Creations
POST
/api/charge_captures/v1
Create a Charge Capture
GET
/api/charge_captures/v1
Get all Charge Captures
POST
/api/charge_captures/v1/create-from-pre-encounter
Create a Charge Capture from pre-encounter patient and appointment
PATCH
/api/charge_captures/v1/changes
Update a ChargeCapturePostBilledChange
PATCH
/api/charge_captures/v1/{charge_capture_id}
Update Charge Capture
GET
/api/charge_captures/v1/{charge_capture_id}
Get Charge Capture
POST
/api/charge_captures/v1/find-by-metadata
Find Charge Captures by Metadata
GET
/api/custom-schemas/v1
Get all custom schemas
POST
/api/custom-schemas/v1
Create a custom schema
GET
/api/custom-schemas/v1/{schema_id}
Get custom schema
PATCH
/api/custom-schemas/v1/{schema_id}
Update custom schema
GET
/api/encounter-attachments/v1/{encounter_id}
Get Encounter Attachments
PUT
/api/encounter-attachments/v1/{encounter_id}
Create Encounter Attachment
DELETE
/api/encounter-attachments/v1/{encounter_id}
Delete Encounter Attachment
PUT
/api/encounter-attachments/v1/{encounter_id}/v2
Create Encounter Attachment V2
POST
/api/encounter-attachments/v1/create-from-charge-capture-external-id
Create an Attachment from a Charge Capture external ID
GET
/api/encounter-attachments/v1/by-charge-capture-external-id/{charge_capture_external_id}
Get Attachments by Charge Capture External ID
DELETE
/api/encounter-attachments/v1/by-charge-capture-external-id/{charge_capture_external_id}
Delete Attachment by Charge Capture External ID
GET
/api/encounter-supplemental-information/v1/{encounter_id}
Get Encounter Supplemental Information
PUT
/api/encounter-supplemental-information/v1/{encounter_id}
Create Encounter Supplemental Information
PATCH
/api/encounter-supplemental-information/v1/{encounter_id}/{supplemental_information_id}
Update Encounter Supplemental Information
DELETE
/api/encounter-supplemental-information/v1/{encounter_id}/{supplemental_information_id}
Delete Encounter Supplemental Information
GET
/api/events/v1/
Scan
GET
/api/events/v1/{event_id}
Get
GET
/api/external-payment-account-config/v1
Get Multi
POST
/api/guarantors/v1/{encounter_id}
Create guarantor
GET
/api/guarantors/v1/{guarantor_id}
Get guarantor
PATCH
/api/guarantors/v1/{guarantor_id}
Update guarantor
PUT
/api/health-care-code-informations/v1/{encounter_id}
Update
GET
/api/health-care-code-informations/v1/{encounter_id}
Get All For Encounter
GET
/api/insurance-adjudications/v1/{insurance_adjudication_id}
Get insurance adjudication
GET
/api/insurance-refunds/v1
Get insurance refunds
POST
/api/insurance-refunds/v1
Create insurance refund
GET
/api/insurance-refunds/v1/{insurance_refund_id}
Get insurance refund
PATCH
/api/insurance-refunds/v1/{insurance_refund_id}
Update
DELETE
/api/insurance-refunds/v1/{insurance_refund_id}
Delete insurance refund
POST
/api/medication-dispense/v1
Medication Dispense Create
GET
/api/non-insurance-payer-payments/v1
Get non-insurance payer payments
POST
/api/non-insurance-payer-payments/v1
Create non-insurance payer payment
GET
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Get non-insurance payer payment
PATCH
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Update
DELETE
/api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}
Delete non-insurance payer payment
GET
/api/non-insurance-payer-refunds/v1
Get non-insurance payer refunds refunds
POST
/api/non-insurance-payer-refunds/v1
Create non-insurance payer refund
GET
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Get non-insurance payer refund
PATCH
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Update
DELETE
/api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}
Delete non-insurance payer refund
POST
/api/non-insurance-payers/v1
Create
GET
/api/non-insurance-payers/v1
Get Multi
PATCH
/api/non-insurance-payers/v1/{non_insurance_payer_id}/toggle_enablement
Toggle Enablement
GET
/api/non-insurance-payers/v1/categories
Get non-insurance payer categories
GET
/api/non-insurance-payers/v1/{non_insurance_payer_id}
Get
PATCH
/api/non-insurance-payers/v1/{non_insurance_payer_id}
Update
DELETE
/api/non-insurance-payers/v1/{non_insurance_payer_id}
Delete
GET
/api/payer-plan-groups/v1
Get payer plans
POST
/api/payer-plan-groups/v1
Create a payer plan
GET
/api/payer-plan-groups/v1/{payer_plan_group_id}
Get payer plan
PUT
/api/payer-plan-groups/v1/{payer_plan_group_id}
Update payer plan
PATCH
/api/payer-plan-groups/v1/{payer_plan_group_id}
Delete payer plan
POST
/api/superbill/v1
Create Superbill
GET
/api/write-offs/v1
Get all write-offs
POST
/api/write-offs/v1
Create write-off
GET
/api/write-offs/v1/{write_off_id}
Get write-off
POST
/api/write-offs/v1/{write_off_id}/revert
Revert write-off
POST
/api/write-offs/v1/{adjustment_id}/revert
Revert Insurance Balance Adjustment
POST
/api/write-offs/v1/{adjustment_id}/revert-era-originated
Revert ERA-originated Insurance Balance Adjustment
Schemas 585
The contract defines 585 schemas that model the data the API accepts and returns. The most detailed are type_encounters_v4_Encounter (76 properties), type_pre-encounter_patients_v1_Patient (52 properties), type_charge-capture_v1_ChargeCaptureData (52 properties), type_pre-encounter_patients_v1_MutablePatientWithMrn (46 properties). Each schema is shown below with its type and property counts.
type_pre-encounter_tags_v1_MutableTag
object
An object representing a Tag.
3 properties
1 required
type_pre-encounter_eligibilityChecks_v1_CobSubscriber
object
The primary policyholder for the insurance plan or a dependent with a unique member ID. You must provide at least one of memberid or ssn.
5 properties
3 required
type_financials_AllocationTarget
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_guarantor_v1_EncounterHasExistingGuarantorErrorType
object
1 property
1 required
type_financials_InvoiceUpdate
type_service-facility_EncounterServiceFacilityUpdateWithOptionalAddress
object
5 properties
type_guarantor_v1_GuarantorId
string
type_pre-encounter_patients_v1_EligibilityAuditEventType
string
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId
string
type_pre-encounter_appointments_v1_Service
object
2 properties
type_x12_v1_TypeOfBillComposite
object
4 properties
4 required
type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundSortField
string
type_financials_RefundReason
string
type_pre-encounter_common_ExternalIdentifier
object
An external identifier for a patient
3 properties
2 required
type_superbills_v1_Superbill
object
6 properties
6 required
type_encounters_v4_EncounterSubmissionOriginType
string
type_encounters_v4_Vitals
object
7 properties
type_insurance-adjudications_v1_ServiceLineAdjudicationId
string
type_pre-encounter_patients_v1_AuthorizationUnit
string
type_pre-encounter_coverages_v1_MutableCoverage
object
12 properties
6 required
type_encounters_v4_NoteCategory
string
type_pre-encounter_coverages_v1_CoverageBenefits
object
6 properties
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifier
object
2 properties
2 required
type_x12_v1_TypeOfFacilityCode
string
type_insurance-refunds_v1_InsuranceRefundSortField
string
type_encounters_v4_PatientHistoryCategoryOptional
object
2 properties
type_commons_AppointmentId
string
type_encounters_v4_ClaimSupplementalInformation
object
3 properties
2 required
type_non-insurance-payer-payments_v1_NonInsurancePayerPayment
object
8 properties
4 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId
string
The unique identifier for an OrganizationExternalProvider in the database
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierCreateOptional
object
2 properties
type_pre-encounter_common_CoverageId
string
The unique identifier for a Coverage in the database
type_commons_ProcedureModifier
string
type_payer-plan-groups_v1_PayerPlanGroupAlreadyExistsError
object
2 properties
2 required
type_encounter-providers_v2_OrderingProviderOptional
object
6 properties
type_health-care-code-information_v1_ICDCode
string
type_pre-encounter_eligibilityChecks_v1_StediPayer
object
10 properties
6 required
type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendation
object
An eligibility recommendation object that contains an EligibilityRecommendationType and a payload of data denoting the recommendation.
11 properties
9 required
type_pre-encounter_coverages_v1_Subscriber
object
5 properties
2 required
type_commons_DateRangeOptionalEnd
object
2 properties
1 required
type_health-care-code-information_v1_PatientReasonForVisitCodeQualifier
string
type_pre-encounter_eligibilityChecks_v1_PayerSearchResponse
object
5 properties
3 required
type_pre-encounter_common_ContactPointUse
string
type_pre-encounter_images_v1_Image
object
An Image object with immutable server-owned properties.
13 properties
11 required
type_commons_EmrPayerCrosswalk
string
type_health-care-code-information_v1_OtherDiagnosisInformation
object
This corresponds to BF and ABF code qualifier values.
5 properties
2 required
type_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsResponse
object
An object representing the data for a coordination of benefits response.
8 properties
type_write-offs_v1_WriteOffSortField
string
type_patient-ar_v1_InvalidFiltersErrorType
object
1 property
1 required
type_health-care-code-information_v1_OtherProcedureInformationCodeQualifier
string
type_invoices_v2_InvoiceDestination
string
type_charge-capture_v1_ChargeCaptureData
object
52 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPayload
type_encounters_v4_PatientHistoryCategory
object
2 properties
2 required
type_encounters_v4_IntakeFollowUpOptional
object
3 properties
type_pre-encounter_common_Relationship
string
type_pre-encounter_patients_v1_ReferralUnit
string
type_non-insurance-payers_v1_NonInsurancePayerCategoryUpdate
type_pre-encounter_coverages_v1_CoveragesPage
object
4 properties
2 required
type_pre-encounter_eligibilityChecks_v1_CobEncounter
object
Information about the encounter for the COB check. Service dates must be within the past 2 years and must not be in the future.
3 properties
type_encounter-attachments_v1_EncounterAttachment
object
9 properties
9 required
type_custom-schemas_v1_SchemaInstance
object
2 properties
2 required
type_pre-encounter_coverages_v1_ServiceCoverageDetails
object
5 properties
type_service-lines_v2_TestResultType
string
type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPatientInfo
object
An object representing patient information for an eligibility recommendation. This is used to find recommendations. Each field helps us find the right correspo…
7 properties
type_commons_LinkUrl
string
type_pre-encounter_coverages_v1_Coverage
object
A coverage object with immutable server-owned properties.
18 properties
12 required
type_pre-encounter_eligibilityChecks_v1_CobDependent
object
A dependent for which you want to check coordination of benefits. If the dependent has their own member ID, include their information in the subscriber object…
4 properties
3 required
type_health-care-code-information_v1_AdmittingDiagnosisCodeQualifier
string
type_health-care-code-information_v1_PrincipalDiagnosisCodeQualifier
string
type_write-offs_v1_InsuranceWriteOffTarget
type_encounters_v4_IntakeQuestionOptional
object
3 properties
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoverySubscriber
object
Demographic information for the patient when they are the health plan subscriber. Providing as much information as possible improves the probability of finding…
7 properties
2 required
type_health-care-code-information_v1_DiagnosisRelatedGroupCodeQualifier
string
type_commons_ChargeCaptureId
string
type_commons_ClaimSubmissionPayerResponsibilityType
string
type_pre-encounter_common_DisabilityStatus
string
type_billing-notes_v2_BillingNoteType
string
type_encounter-supplemental-information_v1_CreateSupplementalInformationRequest
object
5 properties
3 required
type_pre-encounter_coverages_v1_LatestEligibilityCheck
object
A type to represent the latest eligibility check status of a coverage.
4 properties
3 required
type_commons_QualifierCode
string
type_tags_TagColorEnum
string
type_pre-encounter_eligibilityChecks_v1_IndividualProvider
object
3 properties
1 required
type_financials_RefundReasonUpdate
type_commons_PayerPlanGroupId
string
type_pre-encounter_coverages_v1_CoverageEligibilityCheckResponse
object
2 properties
1 required
type_pre-encounter_common_HumanName
object
5 properties
3 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata
object
5 properties
5 required
type_events_v1_Event
object
6 properties
6 required
type_financials_NoteUpdate
type_payers_v4_PayerUuid
string
type_import-invoice_v1_ImportInvoicesPage
object
3 properties
1 required
type_patient-refunds_v1_PatientRefundId
string
type_commons_EntityConflictErrorMessage
object
1 property
1 required
type_commons_ClinicalTrialId
string
type_health-care-code-information_v1_D8Date
string
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckPage
object
4 properties
2 required
type_pre-encounter_patients_v1_Guarantor
object
5 properties
2 required
type_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsRequest
object
An object representing the data for a coordination of benefits request.
5 properties
4 required
type_pre-encounter_patients_v1_ExternalProvenance
object
Information about the upstream system that owns this patient data.
2 properties
2 required
type_commons_IntendedSubmissionMedium
string
The medium (paper or electronic) via which we intended to submit the claim. The clearinghouse to which we sent the claim may use a different medium in certain…
type_commons_PreEncounterPatientId
string
type_guarantor_v1_GuarantorUpdate
object
10 properties
type_patient-ar_v1_ListInventoryPagedResponse
object
2 properties
1 required
type_pre-encounter_lists_v1_SortFieldString
string
The field to order by. Valid values are either keys on the list item object or a special ordering "similarname: " (Ex: similarname:John). Similar name ordering…
type_payer-plan-groups_v1_PayerPlanGroupPage
object
3 properties
1 required
type_patient-ar_v1_PatientPaymentInfo
object
2 properties
2 required
type_pre-encounter_coverages_v1_MemberInfo
object
4 properties
2 required
type_health-care-code-information_v1_ConditionInformationCodeQualifier
string
type_health-care-code-information_v1_ValueCode
string
type_billing-notes_v2_BillingNoteBaseOptional
object
1 property
type_pre-encounter_common_NameUse
string
type_non-insurance-payers_v1_NonInsurancePayerId
string
type_invoices_v2_InvoiceDestinationMetadata
object
4 properties
3 required
type_pre-encounter_common_CanonicalProviderId
string
The unique identifier for a provider configured in the Candid system
type_invoices_v2_ServiceLineInvoiceItem
object
2 properties
2 required
type_health-care-code-information_v1_OtherProcedureInformation
object
This corresponds to the BBQ or BQ code qualifier values.
5 properties
3 required
type_clinical-trials_v1_ClinicalTrialPhase
string
type_pre-encounter_common_TagId
string
The unique identifier for a Tag.
type_commons_PatientExternalId
string
type_pre-encounter_patients_v1_PatientSortField
string
The field to order by. Valid values are either keys on the patient object or a special ordering "similarname: " (Ex: similarname:John). Similar name ordering u…
type_financials_AllocationTargetCreate
Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.
type_health-care-code-information_v1_OccurrenceInformationCodeQualifier
string
type_pre-encounter_eligibilityChecks_v1_Cob
object
An overview of the COB response. Indicates whether there is a coverage overlap, whether that overlap creates a coordination of benefits instance, and whether S…
5 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails
object
This object is our fern representation of Stedi's EligbilityCheckError object from their API.
6 properties
type_import-invoice_v1_CreateImportInvoiceRequest
object
9 properties
6 required
type_pre-encounter_common_ExternalProviderType
string
type_claims_ClaimStatus
string
type_individual_Patient
object
14 properties
13 required
type_non-insurance-payers_v1_NonInsurancePayerAddressUpdate
type_pre-encounter_eligibilityChecks_v1_BatchEligibilityResponse
object
An object representing the data for a batch eligibility response.
2 properties
2 required
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryStatus
string
The status of the insurance discovery check.
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_guarantor_v1_GuarantorCreate
object
10 properties
4 required
type_commons_EPSDTReferralConditionIndicatorCode
string
type_pre-encounter_common_FilterQueryString
string
A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form 'path:operator:value'. Example: 'patient.mrn|eq|12345'…
type_encounter-providers_v2_EncounterAdditionalProvider
object
A lighter-weight provider type with optional NPI. Used for treating providers and other additional provider roles that may not have full NPI credentials.
8 properties
3 required
type_pre-encounter_common_AdditionalPayerInformation
object
4 properties
type_service-lines_v2_ServiceLine
object
43 properties
8 required
type_commons_BadRequestErrorMessage
object
1 property
type_pre-encounter_coverages_v1_PlanCoverage
object
4 properties
type_pre-encounter_coverages_v1_InsurancePlan
object
13 properties
3 required
type_non-insurance-payers_v1_NonInsurancePayer
object
7 properties
4 required
type_health-care-code-information_v1_OtherDiagnosisInformationCodeQualifier
string
type_pre-encounter_patients_v1_SpecializationCategory
string
type_commons_Email
string
type_import-invoice_v1_ImportInvoice
object
12 properties
10 required
type_x12_v1_PatientDischargeStatusCode
string
type_pre-encounter_common_CanonicalNonInsurancePayerAssociation
object
4 properties
1 required
type_encounters_v4_ClaimSupplementalInformationOptional
object
3 properties
type_pre-encounter_notes_v1_MutableNote
object
An object representing a Note.
4 properties
1 required
type_health-care-code-information_v1_PrincipalDiagnosis
object
This corresponds to BK or ABK code qualifier values.
5 properties
2 required
type_commons_InvoiceId
string
type_financials_BalanceEarmark
object
Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should…
4 properties
2 required
type_x12_v1_ClaimAdjustmentReasonCode
object
3 properties
3 required
type_write-offs_v1_WriteOff
type_encounter-providers_v2_ProviderId
string
type_charge-capture_v1_ChargeCaptureStatus
string
type_encounters_v4_LabCodeType
string
type_commons_SortDirection
string
type_pre-encounter_organizationExternalProviders_v1_LicenseType
string
type_individual_PatientUpdateWithOptionalAddress
object
13 properties
type_health-care-code-information_v1_OccurrenceInformation
object
This corresponds to the BH code qualifier value.
5 properties
3 required
type_health-care-code-information_v1_TreatmentCode
string
type_x12_v1_RemittanceAdviceRemarkCode
object
1 property
1 required
type_pre-encounter_common_CanonicalClinicalTrialAssociation
object
3 properties
1 required
type_pre-encounter_common_UserId
string
The unique identifier for a User in the database
type_pre-encounter_common_SexualOrientation
string
type_encounter-providers_v2_RenderingProviderUpdateWithOptionalAddress
object
7 properties
type_pre-encounter_appointments_v1_AppointmentStatus
string
type_commons_Npi
string
type_pre-encounter_patients_v1_MutablePatient
object
An object representing patient demographics information.
45 properties
10 required
type_service-facility_ServiceFacilityId
string
type_encounter-supplemental-information_v1_AttachmentInclusion
string
type_pre-encounter_coverages_v1_ServiceTypeCode
string
Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)
type_pre-encounter_appointments_v1_Visit
object
A visit is a collection of appointments that occur on the same day.
11 properties
5 required
type_encounters_v4_ClinicalNoteCategory
object
3 properties
2 required
type_pre-encounter_eligibilityChecks_v1_Provider
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_health-care-code-information_v1_ExternalCauseOfInjuryCodeQualifier
string
type_charge-capture-bundles_v1_ChargeCaptureClaimCreationPage
object
3 properties
1 required
type_financials_AllocationEarmarkType
If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation unti…
type_service-facility_EncounterServiceFacility
object
6 properties
3 required
type_pre-encounter_eligibilityChecks_v1_ParsedResponse
object
3 properties
1 required
type_financials_AccountType
string
type_pre-encounter_patients_v1_MutablePatientWithMrn
object
46 properties
11 required
type_pre-encounter_tags_v1_TagPage
object
4 properties
2 required
type_pre-encounter_common_Period
object
2 properties
type_invoices_v2_UnattributedInvoiceItem
object
1 property
1 required
type_pre-encounter_coverages_v1_CoverageLevel
string
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckStatus
string
enum to represent the status of an eligibility checks
type_x12_v1_PointOfOriginForAdmissionOrVisitCode
string
type_insurance-refunds_v1_InsuranceRefundCreate
object
6 properties
3 required
type_encounters_v4_IntakeFollowUpId
string
type_charge-capture-bundles_v1_ChargeCaptureClaimCreationSortField
string
type_pre-encounter_coverages_v1_CarveOutType
string
type_write-offs_v1_WriteOffId
string
type_superbills_v1_SuperbillOutputFormat
string
Output format for the generated superbill.
type_commons_PatientRelationshipToInsuredCodeAll
string
type_pre-encounter_common_Sex
string
type_charge-capture-bundles_v1_ChargeCaptureClaimCreationStatus
string
type_pre-encounter_patients_v1_Authorization
object
14 properties
5 required
type_pre-encounter_eligibilityChecks_v1_RequestCorrection
object
3 properties
3 required
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryDependent
object
Demographic information for the patient when they are a dependent on a health plan. If you only have the dependent's information, identify them in the subscrib…
7 properties
2 required
type_non-insurance-payers_v1_NonInsurancePayerCategoriesPage
object
3 properties
1 required
type_encounters_v4_InvalidTagNamesErrorType
object
1 property
1 required
type_health-care-code-information_v1_HealthCareCodeInformationUpdate
object
13 properties
type_insurance-cards_v2_InsuranceCard
object
15 properties
4 required
type_diagnoses_DiagnosisCreateOptional
object
4 properties
type_write-offs_v1_InsuranceWriteOffReason
string
type_pre-encounter_common_VersionConflictErrorBody
object
3 properties
1 required
type_encounter-supplemental-information_v1_UpdateSupplementalInformationRequest
object
5 properties
type_custom-schemas_v1_SchemaField
object
2 properties
2 required
type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider
object
An object representing an organization-level external provider.
12 properties
2 required
type_health-care-code-information_v1_OccurrenceCode
string
type_charge-capture_v1_ChargeCapturePage
object
4 properties
2 required
type_health-care-code-information_v1_DiagnosisRelatedGroup
object
This corresponds to DR code qualifier values.
4 properties
2 required
type_encounters_v4_IntakeQuestionId
string
type_individual_Gender
string
type_encounters_v4_ClinicalNoteCategoryCreateOptional
object
2 properties
type_pre-encounter_coverages_v1_NetworkType
string
type_commons_DelayReasonCode
string
Code indicating the reason why a request was delayed
type_pre-encounter_eligibilityChecks_v1_PostEligibilityRecommendationRequest
object
3 properties
3 required
type_non-insurance-payers_v1_CreateNonInsurancePayerRequest
object
5 properties
1 required
type_insurance-adjudications_v1_InsuranceAdjudicationId
string
type_pre-encounter_patients_v1_EligibilityTimelinePage
object
4 properties
2 required
type_custom-schemas_v1_SchemaValidationFailure
object
1 property
1 required
type_pre-encounter_coverages_v1_BenefitsRelatedEntity
object
5 properties
type_invoices_v2_InvoiceSortField
string
type_pre-encounter_eligibilityChecks_v1_CobResponseSubscriber
object
Information about the primary policyholder for the insurance plan listed in the COB request.
11 properties
type_pre-encounter_eligibilityChecks_v1_CobResponseProvider
object
Information about the entity that submitted the original COB request.
5 properties
type_encounters_v4_Intervention
object
5 properties
2 required
type_commons_PhoneNumberType
string
type_patient-ar_v1_PatientAdjustmentInfo
object
1 property
1 required
type_patient-refunds_v1_PatientRefundSortField
string
type_pre-encounter_coverages_v1_CoverageValue
object
4 properties
type_pre-encounter_coverages_v1_Address
object
7 properties
type_pre-encounter_coverages_v1_NonCoveredDetail
object
6 properties
4 required
type_commons_ChargeCapturePostBilledChangeId
string
type_pre-encounter_eligibilityChecks_v1_CobPayer
object
Information about the payer listed in the COB request.
2 properties
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryEncounter
object
The date range for the service. If not specified, Stedi defaults to the current date. You can specify either a single dateofservice or a beginningdateofservice…
3 properties
type_pre-encounter_images_v1_ImageSortField
string
type_commons_OrganizationId
string
type_patient-payments_v3_PatientPaymentStatus
string
type_health-care-code-information_v1_MSDRGCode
string
type_individual_PatientNonInsurancePayerInfo
object
3 properties
2 required
type_payer-plan-groups_v1_PayerPlanGroup
object
7 properties
7 required
type_commons_AllocationId
string
type_encounter-supplemental-information_v1_SupplementalInformationId
string
type_eras_ERA
object
3 properties
3 required
type_custom-schemas_v1_SchemaInstanceOptional
object
2 properties
type_import-invoice_v1_ImportInvoiceUpdateRequest
object
5 properties
type_pre-encounter_images_v1_CoverageImageSide
string
type_pre-encounter_patients_v1_CoveragesForRelatedCauses
object
Additional coverages for the patient applicable to related causes such as Auto or Workers Comp
1 property
1 required
type_pre-encounter_appointments_v1_NotReadyReason
string
The reason an appointment is NOTREADY. Only set when status is NOTREADY. All values except MANUAL are set by the automated eligibility check; MANUAL is set by…
type_pre-encounter_appointments_v1_ReadySource
string
Indicates how this appointment's status was marked as READY - MANUAL or MACHINE.
type_encounter-providers_v2_SupervisingProviderSecondaryIdentificationOptional
object
2 properties
type_commons_EntityNotFoundErrorMessage
object
1 property
1 required
type_payers_v3_Payer
object
8 properties
3 required
type_pre-encounter_eligibilityChecks_v1_EligibilityResponse
An object representing the data for an eligibility response.
type_patient-refunds_v1_PatientRefundsPage
object
3 properties
1 required
type_encounter-providers_v2_ReferringProviderSecondaryIdentificationOptional
object
2 properties
type_pre-encounter_patients_v1_Patient
object
A patient object with immutable server-owned properties.
52 properties
17 required
type_commons_Primitive
string
The BOOLEAN and STRING primitives respectively map to the boolean and string JSON data types. The DOUBLE and INTEGER primitives must be written as a JSON numbe…
type_pre-encounter_notes_v1_Note
object
A Note object with immutable server-owned properties.
11 properties
8 required
type_pre-encounter_patients_v1_EligibilityTimelineEvent
object
A single eligibility audit event.
9 properties
7 required
type_health-care-code-information_v1_ValueInformation
object
This corresponds to the BE code qualifier value.
5 properties
3 required
type_patient-ar_v1_ServiceLineItemization
object
14 properties
14 required
type_payment-account-configs_PaymentAccountConfigId
string
type_pre-encounter_common_CanonicalNonInsurancePayerId
string
The unique identifier for a non-insurance payer configured in the Candid system
type_insurance-cards_v2_InsuranceCardCreateOptional
object
15 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityStatus
string
enum to represent the status of a patient's coverage
type_encounters_v4_Encounter
object
76 properties
22 required
type_encounters_v4_EncounterOwnerOfNextActionType
string
type_encounter-providers_v2_BillingProviderSecondaryIdentificationQualifier
string
type_pre-encounter_lists_v1_AppointmentListItem
object
5 properties
2 required
type_payers_v3_PayerUuid
string
type_invoices_InvoiceStatus
string
type_commons_ReportTransmissionCode
string
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentSortField
string
type_pre-encounter_lists_v1_PatientListPage
object
4 properties
2 required
type_charge-capture-bundles_v1_ChargeCaptureClaimCreation
object
6 properties
4 required
type_financials_PatientTransactionSource
string
type_service-lines_v2_ServiceLineDenialReason
object
The reason a given service line was denied within a given time range. A service line may be denied for different reasons over time, but only one reason at a ti…
1 property
type_non-insurance-payers_v1_NonInsurancePayerPage
object
3 properties
1 required
type_invoices_v2_InvoiceItemCreate
object
2 properties
2 required
type_claim-submission_v1_ClaimSubmissionRecordCreateOptional
object
Data about each external submission.
4 properties
type_commons_ClaimId
string
type_health-care-code-information_v1_PrincipalProcedureInformation
object
This correspond to BBR, BR, and CAH code qualifier values.
5 properties
3 required
type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier
string
type_encounters_v4_EPSDTReferral
object
3 properties
1 required
type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId
string
type_write-offs_v1_WriteOffsPage
object
3 properties
1 required
type_import-invoice_v1_InvoiceItemUpdateType
string
type_organization-service-facilities_v2_OrganizationServiceFacilityId
string
type_pre-encounter_common_Ethnicity
string
type_insurance-refunds_v1_InsuranceRefundId
string
type_pre-encounter_patients_v1_PatientCoverageSnapshot
object
5 properties
2 required
type_pre-encounter_coverages_v1_CoverageStatus
string
enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html
type_commons_StreetAddressShortZip
object
6 properties
4 required
type_charge-capture-bundles_v1_ChargeCaptureClaimCreationSummary
object
5 properties
5 required
type_encounter-providers_v2_ProviderSecondaryIdentification
object
2 properties
1 required
type_commons_PhoneNumberOptional
object
2 properties
type_health-care-code-information_v1_SetOrClearPrincipalDiagnosis
object
1 property
type_encounter-providers_v2_EncounterProvider
object
11 properties
3 required
type_commons_ClaimAdjustmentGroupCodes
string
type_pre-encounter_patients_v1_DoNotInvoiceReason
string
type_pre-encounter_eligibilityChecks_v1_CopayEstimationRecommendationPayload
object
Payload for MD visit copay estimation from AI analysis
2 properties
1 required
type_financials_ReallocationWouldOverdraftErrorContent
object
Error content when a reallocation would cause an account to be overdrafted. Contains both legacy string messages and new structured allocation details.
2 properties
1 required
type_encounters_v4_IntakeResponseAndFollowUps
object
2 properties
type_tags_Tag
object
4 properties
4 required
type_health-care-code-information_v1_ConditionInformation
object
This corresponds to the BG code qualifier value.
4 properties
2 required
type_x12_v1_Rarc
string
type_patient-ar_v1_NonInsuranceAdjustmentInfo
object
1 property
1 required
type_pre-encounter_eligibilityChecks_v1_CobPlanDateInformation
object
Dates associated with the patient's health plan coverage.
2 properties
type_external-payment-account-config_v1_ExternalPaymentAccountConfigPage
object
3 properties
1 required
type_pre-encounter_patientMerges_v1_PatientMergeStatus
The merge status of a patient.
type_pre-encounter_eligibilityChecks_v1_OrganizationProvider
object
2 properties
1 required
type_pre-encounter_common_OrganizationId
string
The unique identifier for an Organization in the database
type_billing-notes_v2_BillingNoteMetadata
type_pre-encounter_coverages_v1_CoverageCarveOut
object
8 properties
4 required
type_commons_StreetAddressLongZipOptional
object
6 properties
type_pre-encounter_common_NoteId
string
The unique identifier for a Note.
type_pre-encounter_coverages_v1_PlanCoverageDetails
object
9 properties
type_service-lines_v2_ServiceLineERAData
object
2 properties
2 required
type_pre-encounter_eligibilityChecks_v1_CobResponseDependent
object
Information about the dependent listed in the original COB request.
13 properties
type_pre-encounter_eligibilityChecks_v1_Vote
object
User feedback on a recommendation
2 properties
2 required
type_insurance-refunds_v1_InsuranceRefundsPage
object
3 properties
1 required
type_pre-encounter_appointments_v1_CountsResponse
object
1 property
type_encounters_v4_Lab
object
3 properties
1 required
type_pre-encounter_common_ErrorBase4xx
object
2 properties
1 required
type_patient-ar_v1_InvoiceItemizationResponse
object
5 properties
4 required
type_pre-encounter_common_Race
string
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider
object
An OrganizationExternalProvider object with immutable server-owned properties.
18 properties
8 required
type_service-lines_v2_TestResult
object
2 properties
2 required
type_pre-encounter_patientMerges_v1_PatientMerge
object
A PatientMerge object with immutable server-owned properties.
8 properties
8 required
type_encounter-providers_v2_ProviderSecondaryIdentificationOptional
object
2 properties
type_x12_v1_TypeOfBillFrequencyCode
string
type_related-causes_v1_RelatedCausesInformationCreateOptional
object
3 properties
type_pre-encounter_coverages_v1_ServiceCoverage
object
5 properties
1 required
type_commons_PhoneNumber
object
2 properties
2 required
type_pre-encounter_patients_v1_PatientPage
object
4 properties
2 required
type_pre-encounter_patients_v1_FilingOrder
object
The patient's active coverages, in order of primary, secondary, etc.
1 property
1 required
type_invoices_v2_InvoiceStatus
string
type_encounters_v4_BillableStatusType
string
type_health-care-code-information_v1_SetOrClearPrincipalProcedureInformation
object
1 property
type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsResult
object
Individual result from a single user-configured prompt execution
4 properties
4 required
type_pre-encounter_patients_v1_AdvancedDirective
string
type_insurance-adjudications_v1_ServiceLineAdjudication
object
9 properties
3 required
type_write-offs_v1_CreateWriteOffsResponse
object
1 property
1 required
type_related-causes_v1_RelatedCausesInformation
object
3 properties
1 required
type_commons_ServiceLineId
string
type_health-care-code-information_v1_PrincipalProcedureInformationCodeQualifier
string
type_pre-encounter_common_Gender
string
type_commons_ReportTypeCode
string
type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier
string
type_financials_AllocationRestrictionCreate
object
Constrains which claims a payment's credit can be auto-allocated to. Restrictions of the same restrictiontype are OR'd together (any value may match); differen…
2 properties
2 required
type_pre-encounter_patients_v1_InferredPatientMetadata
object
2 properties
2 required
type_pre-encounter_images_v1_ImageId
string
The unique identifier for an Image
type_users_v2_IdpUserMetadata
type_pre-encounter_lists_v1_PatientListItem
object
7 properties
2 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderPage
object
4 properties
2 required
type_commons_InternalErrorMessage
object
1 property
type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode
string
type_pre-encounter_eligibilityChecks_v1_EligibilityRequest
object
An object representing the data for an eligibility request.
10 properties
3 required
type_commons_SourceOfPaymentCode
string
type_health-care-code-information_v1_SetOrClearAdmittingDiagnosis
object
1 property
type_encounter-providers_v2_SupervisingProviderUpdateWithOptionalAddress
object
7 properties
type_health-care-code-information_v1_TreatmentCodeInformation
object
This corresponds to the TC code qualifier value.
4 properties
2 required
type_charge-capture_v1_Hl7MessageType
string
HL7 message type that produced a charge-capture write. Values match the bare MSH-9-1 code emitted by HL7 producers (conduit). Constrains the hl7messagetype fie…
type_encounter-supplemental-information_v1_SupplementalInformation
object
7 properties
5 required
type_payers_v3_PayerId
string
type_pre-encounter_coverages_v1_PlanDate
object
3 properties
2 required
type_insurance-cards_v2_InsuranceCardId
string
type_commons_RequestValidationError
object
2 properties
1 required
type_medication-dispense_v1_MedicationDispenseCreate
object
9 properties
6 required
type_individual_PatientNonInsurancePayerInfoCreateOptional
object
3 properties
type_insurance-adjudications_v1_InsuranceAdjudication
object
7 properties
4 required
type_pre-encounter_common_ExternalProvider
object
11 properties
2 required
type_encounters_v4_IntakeFollowUp
object
3 properties
2 required
type_charge-capture_v1_ChargeCaptureError
object
8 properties
3 required
type_service-lines_v2_DrugIdentificationOptional
object
8 properties
type_non-insurance-payers_v1_NonInsurancePayerDescriptionUpdate
type_encounters_v4_InterventionOptional
object
5 properties
type_individual_IndividualId
string
type_individual_SubscriberCreateOptional
object
7 properties
type_payer-plan-groups_v1_PayerPlanGroupSortField
string
type_pre-encounter_images_v1_CoverageAssociation
object
An association to a Coverage.
2 properties
2 required
type_health-care-code-information_v1_OccurrenceSpanInformation
object
This corresponds to the BI code qualifier value.
5 properties
3 required
type_patient-ar_v1_NonInsurancePaymentInfo
object
1 property
1 required
type_commons_PreEncounterAppointmentId
string
type_import-invoice_v1_InvoiceItemInfoUpdate
object
2 properties
2 required
type_commons_AdjustmentId
string
type_non-insurance-payers_v1_NonInsurancePayerUpdateRequest
object
4 properties
type_invoices_v2_InvoiceInfo
object
3 properties
3 required
type_patient-payments_v3_PatientPaymentId
string
type_individual_Subscriber
object
8 properties
6 required
type_pre-encounter_notes_v1_NoteType
string
Distinguishes what a note is about. GENERAL = a plain patient note; ELIGIBILITY = a note regarding the patient's eligibility.
type_encounter-providers_v2_BillingProviderSecondaryIdentificationOptional
object
2 properties
type_insurance-adjudications_v1_ClaimAdjudication
object
7 properties
3 required
type_pre-encounter_common_PageToken
string
A token that can be used to retrieve the next or previous page of results
type_patient-refunds_v1_PatientRefund
object
11 properties
6 required
type_encounters_v4_RxCui
string
type_pre-encounter_coverages_v1_CoverageDetails
object
5 properties
4 required
type_pre-encounter_patients_v1_ReferralSource
string
type_claims_Claim
object
8 properties
4 required
type_financials_AllocationCreate
object
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
3 properties
2 required
type_pre-encounter_coverages_v1_PlanMetadata
object
11 properties
type_claim-submission_v1_ExternalClaimSubmissionCreateOptional
object
3 properties
type_commons_ChargeCaptureClaimCreationId
string
type_commons_State
string
type_encounters_v4_PatientHistoryCategoryEnum
string
type_patient-ar_v1_PatientPaymentAllocation
object
2 properties
1 required
type_x12_v1_TypeOfAdmissionOrVisitCode
string
type_guarantor_v1_Guarantor
object
11 properties
9 required
type_commons_SchemaId
string
type_pre-encounter_common_PayerPlanGroupId
string
The unique identifier for a PayerPlanGroup in the database
type_financials_AllocationRestrictionType
string
The dimension along which a payment's auto-allocation can be restricted.
type_events_v1_EventScanPage
object
2 properties
1 required
type_diagnoses_DiagnosisId
string
type_insurance-refunds_v1_InsuranceRefund
object
7 properties
4 required
type_pre-encounter_common_Address
object
8 properties
6 required
type_commons_ServiceLineUnits
string
type_service-lines_v2_ServiceLineAdjustment
object
5 properties
1 required
type_health-care-code-information_v1_AdmittingDiagnosis
object
This corresponds to BJ or ABJ code qualifier values.
4 properties
2 required
type_encounters_v4_ClinicalNoteOptional
object
4 properties
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryGender
string
type_service-lines_v2_MeasurementUnitCode
string
type_charge-capture_v1_ChargeCapture
object
13 properties
6 required
type_health-care-code-information_v1_PatientReasonForVisit
object
This corresponds to PR or APR code qualifier values.
4 properties
2 required
type_tags_TagId
string
type_pre-encounter_appointments_v1_MutableAppointment
object
An object representing a appointment.
18 properties
4 required
type_service-lines_v2_DrugIdentification
object
8 properties
4 required
type_users_v2_UserMetadata
type_pre-encounter_common_ContactPoint
object
3 properties
2 required
type_pre-encounter_eligibilityChecks_v1_Encounter
object
2 properties
type_health-care-code-information_v1_OccurrenceSpanCodeQualifier
string
type_encounter-providers_v2_InitialReferringProviderUpdateWithOptionalAddress
object
8 properties
type_encounter-attachments_v1_EncounterAttachmentType
string
type_encounter-providers_v2_ReferringProviderUpdateWithOptionalAddress
object
7 properties
type_commons_EncounterId
string
type_pre-encounter_common_SortDirection
string
type_payers_v3_PayerIdentifier
type_diagnoses_DiagnosisTypeCode
string
type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundCreate
object
8 properties
3 required
type_health-care-code-information_v1_RD8Date
object
2 properties
2 required
type_pre-encounter_lists_v1_AppointmentListPage
object
4 properties
2 required
type_clinical-trials_v1_MutableClinicalTrial
object
3 properties
2 required
type_pre-encounter_coverages_v1_CoverageValueUnit
string
type_commons_Decimal
string
String representation of a Decimal that can be parsed by most libraries.
type_commons_Date
string
ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryAddress
object
The patient's address. Providing a zip code improves the probability of finding matching coverage.
6 properties
type_service-lines_v2_ServiceIdQualifier
string
type_pre-encounter_eligibilityChecks_v1_StediPayerItem
object
2 properties
2 required
type_pre-encounter_common_CanonicalClinicalTrialId
string
The unique identifier for a clinical trial configured in the Candid system
type_pre-encounter_patientMerges_v1_MutablePatientMerge
object
An object representing a patient merge mapping.
2 properties
2 required
type_charge-capture_v1_ChargeCapturePostBilledChange
object
ChargeCapturePostBilledChange represents a change to a ChargeCapture that occurred after the ChargeCapture's status moved to BILLED. Action must be taken to re…
3 properties
3 required
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentsPage
object
3 properties
1 required
type_commons_UnauthorizedErrorMessage
object
1 property
type_non-insurance-payer-refunds_v1_NonInsurancePayerRefund
object
9 properties
4 required
type_invoices_v2_ClaimInvoiceItemInfo
object
2 properties
1 required
type_custom-schemas_v1_SchemaGetMultiResponse
object
1 property
1 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorSource
string
enum to represent the source of an error in an eligibility check
type_health-care-code-information_v1_ConditionCode
string
FL 18-28 - Condition Codes Source: UB-04 Manual 2025, Pages 64-81 (FL18-28, Pages 1-18) Excludes codes designated as "Payer Codes" or "FOR PUBLIC HEALTH DATA R…
type_encounter-providers_v2_BillingProviderUpdateWithOptionalAddress
object
The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rende…
9 properties
type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsRecommendationPayload
object
Payload for user-configured prompt recommendations from AI analysis
1 property
1 required
type_encounters_v4_IntakeResponseAndFollowUpsOptional
object
2 properties
type_service-lines_v2_DenialReasonContent
string
type_pre-encounter_patients_v1_Referral
object
9 properties
2 required
type_pre-encounter_patients_v1_MaritalStatus
string
type_encounters_v4_SynchronicityType
string
type_health-care-code-information_v1_ValueCodeQualifier
string
type_invoices_v2_InvoiceItemAttributionCreate
Points to the claim or service line that this invoice is attributed to
type_pre-encounter_coverages_v1_PayerPlanGroupFields
object
4 properties
4 required
type_pre-encounter_coverages_v1_BenefitType
string
type_encounters_v4_PriorAuthorizationNumber
string
type_encounter-attachments_v1_AttachmentId
string
type_health-care-code-information_v1_TreatmentCodeQualifier
string
type_non-insurance-payers_v1_ToggleNonInsurancePayerEnablementRequest
object
1 property
1 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderSortField
string
The field to order by. Valid values are keys on the provider object (e.g., name.family, npi, updatedAt, createdAt) or a special ordering "similarname: " (Ex: s…
type_billing-notes_v2_BillingNote
object
8 properties
4 required
type_health-care-code-information_v1_SetOrClearDiagnosisRelatedGroup
object
1 property
type_guarantor_v1_GuarantorOptional
object
10 properties
type_billing-notes_v2_BillingNoteId
string
type_pre-encounter_appointments_v1_VisitsPage
object
4 properties
2 required
type_commons_NextResponsibleParty
string
type_encounters_v4_EncounterSubmissionExpectation
string
Used to describe the currently expected target form for this encounter. This affects what validations and queues the form is processed under. Before submission…
type_encounters_v4_CodingAttributionType
string
type_payers_v3_PayerName
string
type_commons_EncounterExternalId
string
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryProvider
object
Information about the provider requesting the insurance discovery check.
1 property
1 required
type_encounters_v4_ServiceAuthorizationExceptionCode
string
Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values, t…
type_encounters_v4_ClinicalNote
object
4 properties
3 required
type_custom-schemas_v1_SchemaValidationError
type_charge-capture_v1_ChargeExternalIdConflictErrorMessage
object
1 property
type_related-causes_v1_RelatedCausesCode
string
type_pre-encounter_coverages_v1_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundsPage
object
3 properties
1 required
type_patient-ar_v1_PatientARStatus
string
type_pre-encounter_appointments_v1_AppointmentWorkQueue
string
type_pre-encounter_eligibilityChecks_v1_CobAddress
object
A patient's address as returned in a coordination of benefits response.
7 properties
type_encounters_v4_MedicationOptional
object
6 properties
type_patient-ar_v1_InsuranceAdjustmentInfo
object
1 property
1 required
type_write-offs_v1_PatientWriteOffReason
string
type_pre-encounter_patients_v1_Contact
object
6 properties
4 required
type_pre-encounter_eligibilityChecks_v1_CobProvider
object
Information about the entity requesting the COB check. Provide either organizationname (for organizations) or firstname and lastname (for individuals), plus np…
4 properties
1 required
type_invoices_v2_Invoice
object
12 properties
9 required
type_write-offs_v1_WriteOffCreate
type_encounter-providers_v2_TreatingProviderUpdateWithOptionalAddress
object
Update type for the treating provider with optional address fields. Used in contexts where address fields may be partially provided.
6 properties
type_pre-encounter_common_CanonicalServiceFacilityId
string
The unique identifier for a service facility configured in the Candid system
type_individual_PatientClinicalTrialInfoCreateOptional
object
2 properties
type_pre-encounter_tags_v1_Tag
object
A Tag object with immutable server-owned properties.
9 properties
7 required
type_health-care-code-information_v1_OccurrenceSpanCode
string
type_encounter-attachments_v1_ChargeCaptureAttachment
object
6 properties
6 required
type_patient-ar_v1_InsurancePaymentInfo
object
1 property
1 required
type_service-lines_v2_ServiceLineCreateOptional
object
19 properties
type_individual_PatientClinicalTrialInfo
object
2 properties
1 required
type_encounters_v4_LabOptional
object
3 properties
type_health-care-code-information_v1_ExternalCauseOfInjury
object
This corresponds to BN or ABN code qualifier values.
5 properties
2 required
type_financials_Allocation
object
5 properties
2 required
type_pre-encounter_patients_v1_OriginationDetail
object
4 properties
1 required
type_charge-capture_v1_ChargeCaptureSortField
string
type_patient-payments_v3_PatientPayment
object
12 properties
5 required
type_events_v1_EventId
string
type_financials_AllocationOverdraftDetail
object
Structured information about an allocation that would be overdrafted. Provides entity-specific details to display in a table format.
5 properties
5 required
type_commons_PageToken
string
type_pre-encounter_common_PatientMergeId
string
The unique identifier for a PatientMerge record.
type_pre-encounter_patients_v1_ElectronicCommunicationConsent
object
Granular consent for electronic communication channels.
2 properties
type_encounters_v4_IntakeQuestion
object
3 properties
2 required
type_x12_v1_Carc
string
type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier
string
type_diagnoses_Diagnosis
object
8 properties
6 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheck
object
6 properties
1 required
type_commons_UserId
string
type_pre-encounter_appointments_v1_UniversalServiceIdentifier
string
type_users_v2_UserV2
object
4 properties
3 required
type_encounters_v4_InterventionCategory
string
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryRequest
object
An object representing the data for an insurance discovery request.
4 properties
2 required
type_invoices_InvoiceItem
object
2 properties
2 required
type_commons_StreetAddressLongZip
object
6 properties
5 required
type_pre-encounter_common_PatientId
string
The unique identifier for a Patient
type_pre-encounter_eligibilityChecks_v1_VoteValue
string
Possible vote values for recommendation quality
type_service-lines_v2_TestResultOptional
object
2 properties
type_superbills_v1_SuperbillResponse
object
1 property
1 required
type_pre-encounter_common_AddressUse
string
type_encounters_v4_Medication
object
6 properties
1 required
type_non-insurance-payers_v1_NonInsurancePayerSortField
string
type_health-care-code-information_v1_HealthCareCodeInformationGetAllResponse
object
13 properties
9 required
type_pre-encounter_eligibilityChecks_v1_MedicareAdvantageRecommendationPayload
object
An object representing the payload for a Medicare Advantage recommendation.
4 properties
type_invoices_Invoice
object
13 properties
10 required
type_pre-encounter_images_v1_ImageStatus
string
type_invoices_v2_ClaimInvoiceItem
object
2 properties
2 required
type_pre-encounter_common_PatientServiceFacility
object
Represents a canonical service facility attached to a patient or patient dependent object
1 property
1 required
type_invoices_v2_InvoiceItemInfo
object
2 properties
2 required
type_patient-ar_v1_InventoryRecord
object
5 properties
5 required
type_commons_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_eras_EraId
string
type_encounters_v4_ResponsiblePartyType
string
type_commons_WorkQueueId
string
type_x12_v1_TypeOfCareCode
string
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckError
object
2 properties
2 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType
string
type_clinical-trials_v1_ClinicalTrial
object
6 properties
5 required
type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryResponse
object
An object representing the data for an insurance discovery response.
5 properties
type_pre-encounter_common_AppointmentId
string
The unique identifier for an Appointment.
type_commons_StreetAddressShortZipOptional
object
6 properties
type_pre-encounter_patients_v1_ReferralType
string
type_pre-encounter_coverages_v1_ExpandedMemberInfo
object
8 properties
type_patient-payments_v3_PatientPaymentSource
string
type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentCreate
object
7 properties
3 required
type_payer-plan-groups_v1_MutablePayerPlanGroup
object
3 properties
3 required
type_custom-schemas_v1_Schema
object
4 properties
3 required
type_pre-encounter_images_v1_MutableImage
object
An object representing an Image.
6 properties
4 required
type_yes-no-indicator_YesNoIndicator
string
type_pre-encounter_common_ErrorBase5xx
object
2 properties
1 required
type_pre-encounter_images_v1_PatientAssociation
object
An association to a Patient.
2 properties
1 required
type_encounters_v4_VitalsUpdate
object
7 properties
type_pre-encounter_common_PayerId
string
The unique identifier for a Payer in the database
type_organization-providers_v2_LicenseType
string
type_external-payment-account-config_v1_ExternalPaymentAccountConfig
object
2 properties
2 required
type_commons_ProviderId
string
type_encounters_v4_EPSDTReferralOptional
object
3 properties
type_pre-encounter_coverages_v1_RelatedEntityContact
object
2 properties
type_commons_BillingProviderCommercialLicenseType
string
type_pre-encounter_appointments_v1_Appointment
object
An appointment object with immutable server-owned properties.
24 properties
10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Candid Health 11
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 Default API
Candid Health Diagnoses API
Candid Health V2 API
Candid Health V3 API
Candid Health V4 API
#v1
Where this information came from
This is an independent, third-party profile of Candid Health V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.