candidhealth 0.6.2 → 0.6.3

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.
Files changed (73) hide show
  1. package/api/resources/auth/resources/v2/client/Client.js +1 -1
  2. package/api/resources/auth/resources/v2/types/AuthGetTokenRequest.d.ts +2 -0
  3. package/api/resources/auth/resources/v2/types/AuthGetTokenResponse.d.ts +1 -0
  4. package/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  5. package/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +5 -0
  6. package/api/resources/commons/types/FacilityTypeCode.d.ts +151 -1
  7. package/api/resources/commons/types/PatientRelationshipToInsuredCodeAll.d.ts +73 -1
  8. package/api/resources/commons/types/State.d.ts +8 -1
  9. package/api/resources/commons/types/State.js +7 -0
  10. package/api/resources/eligibility/resources/v2/client/Client.js +1 -1
  11. package/api/resources/encounters/resources/v4/client/Client.js +4 -4
  12. package/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +25 -3
  13. package/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +39 -0
  14. package/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts +30 -5
  15. package/api/resources/encounters/resources/v4/types/Encounter.d.ts +41 -1
  16. package/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +2 -1
  17. package/api/resources/encounters/resources/v4/types/Intervention.d.ts +2 -2
  18. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  19. package/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +9 -0
  20. package/api/resources/expectedNetworkStatus/resources/v1/types/ExpectedNetworkStatusResponse.d.ts +1 -0
  21. package/api/resources/exports/resources/v3/client/Client.d.ts +1 -1
  22. package/api/resources/exports/resources/v3/client/Client.js +2 -2
  23. package/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  24. package/api/resources/guarantor/resources/v1/client/requests/GuarantorUpdate.d.ts +5 -0
  25. package/api/resources/organizationProviders/resources/v2/types/LicenseType.d.ts +35 -1
  26. package/api/resources/organizationProviders/resources/v2/types/LicenseType.js +34 -0
  27. package/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  28. package/api/resources/organizationProviders/resources/v3/client/requests/GetAllOrganizationProvidersRequestV2.d.ts +6 -6
  29. package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +2 -2
  30. package/api/resources/payers/resources/v3/client/Client.js +2 -2
  31. package/api/resources/payers/resources/v3/client/requests/GetAllPayersRequest.d.ts +1 -1
  32. package/api/resources/payers/resources/v3/types/Payer.d.ts +3 -3
  33. package/dist/api/resources/auth/resources/v2/client/Client.js +1 -1
  34. package/dist/api/resources/auth/resources/v2/types/AuthGetTokenRequest.d.ts +2 -0
  35. package/dist/api/resources/auth/resources/v2/types/AuthGetTokenResponse.d.ts +1 -0
  36. package/dist/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  37. package/dist/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +5 -0
  38. package/dist/api/resources/commons/types/FacilityTypeCode.d.ts +151 -1
  39. package/dist/api/resources/commons/types/PatientRelationshipToInsuredCodeAll.d.ts +73 -1
  40. package/dist/api/resources/commons/types/State.d.ts +8 -1
  41. package/dist/api/resources/commons/types/State.js +7 -0
  42. package/dist/api/resources/eligibility/resources/v2/client/Client.js +1 -1
  43. package/dist/api/resources/encounters/resources/v4/client/Client.js +4 -4
  44. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +25 -3
  45. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +39 -0
  46. package/dist/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts +30 -5
  47. package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts +41 -1
  48. package/dist/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +2 -1
  49. package/dist/api/resources/encounters/resources/v4/types/Intervention.d.ts +2 -2
  50. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  51. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +9 -0
  52. package/dist/api/resources/expectedNetworkStatus/resources/v1/types/ExpectedNetworkStatusResponse.d.ts +1 -0
  53. package/dist/api/resources/exports/resources/v3/client/Client.d.ts +1 -1
  54. package/dist/api/resources/exports/resources/v3/client/Client.js +2 -2
  55. package/dist/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  56. package/dist/api/resources/guarantor/resources/v1/client/requests/GuarantorUpdate.d.ts +5 -0
  57. package/dist/api/resources/organizationProviders/resources/v2/types/LicenseType.d.ts +35 -1
  58. package/dist/api/resources/organizationProviders/resources/v2/types/LicenseType.js +34 -0
  59. package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  60. package/dist/api/resources/organizationProviders/resources/v3/client/requests/GetAllOrganizationProvidersRequestV2.d.ts +6 -6
  61. package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +2 -2
  62. package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
  63. package/dist/api/resources/payers/resources/v3/client/requests/GetAllPayersRequest.d.ts +1 -1
  64. package/dist/api/resources/payers/resources/v3/types/Payer.d.ts +3 -3
  65. package/dist/serialization/resources/commons/types/State.d.ts +1 -1
  66. package/dist/serialization/resources/commons/types/State.js +7 -0
  67. package/dist/serialization/resources/organizationProviders/resources/v2/types/LicenseType.d.ts +1 -1
  68. package/dist/serialization/resources/organizationProviders/resources/v2/types/LicenseType.js +34 -0
  69. package/package.json +1 -1
  70. package/serialization/resources/commons/types/State.d.ts +1 -1
  71. package/serialization/resources/commons/types/State.js +7 -0
  72. package/serialization/resources/organizationProviders/resources/v2/types/LicenseType.d.ts +1 -1
  73. package/serialization/resources/organizationProviders/resources/v2/types/LicenseType.js +34 -0
@@ -1,7 +1,79 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type PatientRelationshipToInsuredCodeAll = "01" | "04" | "05" | "07" | "10" | "15" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "29" | "32" | "33" | "36" | "39" | "40" | "41" | "43" | "53" | "G8";
4
+ export declare type PatientRelationshipToInsuredCodeAll =
5
+ /**
6
+ * Spouse */
7
+ "01"
8
+ /**
9
+ * Grandparent */
10
+ | "04"
11
+ /**
12
+ * Grandchild */
13
+ | "05"
14
+ /**
15
+ * Niece/Nephew */
16
+ | "07"
17
+ /**
18
+ * Foster Child */
19
+ | "10"
20
+ /**
21
+ * Ward of the Court */
22
+ | "15"
23
+ /**
24
+ * Stepchild */
25
+ | "17"
26
+ /**
27
+ * Self */
28
+ | "18"
29
+ /**
30
+ * Child */
31
+ | "19"
32
+ /**
33
+ * Employee */
34
+ | "20"
35
+ /**
36
+ * Unknown */
37
+ | "21"
38
+ /**
39
+ * Handicapped Dependent */
40
+ | "22"
41
+ /**
42
+ * Sponsored Dependent */
43
+ | "23"
44
+ /**
45
+ * Dependent of Minor Dependent */
46
+ | "24"
47
+ /**
48
+ * Significant Other */
49
+ | "29"
50
+ /**
51
+ * Mother */
52
+ | "32"
53
+ /**
54
+ * Father */
55
+ | "33"
56
+ /**
57
+ * Emancipated Minor */
58
+ | "36"
59
+ /**
60
+ * Organ Donor */
61
+ | "39"
62
+ /**
63
+ * Cadaver Donor */
64
+ | "40"
65
+ /**
66
+ * Injured Plaintiff */
67
+ | "41"
68
+ /**
69
+ * Child (No Financial Responsibility) */
70
+ | "43"
71
+ /**
72
+ * Life Partner */
73
+ | "53"
74
+ /**
75
+ * Other Relationship */
76
+ | "G8";
5
77
  export declare const PatientRelationshipToInsuredCodeAll: {
6
78
  readonly Spouse: "01";
7
79
  readonly Grandparent: "04";
@@ -1,13 +1,14 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type State = "AA" | "AE" | "AP" | "AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY";
4
+ export declare type State = "AA" | "AE" | "AP" | "AL" | "AK" | "AS" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "FM" | "GA" | "GU" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MH" | "MI" | "MN" | "MP" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "PR" | "PW" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VI" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY";
5
5
  export declare const State: {
6
6
  readonly Aa: "AA";
7
7
  readonly Ae: "AE";
8
8
  readonly Ap: "AP";
9
9
  readonly Al: "AL";
10
10
  readonly Ak: "AK";
11
+ readonly As: "AS";
11
12
  readonly Az: "AZ";
12
13
  readonly Ar: "AR";
13
14
  readonly Ca: "CA";
@@ -16,7 +17,9 @@ export declare const State: {
16
17
  readonly Dc: "DC";
17
18
  readonly De: "DE";
18
19
  readonly Fl: "FL";
20
+ readonly Fm: "FM";
19
21
  readonly Ga: "GA";
22
+ readonly Gu: "GU";
20
23
  readonly Hi: "HI";
21
24
  readonly Id: "ID";
22
25
  readonly Il: "IL";
@@ -28,8 +31,10 @@ export declare const State: {
28
31
  readonly Me: "ME";
29
32
  readonly Md: "MD";
30
33
  readonly Ma: "MA";
34
+ readonly Mh: "MH";
31
35
  readonly Mi: "MI";
32
36
  readonly Mn: "MN";
37
+ readonly Mp: "MP";
33
38
  readonly Ms: "MS";
34
39
  readonly Mo: "MO";
35
40
  readonly Mt: "MT";
@@ -46,12 +51,14 @@ export declare const State: {
46
51
  readonly Or: "OR";
47
52
  readonly Pa: "PA";
48
53
  readonly Pr: "PR";
54
+ readonly Pw: "PW";
49
55
  readonly Ri: "RI";
50
56
  readonly Sc: "SC";
51
57
  readonly Sd: "SD";
52
58
  readonly Tn: "TN";
53
59
  readonly Tx: "TX";
54
60
  readonly Ut: "UT";
61
+ readonly Vi: "VI";
55
62
  readonly Vt: "VT";
56
63
  readonly Va: "VA";
57
64
  readonly Wa: "WA";
@@ -10,6 +10,7 @@ exports.State = {
10
10
  Ap: "AP",
11
11
  Al: "AL",
12
12
  Ak: "AK",
13
+ As: "AS",
13
14
  Az: "AZ",
14
15
  Ar: "AR",
15
16
  Ca: "CA",
@@ -18,7 +19,9 @@ exports.State = {
18
19
  Dc: "DC",
19
20
  De: "DE",
20
21
  Fl: "FL",
22
+ Fm: "FM",
21
23
  Ga: "GA",
24
+ Gu: "GU",
22
25
  Hi: "HI",
23
26
  Id: "ID",
24
27
  Il: "IL",
@@ -30,8 +33,10 @@ exports.State = {
30
33
  Me: "ME",
31
34
  Md: "MD",
32
35
  Ma: "MA",
36
+ Mh: "MH",
33
37
  Mi: "MI",
34
38
  Mn: "MN",
39
+ Mp: "MP",
35
40
  Ms: "MS",
36
41
  Mo: "MO",
37
42
  Mt: "MT",
@@ -48,12 +53,14 @@ exports.State = {
48
53
  Or: "OR",
49
54
  Pa: "PA",
50
55
  Pr: "PR",
56
+ Pw: "PW",
51
57
  Ri: "RI",
52
58
  Sc: "SC",
53
59
  Sd: "SD",
54
60
  Tn: "TN",
55
61
  Tx: "TX",
56
62
  Ut: "UT",
63
+ Vi: "VI",
57
64
  Vt: "VT",
58
65
  Va: "VA",
59
66
  Wa: "WA",
@@ -65,7 +65,7 @@ class V2 {
65
65
  Authorization: await this._getAuthorizationHeader(),
66
66
  "X-Fern-Language": "JavaScript",
67
67
  "X-Fern-SDK-Name": "candidhealth",
68
- "X-Fern-SDK-Version": "0.6.2",
68
+ "X-Fern-SDK-Version": "0.6.3",
69
69
  },
70
70
  contentType: "application/json",
71
71
  body: request,
@@ -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.6.2",
106
+ "X-Fern-SDK-Version": "0.6.3",
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.6.2",
136
+ "X-Fern-SDK-Version": "0.6.3",
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.6.2",
165
+ "X-Fern-SDK-Version": "0.6.3",
166
166
  },
167
167
  contentType: "application/json",
168
168
  body: await serializers.encounters.v4.EncounterCreate.jsonOrThrow(request, {
@@ -212,7 +212,7 @@ class V4 {
212
212
  Authorization: await this._getAuthorizationHeader(),
213
213
  "X-Fern-Language": "JavaScript",
214
214
  "X-Fern-SDK-Name": "candidhealth",
215
- "X-Fern-SDK-Version": "0.6.2",
215
+ "X-Fern-SDK-Version": "0.6.3",
216
216
  },
217
217
  contentType: "application/json",
218
218
  body: await serializers.encounters.v4.EncounterUpdate.jsonOrThrow(request, {
@@ -3,8 +3,21 @@
3
3
  */
4
4
  import * as CandidApi from "../../../../../..";
5
5
  export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
6
+ /**
7
+ * Contains the identification information of the individual receiving medical services.
8
+ *
9
+ */
6
10
  patient: CandidApi.PatientCreate;
11
+ /**
12
+ * 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.
13
+ *
14
+ */
7
15
  billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
16
+ /**
17
+ * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
18
+ * 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.
19
+ *
20
+ */
8
21
  renderingProvider: CandidApi.encounterProviders.v2.RenderingProvider;
9
22
  /**
10
23
  * The provider who referred the services that were rendered.
@@ -15,17 +28,21 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
15
28
  *
16
29
  */
17
30
  referringProvider?: CandidApi.encounterProviders.v2.ReferringProvider;
31
+ /**
32
+ * 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.
33
+ *
34
+ */
18
35
  serviceFacility?: CandidApi.EncounterServiceFacilityBase;
19
36
  /**
20
37
  * Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
21
38
  * These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
22
39
  * However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
23
- * Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims
40
+ * Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
24
41
  *
25
42
  */
26
43
  subscriberPrimary?: CandidApi.SubscriberCreate;
27
44
  /**
28
- * Please always include this when you have it, even for self-pay claims
45
+ * Please always include this when you have it, even for self-pay claims.
29
46
  *
30
47
  */
31
48
  subscriberSecondary?: CandidApi.SubscriberCreate;
@@ -36,6 +53,7 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
36
53
  *
37
54
  */
38
55
  diagnoses: CandidApi.DiagnosisCreate[];
56
+ /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
39
57
  clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
40
58
  /**
41
59
  * Spot to store misc, human-readable, notes about this encounter to be used
@@ -43,12 +61,16 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
43
61
  *
44
62
  */
45
63
  billingNotes?: CandidApi.billingNotes.v2.BillingNoteBase[];
64
+ /**
65
+ * 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).
66
+ *
67
+ */
46
68
  placeOfServiceCode: CandidApi.FacilityTypeCode;
47
69
  patientHistories?: CandidApi.encounters.v4.PatientHistoryCategory[];
48
70
  /**
49
71
  * Each service line must be linked to a diagnosis. Concretely,
50
72
  * `service_line.diagnosis_pointers`must contain at least one entry which should be
51
- * in bounds of the diagnoses list field
73
+ * in bounds of the diagnoses list field.
52
74
  *
53
75
  */
54
76
  serviceLines?: CandidApi.serviceLines.v2.ServiceLineCreate[];
@@ -27,16 +27,55 @@ export interface EncounterUpdate {
27
27
  *
28
28
  */
29
29
  diagnosisIds?: CandidApi.DiagnosisId[];
30
+ /** Names of tags that should be on the encounter. */
30
31
  tagIds?: CandidApi.TagId[];
32
+ /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
31
33
  clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
34
+ /** Specifies the address to which payments for the claim should be sent. */
32
35
  payToAddress?: CandidApi.StreetAddressLongZip;
36
+ /**
37
+ * 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.
38
+ *
39
+ */
33
40
  billableStatus?: CandidApi.encounters.v4.BillableStatusType;
41
+ /**
42
+ * 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.
43
+ *
44
+ */
34
45
  responsibleParty?: CandidApi.encounters.v4.ResponsiblePartyType;
46
+ /**
47
+ * Whether you have accepted the patient's authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form.
48
+ *
49
+ */
35
50
  providerAcceptsAssignment?: boolean;
51
+ /**
52
+ * Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form.
53
+ *
54
+ */
36
55
  benefitsAssignedToProvider?: boolean;
56
+ /**
57
+ * Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call.
58
+ *
59
+ */
37
60
  synchronicity?: CandidApi.encounters.v4.SynchronicityType;
61
+ /**
62
+ * 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).
63
+ *
64
+ */
38
65
  placeOfServiceCode?: CandidApi.FacilityTypeCode;
66
+ /**
67
+ * Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
68
+ *
69
+ */
39
70
  appointmentType?: string;
71
+ /**
72
+ * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
73
+ * This date must be the local date in the timezone where the service occurred.
74
+ * If omitted, the Encounter is assumed to be for a single day.
75
+ * Must not be temporally before the date_of_service field.
76
+ *
77
+ */
40
78
  endDateOfService?: CandidApi.Date_;
79
+ /** Contains details of the secondary insurance subscriber. */
41
80
  subscriberSecondary?: CandidApi.SubscriberCreate;
42
81
  }
@@ -4,19 +4,30 @@
4
4
  import * as CandidApi from "../../../../../..";
5
5
  export interface GetAllEncountersRequest {
6
6
  /**
7
- * Defaults to 100
7
+ * Maximum number of entities per page, defaults to 100.
8
8
  */
9
9
  limit?: number;
10
+ /**
11
+ * Indicates the current status of an insurance claim within the billing process.
12
+ */
10
13
  claimStatus?: CandidApi.ClaimStatus;
11
14
  /**
12
- * Defaults to created_at:desc
15
+ * Defaults to created_at:desc.
13
16
  */
14
17
  sort?: CandidApi.encounters.v4.EncounterSortOptions;
15
18
  pageToken?: CandidApi.PageToken;
19
+ /**
20
+ * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
21
+ *
22
+ */
16
23
  dateOfServiceMin?: CandidApi.Date_;
24
+ /**
25
+ * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
26
+ *
27
+ */
17
28
  dateOfServiceMax?: CandidApi.Date_;
18
29
  /**
19
- * Comma delimited string
30
+ * Comma delimited string.
20
31
  */
21
32
  primaryPayerNames?: string;
22
33
  /**
@@ -27,17 +38,31 @@ export interface GetAllEncountersRequest {
27
38
  */
28
39
  searchTerm?: string;
29
40
  /**
30
- * Filter to an exact match on encounter external_id, if one exists
41
+ * Filter to an exact match on encounter external_id, if one exists.
31
42
  */
32
43
  externalId?: CandidApi.EncounterExternalId;
33
44
  /**
34
- * ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z
45
+ * ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z.
35
46
  *
36
47
  */
37
48
  diagnosesUpdatedSince?: Date;
49
+ /**
50
+ * Filter by name of tags on encounters.
51
+ */
38
52
  tagIds?: CandidApi.TagId | CandidApi.TagId[];
39
53
  workQueueId?: CandidApi.WorkQueueId;
54
+ /**
55
+ * 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
+ */
40
58
  billableStatus?: CandidApi.encounters.v4.BillableStatusType;
59
+ /**
60
+ * 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
+ */
41
63
  responsibleParty?: CandidApi.encounters.v4.ResponsiblePartyType;
64
+ /**
65
+ * The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
66
+ */
42
67
  ownerOfNextAction?: CandidApi.encounters.v4.EncounterOwnerOfNextActionType;
43
68
  }
@@ -5,17 +5,48 @@ import * as CandidApi from "../../../../..";
5
5
  export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
6
6
  encounterId: CandidApi.EncounterId;
7
7
  claims: CandidApi.Claim[];
8
+ /**
9
+ * Contains the identification information of the individual receiving medical services.
10
+ *
11
+ */
8
12
  patient: CandidApi.Patient;
13
+ /** Personal and contact info for the guarantor of the patient responsibility. */
9
14
  guarantor?: CandidApi.guarantor.v1.Guarantor;
15
+ /**
16
+ * 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.
17
+ *
18
+ */
10
19
  billingProvider: CandidApi.encounterProviders.v2.EncounterProvider;
20
+ /**
21
+ * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
22
+ * 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.
23
+ *
24
+ */
11
25
  renderingProvider: CandidApi.encounterProviders.v2.EncounterProvider;
12
26
  referringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
27
+ /**
28
+ * 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.
29
+ *
30
+ */
13
31
  serviceFacility: CandidApi.EncounterServiceFacility;
32
+ /**
33
+ * Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
34
+ * These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
35
+ * However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
36
+ * Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
37
+ *
38
+ */
14
39
  subscriberPrimary?: CandidApi.Subscriber;
40
+ /** Contains details of the secondary insurance subscriber. */
15
41
  subscriberSecondary?: CandidApi.Subscriber;
16
- /** URL that links directly to the claim created in Candid */
42
+ /** URL that links directly to the claim created in Candid. */
17
43
  url: CandidApi.LinkUrl;
44
+ /**
45
+ * 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.
46
+ *
47
+ */
18
48
  diagnoses: CandidApi.Diagnosis[];
49
+ /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
19
50
  clinicalNotes: CandidApi.encounters.v4.ClinicalNoteCategory[];
20
51
  /**
21
52
  * Spot to store misc, human-readable, notes about this encounter to be
@@ -23,11 +54,20 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
23
54
  *
24
55
  */
25
56
  billingNotes?: CandidApi.billingNotes.v2.BillingNote[];
57
+ /**
58
+ * 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).
59
+ *
60
+ */
26
61
  placeOfServiceCode?: CandidApi.FacilityTypeCode;
62
+ /**
63
+ * 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).
64
+ *
65
+ */
27
66
  placeOfServiceCodeAsSubmitted?: CandidApi.FacilityTypeCode;
28
67
  patientHistories: CandidApi.encounters.v4.PatientHistoryCategory[];
29
68
  patientPayments: CandidApi.patientPayments.v3.PatientPayment[];
30
69
  tags: CandidApi.Tag[];
70
+ /** The entity that performed the coding of medical services for the claim. */
31
71
  codingAttribution?: CandidApi.encounters.v4.CodingAttributionType;
32
72
  workQueueId?: CandidApi.WorkQueueId;
33
73
  workQueueMembershipActivatedAt?: Date;
@@ -50,13 +50,14 @@ export interface EncounterBase {
50
50
  */
51
51
  providerAcceptsAssignment: boolean;
52
52
  /**
53
- * Human-readable description of the appointment type (ex: "Acupuncture - Headaches")
53
+ * Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
54
54
  *
55
55
  */
56
56
  appointmentType?: string;
57
57
  existingMedications?: CandidApi.encounters.v4.Medication[];
58
58
  vitals?: CandidApi.encounters.v4.Vitals;
59
59
  interventions?: CandidApi.encounters.v4.Intervention[];
60
+ /** Specifies the address to which payments for the claim should be sent. */
60
61
  payToAddress?: CandidApi.StreetAddressLongZip;
61
62
  /**
62
63
  * Whether or not this was a synchronous or asynchronous encounter.
@@ -10,8 +10,8 @@ export interface Intervention {
10
10
  *
11
11
  */
12
12
  description?: string;
13
- /** Required when `type` is `allopathic` */
13
+ /** Required when `type` is `allopathic`. */
14
14
  medication?: CandidApi.encounters.v4.Medication;
15
- /** Required when `type` is `tests` */
15
+ /** Required when `type` is `tests`. */
16
16
  labs?: CandidApi.encounters.v4.Lab[];
17
17
  }
@@ -48,7 +48,7 @@ class V1 {
48
48
  Authorization: await this._getAuthorizationHeader(),
49
49
  "X-Fern-Language": "JavaScript",
50
50
  "X-Fern-SDK-Name": "candidhealth",
51
- "X-Fern-SDK-Version": "0.6.2",
51
+ "X-Fern-SDK-Version": "0.6.3",
52
52
  },
53
53
  contentType: "application/json",
54
54
  body: await serializers.expectedNetworkStatus.v1.ExpectedNetworkStatusRequest.jsonOrThrow(request, {
@@ -7,10 +7,19 @@ export interface ExpectedNetworkStatusRequest {
7
7
  subscriberPayerId: string;
8
8
  subscriberPayerName: string;
9
9
  subscriberInsuranceType?: CandidApi.InsuranceTypeCode;
10
+ /** The descriptive name of the insurance plan selected by the subscriber, often indicating coverage specifics or tier. */
10
11
  subscriberPlanName?: string;
12
+ /** The National Provider Identifier (NPI) of the healthcare provider responsible for billing. A unique 10-digit identification number. */
11
13
  billingProviderNpi: string;
14
+ /** Follow the 9-digit format of the Taxpayer Identification Number (TIN). */
12
15
  billingProviderTin: string;
16
+ /** The National Provider Identifier (NPI) of the healthcare provider who delivered the services. A unique 10-digit identification number. */
13
17
  renderingProviderNpi: string;
18
+ /** The state in which the healthcare provider has a contractual agreement with the insurance payer. */
14
19
  contractedState: CandidApi.State;
20
+ /**
21
+ * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
22
+ *
23
+ */
15
24
  dateOfService: CandidApi.Date_;
16
25
  }
@@ -3,6 +3,7 @@
3
3
  */
4
4
  import * as CandidApi from "../../../../..";
5
5
  export interface ExpectedNetworkStatusResponse {
6
+ /** The anticipated classification of a healthcare provider within the insurance plan's network. */
6
7
  expectedNetworkStatus: CandidApi.expectedNetworkStatus.v1.ExpectedNetworkStatus;
7
8
  explanation: string;
8
9
  contractId?: CandidApi.ContractId;
@@ -25,7 +25,7 @@ export declare class V3 {
25
25
  * **SLA guarantees:** Files for a given date are guaranteed to be available after 3 business days. For example, Friday's file will be
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
- * support@joincandidhealth.com with any data requests outside of these stated guarantees.
28
+ * our [Support team](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.
29
29
  *
30
30
  */
31
31
  getExports(request: CandidApi.exports.v3.GetExportsRequest): Promise<core.APIResponse<CandidApi.exports.v3.GetExportsResponse, CandidApi.exports.v3.getExports.Error>>;
@@ -53,7 +53,7 @@ class V3 {
53
53
  * **SLA guarantees:** Files for a given date are guaranteed to be available after 3 business days. For example, Friday's file will be
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
- * support@joincandidhealth.com with any data requests outside of these stated guarantees.
56
+ * our [Support team](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.
57
57
  *
58
58
  */
59
59
  async getExports(request) {
@@ -68,7 +68,7 @@ class V3 {
68
68
  Authorization: await this._getAuthorizationHeader(),
69
69
  "X-Fern-Language": "JavaScript",
70
70
  "X-Fern-SDK-Name": "candidhealth",
71
- "X-Fern-SDK-Version": "0.6.2",
71
+ "X-Fern-SDK-Version": "0.6.3",
72
72
  },
73
73
  contentType: "application/json",
74
74
  queryParameters: _queryParams,
@@ -48,7 +48,7 @@ class V1 {
48
48
  Authorization: await this._getAuthorizationHeader(),
49
49
  "X-Fern-Language": "JavaScript",
50
50
  "X-Fern-SDK-Name": "candidhealth",
51
- "X-Fern-SDK-Version": "0.6.2",
51
+ "X-Fern-SDK-Version": "0.6.3",
52
52
  },
53
53
  contentType: "application/json",
54
54
  body: await serializers.guarantor.v1.GuarantorCreate.jsonOrThrow(request, {
@@ -94,7 +94,7 @@ class V1 {
94
94
  Authorization: await this._getAuthorizationHeader(),
95
95
  "X-Fern-Language": "JavaScript",
96
96
  "X-Fern-SDK-Name": "candidhealth",
97
- "X-Fern-SDK-Version": "0.6.2",
97
+ "X-Fern-SDK-Version": "0.6.3",
98
98
  },
99
99
  contentType: "application/json",
100
100
  timeoutMs: 60000,
@@ -123,7 +123,7 @@ class V1 {
123
123
  Authorization: await this._getAuthorizationHeader(),
124
124
  "X-Fern-Language": "JavaScript",
125
125
  "X-Fern-SDK-Name": "candidhealth",
126
- "X-Fern-SDK-Version": "0.6.2",
126
+ "X-Fern-SDK-Version": "0.6.3",
127
127
  },
128
128
  contentType: "application/json",
129
129
  body: await serializers.guarantor.v1.GuarantorUpdate.jsonOrThrow(request, {
@@ -5,7 +5,12 @@ import * as CandidApi from "../../../../../..";
5
5
  export interface GuarantorUpdate {
6
6
  firstName?: string;
7
7
  lastName?: string;
8
+ /** A unique identifier for the guarantor assigned by an external system. */
8
9
  externalId?: string;
10
+ /**
11
+ * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
12
+ *
13
+ */
9
14
  dateOfBirth?: string;
10
15
  address?: CandidApi.StreetAddressShortZip;
11
16
  phoneNumbers?: CandidApi.PhoneNumber[];