candidhealth 0.16.2 → 0.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/resources/auth/resources/v2/client/Client.d.ts +0 -1
- package/api/resources/auth/resources/v2/client/Client.js +1 -2
- package/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
- package/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +0 -1
- package/api/resources/claimSubmission/resources/v1/types/ExternalClaimSubmissionCreate.d.ts +0 -2
- package/api/resources/commons/types/DelayReasonCode.d.ts +65 -0
- package/api/resources/commons/types/DelayReasonCode.js +22 -0
- package/api/resources/commons/types/FacilityTypeCode.d.ts +0 -1
- package/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
- package/api/resources/commons/types/ProcedureModifier.d.ts +4 -8
- package/api/resources/commons/types/index.d.ts +1 -0
- package/api/resources/commons/types/index.js +1 -0
- package/api/resources/contracts/resources/v2/client/Client.js +5 -5
- package/api/resources/contracts/resources/v2/types/ContractBase.d.ts +3 -13
- package/api/resources/contracts/resources/v2/types/ContractStatus.d.ts +3 -6
- package/api/resources/diagnoses/types/DiagnosisCreate.d.ts +6 -9
- package/api/resources/eligibility/resources/v2/client/Client.d.ts +13 -1
- package/api/resources/eligibility/resources/v2/client/Client.js +37 -2
- package/api/resources/eligibility/resources/v2/client/index.d.ts +1 -0
- package/api/resources/eligibility/resources/v2/client/index.js +2 -1
- package/api/resources/eligibility/resources/v2/client/submitEligibilityCheckAvaility.d.ts +22 -0
- package/api/resources/eligibility/resources/v2/client/submitEligibilityCheckAvaility.js +47 -0
- package/api/resources/encounterProviders/resources/v2/types/BillingProvider.d.ts +1 -5
- package/api/resources/encounterProviders/resources/v2/types/EncounterProviderBase.d.ts +3 -12
- package/api/resources/encounterProviders/resources/v2/types/ReferringProvider.d.ts +0 -1
- package/api/resources/encounterProviders/resources/v2/types/RenderingProvider.d.ts +0 -1
- package/api/resources/encounters/resources/v4/client/Client.js +4 -4
- package/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +6 -0
- package/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts +0 -6
- package/api/resources/encounters/resources/v4/types/Encounter.d.ts +6 -28
- package/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +12 -27
- package/api/resources/encounters/resources/v4/types/Intervention.d.ts +1 -4
- package/api/resources/encounters/resources/v4/types/ServiceAuthorizationExceptionCode.d.ts +0 -1
- package/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +0 -1
- package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -2
- package/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +0 -2
- package/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +2 -4
- package/api/resources/expectedNetworkStatus/resources/v2/types/ComputeAllInNetworkProvidersRequest.d.ts +1 -5
- package/api/resources/expectedNetworkStatus/resources/v2/types/ExpectedNetworkStatusRequestV2.d.ts +1 -5
- package/api/resources/exports/resources/v3/client/Client.d.ts +0 -1
- package/api/resources/exports/resources/v3/client/Client.js +1 -2
- package/api/resources/exports/resources/v3/client/requests/GetExportsRequest.d.ts +0 -2
- package/api/resources/financials/types/AllocationCreate.d.ts +0 -1
- package/api/resources/financials/types/AllocationTarget.d.ts +0 -1
- package/api/resources/financials/types/AllocationTargetCreate.d.ts +0 -1
- package/api/resources/guarantor/resources/v1/client/Client.d.ts +0 -3
- package/api/resources/guarantor/resources/v1/client/Client.js +3 -6
- package/api/resources/individual/types/PatientBase.d.ts +1 -5
- package/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +0 -3
- package/api/resources/insuranceAdjudications/resources/v1/client/Client.js +3 -6
- package/api/resources/insurancePayments/resources/v1/client/Client.d.ts +0 -5
- package/api/resources/insurancePayments/resources/v1/client/Client.js +5 -10
- package/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +0 -5
- package/api/resources/insuranceRefunds/resources/v1/client/Client.js +5 -10
- package/api/resources/organizationProviders/resources/v2/types/OrganizationProviderBase.d.ts +2 -8
- package/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
- package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderCreateV2.d.ts +2 -8
- package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderUpdateV2.d.ts +2 -8
- package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +2 -8
- package/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +5 -5
- package/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacility.d.ts +0 -1
- package/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacilityCreate.d.ts +0 -1
- package/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacilityUpdate.d.ts +0 -1
- package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
- package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
- package/api/resources/patientPayments/resources/v4/client/Client.d.ts +0 -5
- package/api/resources/patientPayments/resources/v4/client/Client.js +5 -10
- package/api/resources/patientRefunds/resources/v1/client/Client.d.ts +0 -5
- package/api/resources/patientRefunds/resources/v1/client/Client.js +5 -10
- package/api/resources/payers/resources/v3/client/Client.js +2 -2
- package/api/resources/serviceFacility/client/Client.js +1 -1
- package/api/resources/serviceFacility/types/EncounterServiceFacility.d.ts +1 -5
- package/api/resources/serviceFacility/types/EncounterServiceFacilityBase.d.ts +1 -6
- package/api/resources/serviceLines/resources/v2/types/ServiceIdQualifier.d.ts +1 -2
- package/api/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +2 -2
- package/api/resources/serviceLines/resources/v2/types/ServiceLineCreate.d.ts +2 -2
- package/api/resources/serviceLines/resources/v2/types/ServiceLineDenialReason.d.ts +0 -1
- package/api/resources/tasks/resources/commons/types/TaskCategory.d.ts +2 -1
- package/api/resources/tasks/resources/commons/types/TaskCategory.js +1 -0
- package/api/resources/tasks/resources/v3/client/Client.js +5 -5
- package/api/resources/writeOffs/resources/v1/client/Client.d.ts +0 -4
- package/api/resources/writeOffs/resources/v1/client/Client.js +4 -8
- package/dist/api/resources/auth/resources/v2/client/Client.d.ts +0 -1
- package/dist/api/resources/auth/resources/v2/client/Client.js +1 -2
- package/dist/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
- package/dist/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +0 -1
- package/dist/api/resources/claimSubmission/resources/v1/types/ExternalClaimSubmissionCreate.d.ts +0 -2
- package/dist/api/resources/commons/types/DelayReasonCode.d.ts +65 -0
- package/dist/api/resources/commons/types/DelayReasonCode.js +22 -0
- package/dist/api/resources/commons/types/FacilityTypeCode.d.ts +0 -1
- package/dist/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
- package/dist/api/resources/commons/types/ProcedureModifier.d.ts +4 -8
- package/dist/api/resources/commons/types/index.d.ts +1 -0
- package/dist/api/resources/commons/types/index.js +1 -0
- package/dist/api/resources/contracts/resources/v2/client/Client.js +5 -5
- package/dist/api/resources/contracts/resources/v2/types/ContractBase.d.ts +3 -13
- package/dist/api/resources/contracts/resources/v2/types/ContractStatus.d.ts +3 -6
- package/dist/api/resources/diagnoses/types/DiagnosisCreate.d.ts +6 -9
- package/dist/api/resources/eligibility/resources/v2/client/Client.d.ts +13 -1
- package/dist/api/resources/eligibility/resources/v2/client/Client.js +37 -2
- package/dist/api/resources/eligibility/resources/v2/client/index.d.ts +1 -0
- package/dist/api/resources/eligibility/resources/v2/client/index.js +2 -1
- package/dist/api/resources/eligibility/resources/v2/client/submitEligibilityCheckAvaility.d.ts +22 -0
- package/dist/api/resources/eligibility/resources/v2/client/submitEligibilityCheckAvaility.js +47 -0
- package/dist/api/resources/encounterProviders/resources/v2/types/BillingProvider.d.ts +1 -5
- package/dist/api/resources/encounterProviders/resources/v2/types/EncounterProviderBase.d.ts +3 -12
- package/dist/api/resources/encounterProviders/resources/v2/types/ReferringProvider.d.ts +0 -1
- package/dist/api/resources/encounterProviders/resources/v2/types/RenderingProvider.d.ts +0 -1
- package/dist/api/resources/encounters/resources/v4/client/Client.js +4 -4
- package/dist/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +6 -0
- package/dist/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts +0 -6
- package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts +6 -28
- package/dist/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +12 -27
- package/dist/api/resources/encounters/resources/v4/types/Intervention.d.ts +1 -4
- package/dist/api/resources/encounters/resources/v4/types/ServiceAuthorizationExceptionCode.d.ts +0 -1
- package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +0 -1
- package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -2
- package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +0 -2
- package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +2 -4
- package/dist/api/resources/expectedNetworkStatus/resources/v2/types/ComputeAllInNetworkProvidersRequest.d.ts +1 -5
- package/dist/api/resources/expectedNetworkStatus/resources/v2/types/ExpectedNetworkStatusRequestV2.d.ts +1 -5
- package/dist/api/resources/exports/resources/v3/client/Client.d.ts +0 -1
- package/dist/api/resources/exports/resources/v3/client/Client.js +1 -2
- package/dist/api/resources/exports/resources/v3/client/requests/GetExportsRequest.d.ts +0 -2
- package/dist/api/resources/financials/types/AllocationCreate.d.ts +0 -1
- package/dist/api/resources/financials/types/AllocationTarget.d.ts +0 -1
- package/dist/api/resources/financials/types/AllocationTargetCreate.d.ts +0 -1
- package/dist/api/resources/guarantor/resources/v1/client/Client.d.ts +0 -3
- package/dist/api/resources/guarantor/resources/v1/client/Client.js +3 -6
- package/dist/api/resources/individual/types/PatientBase.d.ts +1 -5
- package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +0 -3
- package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.js +3 -6
- package/dist/api/resources/insurancePayments/resources/v1/client/Client.d.ts +0 -5
- package/dist/api/resources/insurancePayments/resources/v1/client/Client.js +5 -10
- package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +0 -5
- package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.js +5 -10
- package/dist/api/resources/organizationProviders/resources/v2/types/OrganizationProviderBase.d.ts +2 -8
- package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
- package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderCreateV2.d.ts +2 -8
- package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderUpdateV2.d.ts +2 -8
- package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +2 -8
- package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +5 -5
- package/dist/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacility.d.ts +0 -1
- package/dist/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacilityCreate.d.ts +0 -1
- package/dist/api/resources/organizationServiceFacilities/resources/v2/types/OrganizationServiceFacilityUpdate.d.ts +0 -1
- package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
- package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
- package/dist/api/resources/patientPayments/resources/v4/client/Client.d.ts +0 -5
- package/dist/api/resources/patientPayments/resources/v4/client/Client.js +5 -10
- package/dist/api/resources/patientRefunds/resources/v1/client/Client.d.ts +0 -5
- package/dist/api/resources/patientRefunds/resources/v1/client/Client.js +5 -10
- package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
- package/dist/api/resources/serviceFacility/client/Client.js +1 -1
- package/dist/api/resources/serviceFacility/types/EncounterServiceFacility.d.ts +1 -5
- package/dist/api/resources/serviceFacility/types/EncounterServiceFacilityBase.d.ts +1 -6
- package/dist/api/resources/serviceLines/resources/v2/types/ServiceIdQualifier.d.ts +1 -2
- package/dist/api/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +2 -2
- package/dist/api/resources/serviceLines/resources/v2/types/ServiceLineCreate.d.ts +2 -2
- package/dist/api/resources/serviceLines/resources/v2/types/ServiceLineDenialReason.d.ts +0 -1
- package/dist/api/resources/tasks/resources/commons/types/TaskCategory.d.ts +2 -1
- package/dist/api/resources/tasks/resources/commons/types/TaskCategory.js +1 -0
- package/dist/api/resources/tasks/resources/v3/client/Client.js +5 -5
- package/dist/api/resources/writeOffs/resources/v1/client/Client.d.ts +0 -4
- package/dist/api/resources/writeOffs/resources/v1/client/Client.js +4 -8
- package/dist/serialization/resources/commons/types/DelayReasonCode.d.ts +10 -0
- package/dist/serialization/resources/commons/types/DelayReasonCode.js +31 -0
- package/dist/serialization/resources/commons/types/index.d.ts +1 -0
- package/dist/serialization/resources/commons/types/index.js +1 -0
- package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +1 -0
- package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.js +1 -0
- package/dist/serialization/resources/encounters/resources/v4/types/EncounterBase.d.ts +1 -0
- package/dist/serialization/resources/encounters/resources/v4/types/EncounterBase.js +1 -0
- package/dist/serialization/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +1 -0
- package/dist/serialization/resources/serviceLines/resources/v2/types/ServiceLine.js +1 -0
- package/dist/serialization/resources/serviceLines/resources/v2/types/ServiceLineCreate.d.ts +1 -0
- package/dist/serialization/resources/serviceLines/resources/v2/types/ServiceLineCreate.js +1 -0
- package/dist/serialization/resources/tasks/resources/commons/types/TaskCategory.d.ts +1 -1
- package/dist/serialization/resources/tasks/resources/commons/types/TaskCategory.js +1 -0
- package/package.json +1 -1
- package/serialization/resources/commons/types/DelayReasonCode.d.ts +10 -0
- package/serialization/resources/commons/types/DelayReasonCode.js +31 -0
- package/serialization/resources/commons/types/index.d.ts +1 -0
- package/serialization/resources/commons/types/index.js +1 -0
- package/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +1 -0
- package/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.js +1 -0
- package/serialization/resources/encounters/resources/v4/types/EncounterBase.d.ts +1 -0
- package/serialization/resources/encounters/resources/v4/types/EncounterBase.js +1 -0
- package/serialization/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +1 -0
- package/serialization/resources/serviceLines/resources/v2/types/ServiceLine.js +1 -0
- package/serialization/resources/serviceLines/resources/v2/types/ServiceLineCreate.d.ts +1 -0
- package/serialization/resources/serviceLines/resources/v2/types/ServiceLineCreate.js +1 -0
- package/serialization/resources/tasks/resources/commons/types/TaskCategory.d.ts +1 -1
- package/serialization/resources/tasks/resources/commons/types/TaskCategory.js +1 -0
|
@@ -18,12 +18,10 @@ export interface GetAllEncountersRequest {
|
|
|
18
18
|
pageToken?: CandidApi.PageToken;
|
|
19
19
|
/**
|
|
20
20
|
* Date formatted as YYYY-MM-DD; eg: 2019-08-25.
|
|
21
|
-
*
|
|
22
21
|
*/
|
|
23
22
|
dateOfServiceMin?: CandidApi.Date_;
|
|
24
23
|
/**
|
|
25
24
|
* Date formatted as YYYY-MM-DD; eg: 2019-08-25.
|
|
26
|
-
*
|
|
27
25
|
*/
|
|
28
26
|
dateOfServiceMax?: CandidApi.Date_;
|
|
29
27
|
/**
|
|
@@ -34,7 +32,6 @@ export interface GetAllEncountersRequest {
|
|
|
34
32
|
* Filter by any of the following fields: encounter_id, claim_id, patient external_id,
|
|
35
33
|
* patient date of birth, patient first name, patient last name,
|
|
36
34
|
* or encounter external id.
|
|
37
|
-
*
|
|
38
35
|
*/
|
|
39
36
|
searchTerm?: string;
|
|
40
37
|
/**
|
|
@@ -43,7 +40,6 @@ export interface GetAllEncountersRequest {
|
|
|
43
40
|
externalId?: CandidApi.EncounterExternalId;
|
|
44
41
|
/**
|
|
45
42
|
* ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z.
|
|
46
|
-
*
|
|
47
43
|
*/
|
|
48
44
|
diagnosesUpdatedSince?: Date;
|
|
49
45
|
/**
|
|
@@ -53,12 +49,10 @@ export interface GetAllEncountersRequest {
|
|
|
53
49
|
workQueueId?: CandidApi.WorkQueueId;
|
|
54
50
|
/**
|
|
55
51
|
* Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
|
|
56
|
-
*
|
|
57
52
|
*/
|
|
58
53
|
billableStatus?: CandidApi.encounters.v4.BillableStatusType;
|
|
59
54
|
/**
|
|
60
55
|
* Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay.
|
|
61
|
-
*
|
|
62
56
|
*/
|
|
63
57
|
responsibleParty?: CandidApi.encounters.v4.ResponsiblePartyType;
|
|
64
58
|
/**
|
|
@@ -378,64 +378,43 @@ import * as CandidApi from "../../../../..";
|
|
|
378
378
|
export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
|
|
379
379
|
encounterId: CandidApi.EncounterId;
|
|
380
380
|
claims: CandidApi.Claim[];
|
|
381
|
-
/**
|
|
382
|
-
* Contains the identification information of the individual receiving medical services.
|
|
383
|
-
*
|
|
384
|
-
*/
|
|
381
|
+
/** Contains the identification information of the individual receiving medical services. */
|
|
385
382
|
patient: CandidApi.Patient;
|
|
386
383
|
/** Personal and contact info for the guarantor of the patient responsibility. */
|
|
387
384
|
guarantor?: CandidApi.guarantor.v1.Guarantor;
|
|
388
|
-
/**
|
|
389
|
-
* 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 rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
|
|
390
|
-
*
|
|
391
|
-
*/
|
|
385
|
+
/** 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 rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form. */
|
|
392
386
|
billingProvider: CandidApi.encounterProviders.v2.EncounterProvider;
|
|
393
387
|
/**
|
|
394
388
|
* The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
|
|
395
389
|
* For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
|
|
396
|
-
*
|
|
397
390
|
*/
|
|
398
391
|
renderingProvider: CandidApi.encounterProviders.v2.EncounterProvider;
|
|
399
392
|
referringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
|
|
400
|
-
/**
|
|
401
|
-
* Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process.
|
|
402
|
-
*
|
|
403
|
-
*/
|
|
393
|
+
/** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process. */
|
|
404
394
|
serviceFacility: CandidApi.EncounterServiceFacility;
|
|
405
395
|
/**
|
|
406
396
|
* Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
|
|
407
397
|
* These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
|
|
408
398
|
* However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
|
|
409
399
|
* Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
|
|
410
|
-
*
|
|
411
400
|
*/
|
|
412
401
|
subscriberPrimary?: CandidApi.Subscriber;
|
|
413
402
|
/** Contains details of the secondary insurance subscriber. */
|
|
414
403
|
subscriberSecondary?: CandidApi.Subscriber;
|
|
415
404
|
/** URL that links directly to the claim created in Candid. */
|
|
416
405
|
url: CandidApi.LinkUrl;
|
|
417
|
-
/**
|
|
418
|
-
* Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor.
|
|
419
|
-
*
|
|
420
|
-
*/
|
|
406
|
+
/** Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor. */
|
|
421
407
|
diagnoses: CandidApi.Diagnosis[];
|
|
422
408
|
/** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
|
|
423
409
|
clinicalNotes: CandidApi.encounters.v4.ClinicalNoteCategory[];
|
|
424
410
|
/**
|
|
425
411
|
* Spot to store misc, human-readable, notes about this encounter to be
|
|
426
412
|
* used in the billing process.
|
|
427
|
-
*
|
|
428
413
|
*/
|
|
429
414
|
billingNotes?: CandidApi.billingNotes.v2.BillingNote[];
|
|
430
|
-
/**
|
|
431
|
-
* 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.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
|
|
432
|
-
*
|
|
433
|
-
*/
|
|
415
|
+
/** 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.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
|
|
434
416
|
placeOfServiceCode?: CandidApi.FacilityTypeCode;
|
|
435
|
-
/**
|
|
436
|
-
* 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.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
|
|
437
|
-
*
|
|
438
|
-
*/
|
|
417
|
+
/** 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.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
|
|
439
418
|
placeOfServiceCodeAsSubmitted?: CandidApi.FacilityTypeCode;
|
|
440
419
|
patientHistories: CandidApi.encounters.v4.PatientHistoryCategory[];
|
|
441
420
|
patientPayments: CandidApi.patientPayments.v3.PatientPayment[];
|
|
@@ -450,7 +429,6 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
|
|
|
450
429
|
* The party who originally submitted the Claim.
|
|
451
430
|
* For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID.
|
|
452
431
|
* For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL.
|
|
453
|
-
*
|
|
454
432
|
*/
|
|
455
433
|
submissionOrigin: CandidApi.encounters.v4.EncounterSubmissionOriginType;
|
|
456
434
|
}
|
|
@@ -7,7 +7,6 @@ export interface EncounterBase {
|
|
|
7
7
|
* A client-specified unique ID to associate with this encounter;
|
|
8
8
|
* for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
|
9
9
|
* This field should not contain PHI.
|
|
10
|
-
*
|
|
11
10
|
*/
|
|
12
11
|
externalId: CandidApi.EncounterExternalId;
|
|
13
12
|
/**
|
|
@@ -15,7 +14,6 @@ export interface EncounterBase {
|
|
|
15
14
|
* This date must be the local date in the timezone where the service occurred.
|
|
16
15
|
* Box 24a on the CMS-1500 claim form.
|
|
17
16
|
* If service occurred over a range of dates, this should be the start date.
|
|
18
|
-
*
|
|
19
17
|
*/
|
|
20
18
|
dateOfService: CandidApi.Date_;
|
|
21
19
|
/**
|
|
@@ -23,7 +21,6 @@ export interface EncounterBase {
|
|
|
23
21
|
* This date must be the local date in the timezone where the service occurred.
|
|
24
22
|
* If omitted, the Encounter is assumed to be for a single day.
|
|
25
23
|
* Must not be temporally before the date_of_service field.
|
|
26
|
-
*
|
|
27
24
|
*/
|
|
28
25
|
endDateOfService?: CandidApi.Date_;
|
|
29
26
|
/** Box 23 on the CMS-1500 claim form. */
|
|
@@ -32,27 +29,21 @@ export interface EncounterBase {
|
|
|
32
29
|
* Whether this patient has authorized the release of medical information
|
|
33
30
|
* for billing purpose.
|
|
34
31
|
* Box 12 on the CMS-1500 claim form.
|
|
35
|
-
*
|
|
36
32
|
*/
|
|
37
33
|
patientAuthorizedRelease: boolean;
|
|
38
34
|
/**
|
|
39
35
|
* Whether this patient has authorized insurance payments to be made to you,
|
|
40
36
|
* not them. If false, patient may receive reimbursement.
|
|
41
37
|
* Box 13 on the CMS-1500 claim form.
|
|
42
|
-
*
|
|
43
38
|
*/
|
|
44
39
|
benefitsAssignedToProvider: boolean;
|
|
45
40
|
/**
|
|
46
41
|
* Whether you have accepted the patient's authorization for insurance payments
|
|
47
42
|
* to be made to you, not them.
|
|
48
43
|
* Box 27 on the CMS-1500 claim form.
|
|
49
|
-
*
|
|
50
44
|
*/
|
|
51
45
|
providerAcceptsAssignment: boolean;
|
|
52
|
-
/**
|
|
53
|
-
* Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
46
|
+
/** Human-readable description of the appointment type (ex: "Acupuncture - Headaches"). */
|
|
56
47
|
appointmentType?: string;
|
|
57
48
|
existingMedications?: CandidApi.encounters.v4.Medication[];
|
|
58
49
|
vitals?: CandidApi.encounters.v4.Vitals;
|
|
@@ -65,61 +56,55 @@ export interface EncounterBase {
|
|
|
65
56
|
* forms, instant messaging, or other pre-recorded digital mediums.
|
|
66
57
|
* Synchronous encounters occur in live, real-time settings where the patient interacts
|
|
67
58
|
* directly with the provider, such as over video or a phone call.
|
|
68
|
-
*
|
|
69
59
|
*/
|
|
70
60
|
synchronicity?: CandidApi.encounters.v4.SynchronicityType;
|
|
71
61
|
/**
|
|
72
62
|
* Defines if the Encounter is to be billed by Candid to the responsible_party.
|
|
73
63
|
* Examples for when this should be set to NOT_BILLABLE include
|
|
74
64
|
* if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
|
|
75
|
-
*
|
|
76
65
|
*/
|
|
77
66
|
billableStatus: CandidApi.encounters.v4.BillableStatusType;
|
|
78
|
-
/**
|
|
79
|
-
* Defines the party to be billed with the initial balance owed on the claim.
|
|
80
|
-
*
|
|
81
|
-
*/
|
|
67
|
+
/** Defines the party to be billed with the initial balance owed on the claim. */
|
|
82
68
|
responsibleParty: CandidApi.encounters.v4.ResponsiblePartyType;
|
|
83
69
|
/**
|
|
84
70
|
* Defines additional information on the claim needed by the payer.
|
|
85
71
|
* Box 19 on the CMS-1500 claim form.
|
|
86
|
-
*
|
|
87
72
|
*/
|
|
88
73
|
additionalInformation?: string;
|
|
89
74
|
/**
|
|
90
|
-
* 837p Loop2300 REF
|
|
75
|
+
* 837p Loop2300 REF\*4N
|
|
91
76
|
* Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the
|
|
92
77
|
* reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without
|
|
93
78
|
* obtaining the authorization.
|
|
94
|
-
*
|
|
95
79
|
*/
|
|
96
80
|
serviceAuthorizationExceptionCode?: CandidApi.encounters.v4.ServiceAuthorizationExceptionCode;
|
|
97
81
|
/**
|
|
98
|
-
* 837p Loop2300 DTP
|
|
82
|
+
* 837p Loop2300 DTP\*435, CMS-1500 Box 18
|
|
99
83
|
* Required on all ambulance claims when the patient was known to be admitted to the hospital.
|
|
100
84
|
* OR
|
|
101
85
|
* Required on all claims involving inpatient medical visits.
|
|
102
|
-
*
|
|
103
86
|
*/
|
|
104
87
|
admissionDate?: CandidApi.Date_;
|
|
105
88
|
/**
|
|
106
|
-
* 837p Loop2300 DTP
|
|
89
|
+
* 837p Loop2300 DTP\*096, CMS-1500 Box 18
|
|
107
90
|
* Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.
|
|
108
|
-
*
|
|
109
91
|
*/
|
|
110
92
|
dischargeDate?: CandidApi.Date_;
|
|
111
93
|
/**
|
|
112
|
-
* 837p Loop2300 DTP
|
|
94
|
+
* 837p Loop2300 DTP\*431, CMS-1500 Box 14
|
|
113
95
|
* Required for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service.
|
|
114
96
|
* OR
|
|
115
97
|
* This date is the onset of acute symptoms for the current illness or condition.
|
|
116
|
-
*
|
|
117
98
|
*/
|
|
118
99
|
onsetOfCurrentIllnessOrSymptomDate?: CandidApi.Date_;
|
|
119
100
|
/**
|
|
120
|
-
* 837p Loop2300 DTP
|
|
101
|
+
* 837p Loop2300 DTP\*484, CMS-1500 Box 14
|
|
121
102
|
* Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
|
|
122
|
-
*
|
|
123
103
|
*/
|
|
124
104
|
lastMenstrualPeriodDate?: CandidApi.Date_;
|
|
105
|
+
/**
|
|
106
|
+
* 837i Loop2300, CLM-1300 Box 20
|
|
107
|
+
* Code indicating the reason why a request was delayed
|
|
108
|
+
*/
|
|
109
|
+
delayReasonCode?: CandidApi.DelayReasonCode;
|
|
125
110
|
}
|
|
@@ -26,10 +26,7 @@ import * as CandidApi from "../../../../..";
|
|
|
26
26
|
export interface Intervention {
|
|
27
27
|
name: string;
|
|
28
28
|
category: CandidApi.encounters.v4.InterventionCategory;
|
|
29
|
-
/**
|
|
30
|
-
* "Examples: 'Birth Control LAC', 'Tracking', 'Stress Management', 'Supplement', 'Labs'"
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
29
|
+
/** "Examples: 'Birth Control LAC', 'Tracking', 'Stress Management', 'Supplement', 'Labs'" */
|
|
33
30
|
description?: string;
|
|
34
31
|
/** Required when `type` is `allopathic`. */
|
|
35
32
|
medication?: CandidApi.encounters.v4.Medication;
|
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the
|
|
6
6
|
* reasons listed in one of the enum values, the service was performed without obtaining the authorization.
|
|
7
|
-
*
|
|
8
7
|
*/
|
|
9
8
|
export declare type ServiceAuthorizationExceptionCode =
|
|
10
9
|
/**
|
|
@@ -15,7 +15,6 @@ export declare class V1 {
|
|
|
15
15
|
constructor(options: V1.Options);
|
|
16
16
|
/**
|
|
17
17
|
* Computes the expected network status given the provided information.
|
|
18
|
-
*
|
|
19
18
|
*/
|
|
20
19
|
compute(request: CandidApi.expectedNetworkStatus.v1.ExpectedNetworkStatusRequest): Promise<core.APIResponse<CandidApi.expectedNetworkStatus.v1.ExpectedNetworkStatusResponse, CandidApi.expectedNetworkStatus.v1.compute.Error>>;
|
|
21
20
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
@@ -42,7 +42,6 @@ class V1 {
|
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
44
|
* Computes the expected network status given the provided information.
|
|
45
|
-
*
|
|
46
45
|
*/
|
|
47
46
|
async compute(request) {
|
|
48
47
|
const _response = await core.fetcher({
|
|
@@ -52,7 +51,7 @@ class V1 {
|
|
|
52
51
|
Authorization: await this._getAuthorizationHeader(),
|
|
53
52
|
"X-Fern-Language": "JavaScript",
|
|
54
53
|
"X-Fern-SDK-Name": "candidhealth",
|
|
55
|
-
"X-Fern-SDK-Version": "0.
|
|
54
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
56
55
|
},
|
|
57
56
|
contentType: "application/json",
|
|
58
57
|
body: await serializers.expectedNetworkStatus.v1.ExpectedNetworkStatusRequest.jsonOrThrow(request, {
|
|
@@ -17,14 +17,12 @@ export declare class V2 {
|
|
|
17
17
|
* Computes the expected network status for a given rendering provider.
|
|
18
18
|
* This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
19
19
|
* to discuss enabling this endpoint if it is not available for your organization.
|
|
20
|
-
*
|
|
21
20
|
*/
|
|
22
21
|
computeForRenderingProvider(renderingProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId, request: CandidApi.expectedNetworkStatus.v2.ExpectedNetworkStatusRequestV2): Promise<core.APIResponse<CandidApi.expectedNetworkStatus.v2.ExpectedNetworkStatusResponseV2, CandidApi.expectedNetworkStatus.v2.computeForRenderingProvider.Error>>;
|
|
23
22
|
/**
|
|
24
23
|
* Computes all the in network providers for a given set of inputs.
|
|
25
24
|
* This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
26
25
|
* to discuss enabling this endpoint if it is not available for your organization.
|
|
27
|
-
*
|
|
28
26
|
*/
|
|
29
27
|
computeAllInNetworkProviders(request: CandidApi.expectedNetworkStatus.v2.ComputeAllInNetworkProvidersRequest): Promise<core.APIResponse<CandidApi.expectedNetworkStatus.v2.ComputeAllInNetworkProvidersResponse, CandidApi.expectedNetworkStatus.v2.computeAllInNetworkProviders.Error>>;
|
|
30
28
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
@@ -44,7 +44,6 @@ class V2 {
|
|
|
44
44
|
* Computes the expected network status for a given rendering provider.
|
|
45
45
|
* This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
46
46
|
* to discuss enabling this endpoint if it is not available for your organization.
|
|
47
|
-
*
|
|
48
47
|
*/
|
|
49
48
|
async computeForRenderingProvider(renderingProviderId, request) {
|
|
50
49
|
const _response = await core.fetcher({
|
|
@@ -54,7 +53,7 @@ class V2 {
|
|
|
54
53
|
Authorization: await this._getAuthorizationHeader(),
|
|
55
54
|
"X-Fern-Language": "JavaScript",
|
|
56
55
|
"X-Fern-SDK-Name": "candidhealth",
|
|
57
|
-
"X-Fern-SDK-Version": "0.
|
|
56
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
58
57
|
},
|
|
59
58
|
contentType: "application/json",
|
|
60
59
|
body: await serializers.expectedNetworkStatus.v2.ExpectedNetworkStatusRequestV2.jsonOrThrow(request, {
|
|
@@ -99,7 +98,6 @@ class V2 {
|
|
|
99
98
|
* Computes all the in network providers for a given set of inputs.
|
|
100
99
|
* This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
101
100
|
* to discuss enabling this endpoint if it is not available for your organization.
|
|
102
|
-
*
|
|
103
101
|
*/
|
|
104
102
|
async computeAllInNetworkProviders(request) {
|
|
105
103
|
const _response = await core.fetcher({
|
|
@@ -109,7 +107,7 @@ class V2 {
|
|
|
109
107
|
Authorization: await this._getAuthorizationHeader(),
|
|
110
108
|
"X-Fern-Language": "JavaScript",
|
|
111
109
|
"X-Fern-SDK-Name": "candidhealth",
|
|
112
|
-
"X-Fern-SDK-Version": "0.
|
|
110
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
113
111
|
},
|
|
114
112
|
contentType: "application/json",
|
|
115
113
|
body: await serializers.expectedNetworkStatus.v2.ComputeAllInNetworkProvidersRequest.jsonOrThrow(request, {
|
|
@@ -12,15 +12,11 @@ export interface ComputeAllInNetworkProvidersRequest {
|
|
|
12
12
|
* (see “Inputs: Service Type” in the appendix for list of qualifying CPT codes and behavioral health routing logic).
|
|
13
13
|
* Since CPT codes are not available pre-appointment, the service type input is used to determine whether the appointment is expected
|
|
14
14
|
* to qualify as behavioral health.
|
|
15
|
-
*
|
|
16
15
|
*/
|
|
17
16
|
serviceType: CandidApi.expectedNetworkStatus.v2.ServiceType;
|
|
18
17
|
/** Expected place of service */
|
|
19
18
|
placeOfServiceCode: CandidApi.FacilityTypeCode;
|
|
20
|
-
/**
|
|
21
|
-
* Information present on the patient's insurance card
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
19
|
+
/** Information present on the patient's insurance card */
|
|
24
20
|
subscriberInformation: CandidApi.expectedNetworkStatus.v2.ExpectedNetworkStatusSubscriberInformation;
|
|
25
21
|
patientAddress: CandidApi.StreetAddressShortZip;
|
|
26
22
|
billingProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId;
|
package/api/resources/expectedNetworkStatus/resources/v2/types/ExpectedNetworkStatusRequestV2.d.ts
CHANGED
|
@@ -12,15 +12,11 @@ export interface ExpectedNetworkStatusRequestV2 {
|
|
|
12
12
|
* (see “Inputs: Service Type” in the appendix for list of qualifying CPT codes and behavioral health routing logic).
|
|
13
13
|
* Since CPT codes are not available pre-appointment, the service type input is used to determine whether the appointment is expected
|
|
14
14
|
* to qualify as behavioral health.
|
|
15
|
-
*
|
|
16
15
|
*/
|
|
17
16
|
serviceType: CandidApi.expectedNetworkStatus.v2.ServiceType;
|
|
18
17
|
/** Expected place of service */
|
|
19
18
|
placeOfServiceCode: CandidApi.FacilityTypeCode;
|
|
20
|
-
/**
|
|
21
|
-
* Information present on the patient's insurance card
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
19
|
+
/** Information present on the patient's insurance card */
|
|
24
20
|
subscriberInformation: CandidApi.expectedNetworkStatus.v2.ExpectedNetworkStatusSubscriberInformation;
|
|
25
21
|
patientAddress: CandidApi.StreetAddressShortZip;
|
|
26
22
|
billingProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId;
|
|
@@ -26,7 +26,6 @@ export declare class V3 {
|
|
|
26
26
|
* available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the
|
|
27
27
|
* caller will receive a 422 response. If the file has already been generated, it will be served. Please email
|
|
28
28
|
* our [Support team](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.
|
|
29
|
-
*
|
|
30
29
|
*/
|
|
31
30
|
getExports(request: CandidApi.exports.v3.GetExportsRequest): Promise<core.APIResponse<CandidApi.exports.v3.GetExportsResponse, CandidApi.exports.v3.getExports.Error>>;
|
|
32
31
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
@@ -54,7 +54,6 @@ class V3 {
|
|
|
54
54
|
* available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the
|
|
55
55
|
* caller will receive a 422 response. If the file has already been generated, it will be served. Please email
|
|
56
56
|
* our [Support team](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.
|
|
57
|
-
*
|
|
58
57
|
*/
|
|
59
58
|
async getExports(request) {
|
|
60
59
|
const { startDate, endDate } = request;
|
|
@@ -68,7 +67,7 @@ class V3 {
|
|
|
68
67
|
Authorization: await this._getAuthorizationHeader(),
|
|
69
68
|
"X-Fern-Language": "JavaScript",
|
|
70
69
|
"X-Fern-SDK-Name": "candidhealth",
|
|
71
|
-
"X-Fern-SDK-Version": "0.
|
|
70
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
72
71
|
},
|
|
73
72
|
contentType: "application/json",
|
|
74
73
|
queryParameters: _queryParams,
|
|
@@ -5,13 +5,11 @@ export interface GetExportsRequest {
|
|
|
5
5
|
/**
|
|
6
6
|
* Beginning date of claim versions returned in the export, ISO 8601 date e.g. 2019-08-24.
|
|
7
7
|
* Must be at least 1 calendar day in the past. Cannot be earlier than 2022-10-07.
|
|
8
|
-
*
|
|
9
8
|
*/
|
|
10
9
|
startDate: string;
|
|
11
10
|
/**
|
|
12
11
|
* Ending date of claim versions returned in the export, ISO 8601 date; e.g. 2019-08-24.
|
|
13
12
|
* Must be within 30 days of start_date.
|
|
14
|
-
*
|
|
15
13
|
*/
|
|
16
14
|
endDate: string;
|
|
17
15
|
}
|
|
@@ -5,7 +5,6 @@ import * as CandidApi from "../../..";
|
|
|
5
5
|
/**
|
|
6
6
|
* Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has
|
|
7
7
|
* and amount, defined in cents, and a target.
|
|
8
|
-
*
|
|
9
8
|
*/
|
|
10
9
|
export interface AllocationCreate {
|
|
11
10
|
amountCents: number;
|
|
@@ -5,7 +5,6 @@ import * as CandidApi from "../../..";
|
|
|
5
5
|
/**
|
|
6
6
|
* Allocation targets describe whether the portion of a payment is being applied toward a specific service line,
|
|
7
7
|
* claim, billing provider, or is unallocated.
|
|
8
|
-
*
|
|
9
8
|
*/
|
|
10
9
|
export declare type AllocationTarget = CandidApi.AllocationTarget.ServiceLine | CandidApi.AllocationTarget.Claim | CandidApi.AllocationTarget.BillingProviderId | CandidApi.AllocationTarget.Unattributed;
|
|
11
10
|
export declare namespace AllocationTarget {
|
|
@@ -5,7 +5,6 @@ import * as CandidApi from "../../..";
|
|
|
5
5
|
/**
|
|
6
6
|
* Allocation targets describe whether the portion of a payment is being applied toward a specific service line,
|
|
7
7
|
* claim, billing provider, or is unallocated.
|
|
8
|
-
*
|
|
9
8
|
*/
|
|
10
9
|
export declare type AllocationTargetCreate = CandidApi.AllocationTargetCreate.ServiceLineById | CandidApi.AllocationTargetCreate.ClaimById | CandidApi.AllocationTargetCreate.BillingProviderById | CandidApi.AllocationTargetCreate.Unattributed;
|
|
11
10
|
export declare namespace AllocationTargetCreate {
|
|
@@ -15,17 +15,14 @@ export declare class V1 {
|
|
|
15
15
|
constructor(options: V1.Options);
|
|
16
16
|
/**
|
|
17
17
|
* Creates a new guarantor and returns the newly created Guarantor object.
|
|
18
|
-
*
|
|
19
18
|
*/
|
|
20
19
|
create(encounterId: CandidApi.EncounterId, request: CandidApi.guarantor.v1.GuarantorCreate): Promise<core.APIResponse<CandidApi.guarantor.v1.Guarantor, CandidApi.guarantor.v1.create.Error>>;
|
|
21
20
|
/**
|
|
22
21
|
* Retrieves a guarantor by its `guarantor_id`.
|
|
23
|
-
*
|
|
24
22
|
*/
|
|
25
23
|
get(guarantorId: CandidApi.guarantor.v1.GuarantorId): Promise<core.APIResponse<CandidApi.guarantor.v1.Guarantor, CandidApi.guarantor.v1.get.Error>>;
|
|
26
24
|
/**
|
|
27
25
|
* Updates a guarantor by its `guarantor_id`.
|
|
28
|
-
*
|
|
29
26
|
*/
|
|
30
27
|
update(guarantorId: CandidApi.guarantor.v1.GuarantorId, request?: CandidApi.guarantor.v1.GuarantorUpdate): Promise<core.APIResponse<CandidApi.guarantor.v1.Guarantor, CandidApi.guarantor.v1.update.Error>>;
|
|
31
28
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
@@ -42,7 +42,6 @@ class V1 {
|
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
44
|
* Creates a new guarantor and returns the newly created Guarantor object.
|
|
45
|
-
*
|
|
46
45
|
*/
|
|
47
46
|
async create(encounterId, request) {
|
|
48
47
|
const _response = await core.fetcher({
|
|
@@ -52,7 +51,7 @@ class V1 {
|
|
|
52
51
|
Authorization: await this._getAuthorizationHeader(),
|
|
53
52
|
"X-Fern-Language": "JavaScript",
|
|
54
53
|
"X-Fern-SDK-Name": "candidhealth",
|
|
55
|
-
"X-Fern-SDK-Version": "0.
|
|
54
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
56
55
|
},
|
|
57
56
|
contentType: "application/json",
|
|
58
57
|
body: await serializers.guarantor.v1.GuarantorCreate.jsonOrThrow(request, {
|
|
@@ -92,7 +91,6 @@ class V1 {
|
|
|
92
91
|
}
|
|
93
92
|
/**
|
|
94
93
|
* Retrieves a guarantor by its `guarantor_id`.
|
|
95
|
-
*
|
|
96
94
|
*/
|
|
97
95
|
async get(guarantorId) {
|
|
98
96
|
const _response = await core.fetcher({
|
|
@@ -102,7 +100,7 @@ class V1 {
|
|
|
102
100
|
Authorization: await this._getAuthorizationHeader(),
|
|
103
101
|
"X-Fern-Language": "JavaScript",
|
|
104
102
|
"X-Fern-SDK-Name": "candidhealth",
|
|
105
|
-
"X-Fern-SDK-Version": "0.
|
|
103
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
106
104
|
},
|
|
107
105
|
contentType: "application/json",
|
|
108
106
|
timeoutMs: 60000,
|
|
@@ -125,7 +123,6 @@ class V1 {
|
|
|
125
123
|
}
|
|
126
124
|
/**
|
|
127
125
|
* Updates a guarantor by its `guarantor_id`.
|
|
128
|
-
*
|
|
129
126
|
*/
|
|
130
127
|
async update(guarantorId, request = {}) {
|
|
131
128
|
const _response = await core.fetcher({
|
|
@@ -135,7 +132,7 @@ class V1 {
|
|
|
135
132
|
Authorization: await this._getAuthorizationHeader(),
|
|
136
133
|
"X-Fern-Language": "JavaScript",
|
|
137
134
|
"X-Fern-SDK-Name": "candidhealth",
|
|
138
|
-
"X-Fern-SDK-Version": "0.
|
|
135
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
139
136
|
},
|
|
140
137
|
contentType: "application/json",
|
|
141
138
|
body: await serializers.guarantor.v1.GuarantorUpdate.jsonOrThrow(request, {
|
|
@@ -3,11 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as CandidApi from "../../..";
|
|
5
5
|
export interface PatientBase extends CandidApi.IndividualBase {
|
|
6
|
-
/**
|
|
7
|
-
* Another ID you want to associate with this patient.
|
|
8
|
-
* For example, your internal patient ID or a Dr. Chrono patient ID. Box 1a on the CMS-1500 claim form
|
|
9
|
-
*
|
|
10
|
-
*/
|
|
6
|
+
/** The ID used to identify this individual in your system. For example, your internal patient ID or an EHR patient ID. */
|
|
11
7
|
externalId: string;
|
|
12
8
|
/** Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) */
|
|
13
9
|
dateOfBirth: CandidApi.Date_;
|
|
@@ -15,17 +15,14 @@ export declare class V1 {
|
|
|
15
15
|
constructor(options: V1.Options);
|
|
16
16
|
/**
|
|
17
17
|
* Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`.
|
|
18
|
-
*
|
|
19
18
|
*/
|
|
20
19
|
get(insuranceAdjudicationId: CandidApi.insuranceAdjudications.v1.InsuranceAdjudicationId): Promise<core.APIResponse<CandidApi.insuranceAdjudications.v1.InsuranceAdjudication, CandidApi.insuranceAdjudications.v1.get.Error>>;
|
|
21
20
|
/**
|
|
22
21
|
* Creates a new insurance adjudication record and returns the newly created InsuranceAdjudication object.
|
|
23
|
-
*
|
|
24
22
|
*/
|
|
25
23
|
create(request: CandidApi.insuranceAdjudications.v1.InsuranceAdjudicationCreate): Promise<core.APIResponse<CandidApi.insuranceAdjudications.v1.InsuranceAdjudication, CandidApi.insuranceAdjudications.v1.create.Error>>;
|
|
26
24
|
/**
|
|
27
25
|
* Deletes the insurance adjudication record matching the provided insurance_adjudication_id.
|
|
28
|
-
*
|
|
29
26
|
*/
|
|
30
27
|
delete(insuranceAdjudicationId: CandidApi.insuranceAdjudications.v1.InsuranceAdjudicationId): Promise<core.APIResponse<void, CandidApi.insuranceAdjudications.v1.delete.Error>>;
|
|
31
28
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
@@ -42,7 +42,6 @@ class V1 {
|
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
44
|
* Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`.
|
|
45
|
-
*
|
|
46
45
|
*/
|
|
47
46
|
async get(insuranceAdjudicationId) {
|
|
48
47
|
const _response = await core.fetcher({
|
|
@@ -52,7 +51,7 @@ class V1 {
|
|
|
52
51
|
Authorization: await this._getAuthorizationHeader(),
|
|
53
52
|
"X-Fern-Language": "JavaScript",
|
|
54
53
|
"X-Fern-SDK-Name": "candidhealth",
|
|
55
|
-
"X-Fern-SDK-Version": "0.
|
|
54
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
56
55
|
},
|
|
57
56
|
contentType: "application/json",
|
|
58
57
|
timeoutMs: 60000,
|
|
@@ -75,7 +74,6 @@ class V1 {
|
|
|
75
74
|
}
|
|
76
75
|
/**
|
|
77
76
|
* Creates a new insurance adjudication record and returns the newly created InsuranceAdjudication object.
|
|
78
|
-
*
|
|
79
77
|
*/
|
|
80
78
|
async create(request) {
|
|
81
79
|
const _response = await core.fetcher({
|
|
@@ -85,7 +83,7 @@ class V1 {
|
|
|
85
83
|
Authorization: await this._getAuthorizationHeader(),
|
|
86
84
|
"X-Fern-Language": "JavaScript",
|
|
87
85
|
"X-Fern-SDK-Name": "candidhealth",
|
|
88
|
-
"X-Fern-SDK-Version": "0.
|
|
86
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
89
87
|
},
|
|
90
88
|
contentType: "application/json",
|
|
91
89
|
body: await serializers.insuranceAdjudications.v1.InsuranceAdjudicationCreate.jsonOrThrow(request, {
|
|
@@ -125,7 +123,6 @@ class V1 {
|
|
|
125
123
|
}
|
|
126
124
|
/**
|
|
127
125
|
* Deletes the insurance adjudication record matching the provided insurance_adjudication_id.
|
|
128
|
-
*
|
|
129
126
|
*/
|
|
130
127
|
async delete(insuranceAdjudicationId) {
|
|
131
128
|
const _response = await core.fetcher({
|
|
@@ -135,7 +132,7 @@ class V1 {
|
|
|
135
132
|
Authorization: await this._getAuthorizationHeader(),
|
|
136
133
|
"X-Fern-Language": "JavaScript",
|
|
137
134
|
"X-Fern-SDK-Name": "candidhealth",
|
|
138
|
-
"X-Fern-SDK-Version": "0.
|
|
135
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
139
136
|
},
|
|
140
137
|
contentType: "application/json",
|
|
141
138
|
timeoutMs: 60000,
|
|
@@ -15,33 +15,28 @@ export declare class V1 {
|
|
|
15
15
|
constructor(options: V1.Options);
|
|
16
16
|
/**
|
|
17
17
|
* Returns all non-ERA originated insurance payments satisfying the search criteria
|
|
18
|
-
*
|
|
19
18
|
*/
|
|
20
19
|
getMulti(request?: CandidApi.insurancePayments.v1.GetMultiInsurancePaymentRequest): Promise<core.APIResponse<CandidApi.insurancePayments.v1.InsurancePaymentsPage, CandidApi.insurancePayments.v1.getMulti.Error>>;
|
|
21
20
|
/**
|
|
22
21
|
* Retrieves a previously created insurance payment by its `insurance_payment_id`.
|
|
23
22
|
* If the payment does not exist, a `403` will be thrown.
|
|
24
|
-
*
|
|
25
23
|
*/
|
|
26
24
|
get(insurancePaymentId: CandidApi.insurancePayments.v1.InsurancePaymentId): Promise<core.APIResponse<CandidApi.insurancePayments.v1.InsurancePayment, CandidApi.insurancePayments.v1.get.Error>>;
|
|
27
25
|
/**
|
|
28
26
|
* Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
|
|
29
27
|
* should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
|
|
30
28
|
* from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
|
|
31
|
-
*
|
|
32
29
|
*/
|
|
33
30
|
create(request: CandidApi.insurancePayments.v1.InsurancePaymentCreate): Promise<core.APIResponse<CandidApi.insurancePayments.v1.InsurancePayment, CandidApi.insurancePayments.v1.create.Error>>;
|
|
34
31
|
/**
|
|
35
32
|
* Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
|
|
36
33
|
* then the allocations must be appropriately updated as well.
|
|
37
|
-
*
|
|
38
34
|
*/
|
|
39
35
|
update(insurancePaymentId: CandidApi.insurancePayments.v1.InsurancePaymentId, request?: CandidApi.insurancePayments.v1.InsurancePaymentUpdate): Promise<core.APIResponse<CandidApi.insurancePayments.v1.InsurancePayment, CandidApi.insurancePayments.v1.update.Error>>;
|
|
40
36
|
/**
|
|
41
37
|
* Deletes the insurance payment record matching the provided `insurance_payment_id`.
|
|
42
38
|
* If the matching record's organization_id does not match the authenticated user's
|
|
43
39
|
* current organization_id, then a response code of `403` will be returned.
|
|
44
|
-
*
|
|
45
40
|
*/
|
|
46
41
|
delete(insurancePaymentId: CandidApi.insurancePayments.v1.InsurancePaymentId): Promise<core.APIResponse<void, CandidApi.insurancePayments.v1.delete.Error>>;
|
|
47
42
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|