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
|
@@ -10,24 +10,14 @@ export interface ContractBase {
|
|
|
10
10
|
/**
|
|
11
11
|
* The state(s) to which the contract's coverage extends.
|
|
12
12
|
* It may also be set to "national" for the entirety of the US.
|
|
13
|
-
*
|
|
14
13
|
*/
|
|
15
14
|
regions: CandidApi.Regions;
|
|
16
15
|
contractStatus?: CandidApi.contracts.v2.ContractStatus;
|
|
17
16
|
authorizedSignatory?: CandidApi.contracts.v2.AuthorizedSignatory;
|
|
18
|
-
/**
|
|
19
|
-
* The commercial plan insurance types this contract applies.
|
|
20
|
-
*
|
|
21
|
-
*/
|
|
17
|
+
/** The commercial plan insurance types this contract applies. */
|
|
22
18
|
commercialInsuranceTypes: CandidApi.contracts.v2.InsuranceTypes;
|
|
23
|
-
/**
|
|
24
|
-
* The Medicare plan insurance types this contract applies.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
19
|
+
/** The Medicare plan insurance types this contract applies. */
|
|
27
20
|
medicareInsuranceTypes: CandidApi.contracts.v2.InsuranceTypes;
|
|
28
|
-
/**
|
|
29
|
-
* The Medicaid plan insurance types this contract applies.
|
|
30
|
-
*
|
|
31
|
-
*/
|
|
21
|
+
/** The Medicaid plan insurance types this contract applies. */
|
|
32
22
|
medicaidInsuranceTypes: CandidApi.contracts.v2.InsuranceTypes;
|
|
33
23
|
}
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export declare type ContractStatus =
|
|
5
5
|
/**
|
|
6
|
-
* Contract is still in the works and has not been signed and counter-signed yet
|
|
7
|
-
* */
|
|
6
|
+
* Contract is still in the works and has not been signed and counter-signed yet */
|
|
8
7
|
"pending"
|
|
9
8
|
/**
|
|
10
9
|
* Contract is active and in effect (claims will need to
|
|
11
|
-
* be submitted under effective contracts)
|
|
12
|
-
* */
|
|
10
|
+
* be submitted under effective contracts) */
|
|
13
11
|
| "effective"
|
|
14
12
|
/**
|
|
15
|
-
* Contract is no longer effective but kept around for historical documentation
|
|
16
|
-
* */
|
|
13
|
+
* Contract is no longer effective but kept around for historical documentation */
|
|
17
14
|
| "cancelled";
|
|
18
15
|
export declare const ContractStatus: {
|
|
19
16
|
readonly Pending: "pending";
|
|
@@ -5,21 +5,18 @@ import * as CandidApi from "../../..";
|
|
|
5
5
|
export interface DiagnosisCreate {
|
|
6
6
|
/** Empty string not allowed. */
|
|
7
7
|
name?: string;
|
|
8
|
-
/**
|
|
9
|
-
* Typically, providers submitting claims to Candid are using ICD-10 diagnosis codes. If you are using ICD-10 codes, the primary diagnosis code listed on the claim should use the ABK code_type. If more than one diagnosis is being submitted on a claim, please use ABF for the rest of the listed diagnoses. If you are using ICD-9 diagnosis codes, use BK and BF for the principal and following diagnosis code(s) respectively.
|
|
10
|
-
*
|
|
11
|
-
*/
|
|
8
|
+
/** Typically, providers submitting claims to Candid are using ICD-10 diagnosis codes. If you are using ICD-10 codes, the primary diagnosis code listed on the claim should use the ABK code_type. If more than one diagnosis is being submitted on a claim, please use ABF for the rest of the listed diagnoses. If you are using ICD-9 diagnosis codes, use BK and BF for the principal and following diagnosis code(s) respectively. */
|
|
12
9
|
codeType: CandidApi.DiagnosisTypeCode;
|
|
13
10
|
/**
|
|
14
11
|
* Empty string not allowed.
|
|
15
12
|
* Should be of the appropriate format for the provided `code_type`.
|
|
16
13
|
* Must obey the ICD-10 format if an ICD-10 code_type is provided, specifically:
|
|
17
|
-
* - Letter
|
|
18
|
-
* - Digit
|
|
19
|
-
* - Digit or the letter `A` or `B`
|
|
20
|
-
* - (Optional) Period `.`
|
|
21
|
-
* - Up to 4 (or as few as 0) letters and digits
|
|
22
14
|
*
|
|
15
|
+
* - Letter
|
|
16
|
+
* - Digit
|
|
17
|
+
* - Digit or the letter `A` or `B`
|
|
18
|
+
* - (Optional) Period `.`
|
|
19
|
+
* - Up to 4 (or as few as 0) letters and digits
|
|
23
20
|
*/
|
|
24
21
|
code: string;
|
|
25
22
|
}
|
|
@@ -28,8 +28,20 @@ export declare class V2 {
|
|
|
28
28
|
* - [Change Healthcare - Guides: Using Test Payers in the Sandbox](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
|
|
29
29
|
*
|
|
30
30
|
* A schema of the response object can be found here: [Change Healthcare Docs](https://developers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)
|
|
31
|
-
*
|
|
32
31
|
*/
|
|
33
32
|
submitEligibilityCheck(request?: unknown): Promise<core.APIResponse<unknown, CandidApi.eligibility.v2.submitEligibilityCheck.Error>>;
|
|
33
|
+
/**
|
|
34
|
+
* If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint
|
|
35
|
+
*
|
|
36
|
+
* This API is a wrapper around Availity's coverages API. Below are some helpful documentation links:
|
|
37
|
+
*
|
|
38
|
+
* - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references)
|
|
39
|
+
* - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide)
|
|
40
|
+
*
|
|
41
|
+
* A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages/get)
|
|
42
|
+
*
|
|
43
|
+
* - Note Availity requires a free developer account to access this documentation.
|
|
44
|
+
*/
|
|
45
|
+
submitEligibilityCheckAvaility(): Promise<core.APIResponse<unknown, CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error>>;
|
|
34
46
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
35
47
|
}
|
|
@@ -55,7 +55,6 @@ class V2 {
|
|
|
55
55
|
* - [Change Healthcare - Guides: Using Test Payers in the Sandbox](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
|
|
56
56
|
*
|
|
57
57
|
* A schema of the response object can be found here: [Change Healthcare Docs](https://developers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)
|
|
58
|
-
*
|
|
59
58
|
*/
|
|
60
59
|
async submitEligibilityCheck(request) {
|
|
61
60
|
const _response = await core.fetcher({
|
|
@@ -65,7 +64,7 @@ class V2 {
|
|
|
65
64
|
Authorization: await this._getAuthorizationHeader(),
|
|
66
65
|
"X-Fern-Language": "JavaScript",
|
|
67
66
|
"X-Fern-SDK-Name": "candidhealth",
|
|
68
|
-
"X-Fern-SDK-Version": "0.
|
|
67
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
69
68
|
},
|
|
70
69
|
contentType: "application/json",
|
|
71
70
|
body: request,
|
|
@@ -96,6 +95,42 @@ class V2 {
|
|
|
96
95
|
error: CandidApi.eligibility.v2.submitEligibilityCheck.Error._unknown(_response.error),
|
|
97
96
|
};
|
|
98
97
|
}
|
|
98
|
+
/**
|
|
99
|
+
* If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint
|
|
100
|
+
*
|
|
101
|
+
* This API is a wrapper around Availity's coverages API. Below are some helpful documentation links:
|
|
102
|
+
*
|
|
103
|
+
* - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references)
|
|
104
|
+
* - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide)
|
|
105
|
+
*
|
|
106
|
+
* A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages/get)
|
|
107
|
+
*
|
|
108
|
+
* - Note Availity requires a free developer account to access this documentation.
|
|
109
|
+
*/
|
|
110
|
+
async submitEligibilityCheckAvaility() {
|
|
111
|
+
const _response = await core.fetcher({
|
|
112
|
+
url: (0, url_join_1.default)(this.options.environment ?? environments.CandidApiEnvironment.Production, "/api/eligibility/v2/availity"),
|
|
113
|
+
method: "GET",
|
|
114
|
+
headers: {
|
|
115
|
+
Authorization: await this._getAuthorizationHeader(),
|
|
116
|
+
"X-Fern-Language": "JavaScript",
|
|
117
|
+
"X-Fern-SDK-Name": "candidhealth",
|
|
118
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
119
|
+
},
|
|
120
|
+
contentType: "application/json",
|
|
121
|
+
timeoutMs: 60000,
|
|
122
|
+
});
|
|
123
|
+
if (_response.ok) {
|
|
124
|
+
return {
|
|
125
|
+
ok: true,
|
|
126
|
+
body: _response.body,
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
return {
|
|
130
|
+
ok: false,
|
|
131
|
+
error: CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._unknown(_response.error),
|
|
132
|
+
};
|
|
133
|
+
}
|
|
99
134
|
async _getAuthorizationHeader() {
|
|
100
135
|
const bearer = await core.Supplier.get(this.options.token);
|
|
101
136
|
if (bearer != null) {
|
|
@@ -23,5 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
23
23
|
return result;
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.submitEligibilityCheck = void 0;
|
|
26
|
+
exports.submitEligibilityCheckAvaility = exports.submitEligibilityCheck = void 0;
|
|
27
27
|
exports.submitEligibilityCheck = __importStar(require("./submitEligibilityCheck"));
|
|
28
|
+
exports.submitEligibilityCheckAvaility = __importStar(require("./submitEligibilityCheckAvaility"));
|
package/dist/api/resources/eligibility/resources/v2/client/submitEligibilityCheckAvaility.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as CandidApi from "../../../../..";
|
|
5
|
+
import * as core from "../../../../../../core";
|
|
6
|
+
export declare type Error = CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._Unknown;
|
|
7
|
+
export declare namespace Error {
|
|
8
|
+
interface _Unknown extends _Utils {
|
|
9
|
+
errorName: void;
|
|
10
|
+
content: core.Fetcher.Error;
|
|
11
|
+
}
|
|
12
|
+
interface _Utils {
|
|
13
|
+
_visit: <_Result>(visitor: CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._Visitor<_Result>) => _Result;
|
|
14
|
+
}
|
|
15
|
+
interface _Visitor<_Result> {
|
|
16
|
+
_other: (value: core.Fetcher.Error) => _Result;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
export declare const Error: {
|
|
20
|
+
readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._Unknown;
|
|
21
|
+
readonly _visit: <_Result>(value: CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error, visitor: CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._Visitor<_Result>) => _Result;
|
|
22
|
+
};
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
+
if (mod && mod.__esModule) return mod;
|
|
23
|
+
var result = {};
|
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
+
__setModuleDefault(result, mod);
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.Error = void 0;
|
|
30
|
+
const CandidApi = __importStar(require("../../../../.."));
|
|
31
|
+
exports.Error = {
|
|
32
|
+
_unknown: (fetcherError) => {
|
|
33
|
+
return {
|
|
34
|
+
errorName: undefined,
|
|
35
|
+
content: fetcherError,
|
|
36
|
+
_visit: function (visitor) {
|
|
37
|
+
return CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error._visit(this, visitor);
|
|
38
|
+
},
|
|
39
|
+
};
|
|
40
|
+
},
|
|
41
|
+
_visit: (value, visitor) => {
|
|
42
|
+
switch (value.errorName) {
|
|
43
|
+
default:
|
|
44
|
+
return visitor._other(value);
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
};
|
|
@@ -11,14 +11,10 @@ import * as CandidApi from "../../../../..";
|
|
|
11
11
|
* tax ID (TIN) that the provider gave to the payer during contracting.
|
|
12
12
|
* In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID.
|
|
13
13
|
* Box 33 on the CMS-1500 claim form.
|
|
14
|
-
*
|
|
15
14
|
*/
|
|
16
15
|
export interface BillingProvider extends CandidApi.encounterProviders.v2.EncounterProviderBase {
|
|
17
16
|
address: CandidApi.StreetAddressLongZip;
|
|
18
|
-
/**
|
|
19
|
-
* If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting.
|
|
20
|
-
*
|
|
21
|
-
*/
|
|
17
|
+
/** If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. */
|
|
22
18
|
taxId: string;
|
|
23
19
|
npi: string;
|
|
24
20
|
taxonomyCode?: string;
|
|
@@ -2,19 +2,10 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface EncounterProviderBase {
|
|
5
|
-
/**
|
|
6
|
-
* If the provider is an individual, this should be set instead of organization name
|
|
7
|
-
*
|
|
8
|
-
*/
|
|
5
|
+
/** If the provider is an individual, this should be set instead of organization name */
|
|
9
6
|
firstName?: string;
|
|
10
|
-
/**
|
|
11
|
-
* If the provider is an individual, this should be set instead of organization name
|
|
12
|
-
*
|
|
13
|
-
*/
|
|
7
|
+
/** If the provider is an individual, this should be set instead of organization name */
|
|
14
8
|
lastName?: string;
|
|
15
|
-
/**
|
|
16
|
-
* If the provider is an organization, this should be set instead of first + last name
|
|
17
|
-
*
|
|
18
|
-
*/
|
|
9
|
+
/** If the provider is an organization, this should be set instead of first + last name */
|
|
19
10
|
organizationName?: string;
|
|
20
11
|
}
|
|
@@ -6,7 +6,6 @@ export interface ReferringProvider extends CandidApi.encounterProviders.v2.Encou
|
|
|
6
6
|
/**
|
|
7
7
|
* A National Provider Identifier is a unique 10-digit identification
|
|
8
8
|
* number issued to health care providers in the United States
|
|
9
|
-
*
|
|
10
9
|
*/
|
|
11
10
|
npi: string;
|
|
12
11
|
taxonomyCode?: string;
|
|
@@ -7,7 +7,6 @@ export interface RenderingProvider extends CandidApi.encounterProviders.v2.Encou
|
|
|
7
7
|
/**
|
|
8
8
|
* A National Provider Identifier is a unique 10-digit identification
|
|
9
9
|
* number issued to health care providers in the United States
|
|
10
|
-
*
|
|
11
10
|
*/
|
|
12
11
|
npi: string;
|
|
13
12
|
taxonomyCode?: string;
|
|
@@ -103,7 +103,7 @@ class V4 {
|
|
|
103
103
|
Authorization: await this._getAuthorizationHeader(),
|
|
104
104
|
"X-Fern-Language": "JavaScript",
|
|
105
105
|
"X-Fern-SDK-Name": "candidhealth",
|
|
106
|
-
"X-Fern-SDK-Version": "0.
|
|
106
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
107
107
|
},
|
|
108
108
|
contentType: "application/json",
|
|
109
109
|
queryParameters: _queryParams,
|
|
@@ -133,7 +133,7 @@ class V4 {
|
|
|
133
133
|
Authorization: await this._getAuthorizationHeader(),
|
|
134
134
|
"X-Fern-Language": "JavaScript",
|
|
135
135
|
"X-Fern-SDK-Name": "candidhealth",
|
|
136
|
-
"X-Fern-SDK-Version": "0.
|
|
136
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
137
137
|
},
|
|
138
138
|
contentType: "application/json",
|
|
139
139
|
timeoutMs: 60000,
|
|
@@ -162,7 +162,7 @@ class V4 {
|
|
|
162
162
|
Authorization: await this._getAuthorizationHeader(),
|
|
163
163
|
"X-Fern-Language": "JavaScript",
|
|
164
164
|
"X-Fern-SDK-Name": "candidhealth",
|
|
165
|
-
"X-Fern-SDK-Version": "0.
|
|
165
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
166
166
|
},
|
|
167
167
|
contentType: "application/json",
|
|
168
168
|
body: await serializers.encounters.v4.EncounterCreate.jsonOrThrow(request, {
|
|
@@ -213,7 +213,7 @@ class V4 {
|
|
|
213
213
|
Authorization: await this._getAuthorizationHeader(),
|
|
214
214
|
"X-Fern-Language": "JavaScript",
|
|
215
215
|
"X-Fern-SDK-Name": "candidhealth",
|
|
216
|
-
"X-Fern-SDK-Version": "0.
|
|
216
|
+
"X-Fern-SDK-Version": "0.17.1",
|
|
217
217
|
},
|
|
218
218
|
contentType: "application/json",
|
|
219
219
|
body: await serializers.encounters.v4.EncounterUpdate.jsonOrThrow(request, {
|
|
@@ -122,4 +122,10 @@ export interface EncounterUpdate {
|
|
|
122
122
|
*
|
|
123
123
|
*/
|
|
124
124
|
lastMenstrualPeriodDate?: CandidApi.Date_;
|
|
125
|
+
/**
|
|
126
|
+
* 837i Loop2300, CLM-1300 Box 20
|
|
127
|
+
* Code indicating the reason why a request was delayed
|
|
128
|
+
*
|
|
129
|
+
*/
|
|
130
|
+
delayReasonCode?: CandidApi.DelayReasonCode;
|
|
125
131
|
}
|
package/dist/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts
CHANGED
|
@@ -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;
|
package/dist/api/resources/encounters/resources/v4/types/ServiceAuthorizationExceptionCode.d.ts
CHANGED
|
@@ -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>;
|