candidhealth 0.6.1 → 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
@@ -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.1",
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.1",
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.1",
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.1",
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.1",
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[];
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type LicenseType = "MD" | "NP" | "PA" | "LMFT" | "LCPC" | "LCSW" | "PMHNP" | "FNP" | "LPCC" | "DO" | "RD" | "SLP" | "APRN" | "LPC" | "PHD" | "PSYD" | "LMSW" | "LMHC" | "OTHER_MASTERS" | "BCBA" | "UNKNOWN" | "RPH" | "PHT" | "LAC" | "LMT" | "DC" | "ND" | "MA" | "PT" | "IBCLC" | "RN" | "DPT" | "LCMHC";
4
+ export declare type LicenseType = "MD" | "NP" | "PA" | "LMFT" | "LCPC" | "LCSW" | "PMHNP" | "FNP" | "LPCC" | "DO" | "RD" | "SLP" | "APRN" | "LPC" | "PHD" | "PSYD" | "LMSW" | "LMHC" | "OTHER_MASTERS" | "BCBA" | "UNKNOWN" | "RPH" | "PHT" | "LAC" | "LMT" | "DC" | "ND" | "MA" | "PT" | "IBCLC" | "RN" | "DPT" | "LCMHC" | "CNM" | "RNFA" | "ACSW" | "APC" | "BCABA" | "BHA" | "OD" | "DPM" | "DA" | "DDS" | "DEH" | "DMD" | "PTA" | "LCADC" | "LCAT" | "LCMHCS" | "LCMHCA" | "LCSWA" | "LICSW" | "LISW" | "LMFTS" | "LMFTA" | "LPCI" | "LSCSW" | "MHCA" | "MHT" | "RBT" | "RCSWI" | "RHMCI" | "LPN" | "OTD" | "OMS" | "MFTA" | "APCC";
5
5
  export declare const LicenseType: {
6
6
  readonly Md: "MD";
7
7
  readonly Np: "NP";
@@ -36,4 +36,38 @@ export declare const LicenseType: {
36
36
  readonly Rn: "RN";
37
37
  readonly Dpt: "DPT";
38
38
  readonly Lcmhc: "LCMHC";
39
+ readonly Cnm: "CNM";
40
+ readonly Rnfa: "RNFA";
41
+ readonly Acsw: "ACSW";
42
+ readonly Apc: "APC";
43
+ readonly Bcaba: "BCABA";
44
+ readonly Bha: "BHA";
45
+ readonly Od: "OD";
46
+ readonly Dpm: "DPM";
47
+ readonly Da: "DA";
48
+ readonly Dds: "DDS";
49
+ readonly Deh: "DEH";
50
+ readonly Dmd: "DMD";
51
+ readonly Pta: "PTA";
52
+ readonly Lcadc: "LCADC";
53
+ readonly Lcat: "LCAT";
54
+ readonly Lcmhcs: "LCMHCS";
55
+ readonly Lcmhca: "LCMHCA";
56
+ readonly Lcswa: "LCSWA";
57
+ readonly Licsw: "LICSW";
58
+ readonly Lisw: "LISW";
59
+ readonly Lmfts: "LMFTS";
60
+ readonly Lmfta: "LMFTA";
61
+ readonly Lpci: "LPCI";
62
+ readonly Lscsw: "LSCSW";
63
+ readonly Mhca: "MHCA";
64
+ readonly Mht: "MHT";
65
+ readonly Rbt: "RBT";
66
+ readonly Rcswi: "RCSWI";
67
+ readonly Rhmci: "RHMCI";
68
+ readonly Lpn: "LPN";
69
+ readonly Otd: "OTD";
70
+ readonly Oms: "OMS";
71
+ readonly Mfta: "MFTA";
72
+ readonly Apcc: "APCC";
39
73
  };
@@ -38,4 +38,38 @@ exports.LicenseType = {
38
38
  Rn: "RN",
39
39
  Dpt: "DPT",
40
40
  Lcmhc: "LCMHC",
41
+ Cnm: "CNM",
42
+ Rnfa: "RNFA",
43
+ Acsw: "ACSW",
44
+ Apc: "APC",
45
+ Bcaba: "BCABA",
46
+ Bha: "BHA",
47
+ Od: "OD",
48
+ Dpm: "DPM",
49
+ Da: "DA",
50
+ Dds: "DDS",
51
+ Deh: "DEH",
52
+ Dmd: "DMD",
53
+ Pta: "PTA",
54
+ Lcadc: "LCADC",
55
+ Lcat: "LCAT",
56
+ Lcmhcs: "LCMHCS",
57
+ Lcmhca: "LCMHCA",
58
+ Lcswa: "LCSWA",
59
+ Licsw: "LICSW",
60
+ Lisw: "LISW",
61
+ Lmfts: "LMFTS",
62
+ Lmfta: "LMFTA",
63
+ Lpci: "LPCI",
64
+ Lscsw: "LSCSW",
65
+ Mhca: "MHCA",
66
+ Mht: "MHT",
67
+ Rbt: "RBT",
68
+ Rcswi: "RCSWI",
69
+ Rhmci: "RHMCI",
70
+ Lpn: "LPN",
71
+ Otd: "OTD",
72
+ Oms: "OMS",
73
+ Mfta: "MFTA",
74
+ Apcc: "APCC",
41
75
  };
@@ -49,7 +49,7 @@ class V3 {
49
49
  Authorization: await this._getAuthorizationHeader(),
50
50
  "X-Fern-Language": "JavaScript",
51
51
  "X-Fern-SDK-Name": "candidhealth",
52
- "X-Fern-SDK-Version": "0.6.1",
52
+ "X-Fern-SDK-Version": "0.6.3",
53
53
  },
54
54
  contentType: "application/json",
55
55
  timeoutMs: 60000,
@@ -115,7 +115,7 @@ class V3 {
115
115
  Authorization: await this._getAuthorizationHeader(),
116
116
  "X-Fern-Language": "JavaScript",
117
117
  "X-Fern-SDK-Name": "candidhealth",
118
- "X-Fern-SDK-Version": "0.6.1",
118
+ "X-Fern-SDK-Version": "0.6.3",
119
119
  },
120
120
  contentType: "application/json",
121
121
  queryParameters: _queryParams,
@@ -145,7 +145,7 @@ class V3 {
145
145
  Authorization: await this._getAuthorizationHeader(),
146
146
  "X-Fern-Language": "JavaScript",
147
147
  "X-Fern-SDK-Name": "candidhealth",
148
- "X-Fern-SDK-Version": "0.6.1",
148
+ "X-Fern-SDK-Version": "0.6.3",
149
149
  },
150
150
  contentType: "application/json",
151
151
  body: await serializers.organizationProviders.v3.OrganizationProviderCreateV2.jsonOrThrow(request, {
@@ -191,7 +191,7 @@ class V3 {
191
191
  Authorization: await this._getAuthorizationHeader(),
192
192
  "X-Fern-Language": "JavaScript",
193
193
  "X-Fern-SDK-Name": "candidhealth",
194
- "X-Fern-SDK-Version": "0.6.1",
194
+ "X-Fern-SDK-Version": "0.6.3",
195
195
  },
196
196
  contentType: "application/json",
197
197
  body: await serializers.organizationProviders.v3.OrganizationProviderUpdateV2.jsonOrThrow(request, {
@@ -8,27 +8,27 @@ export interface GetAllOrganizationProvidersRequestV2 {
8
8
  */
9
9
  limit?: number;
10
10
  /**
11
- * Filter to a name or a part of a name
11
+ * Filter to a name or a part of a name.
12
12
  */
13
13
  searchTerm?: string;
14
14
  /**
15
- * Filter to a specific NPI
15
+ * Filter to a specific NPI.
16
16
  */
17
17
  npi?: string;
18
18
  /**
19
- * Filter to only rendering providers
19
+ * Filter to only rendering providers.
20
20
  */
21
21
  isRendering?: boolean;
22
22
  /**
23
- * Filter to only billing providers
23
+ * Filter to only billing providers.
24
24
  */
25
25
  isBilling?: boolean;
26
26
  /**
27
- * The page token to continue paging through a previous request
27
+ * The page token to continue paging through a previous request.
28
28
  */
29
29
  pageToken?: CandidApi.PageToken;
30
30
  /**
31
- * Defaults to PROVIDER_NAME_ASC
31
+ * Defaults to PROVIDER_NAME_ASC.
32
32
  */
33
33
  sort?: CandidApi.organizationProviders.v2.OrganizationProviderSortOptions;
34
34
  }
@@ -35,8 +35,8 @@ export interface OrganizationProviderV2 {
35
35
  employmentStartDate?: string;
36
36
  /** The employment termination date for the provider. */
37
37
  employmentTerminationDate?: string;
38
- /** Auto-generated ID set on creation */
38
+ /** Auto-generated ID set on creation. */
39
39
  organizationProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId;
40
- /** Qualification given to a provider (PTAN, Medicaid Provider Id etc.) */
40
+ /** Qualification given to a provider (PTAN, Medicaid Provider Id etc.). */
41
41
  qualifications: CandidApi.Identifier[];
42
42
  }
@@ -49,7 +49,7 @@ class V3 {
49
49
  Authorization: await this._getAuthorizationHeader(),
50
50
  "X-Fern-Language": "JavaScript",
51
51
  "X-Fern-SDK-Name": "candidhealth",
52
- "X-Fern-SDK-Version": "0.6.1",
52
+ "X-Fern-SDK-Version": "0.6.3",
53
53
  },
54
54
  contentType: "application/json",
55
55
  timeoutMs: 60000,
@@ -89,7 +89,7 @@ class V3 {
89
89
  Authorization: await this._getAuthorizationHeader(),
90
90
  "X-Fern-Language": "JavaScript",
91
91
  "X-Fern-SDK-Name": "candidhealth",
92
- "X-Fern-SDK-Version": "0.6.1",
92
+ "X-Fern-SDK-Version": "0.6.3",
93
93
  },
94
94
  contentType: "application/json",
95
95
  queryParameters: _queryParams,
@@ -4,7 +4,7 @@
4
4
  import * as CandidApi from "../../../../../..";
5
5
  export interface GetAllPayersRequest {
6
6
  /**
7
- * Defaults to 100
7
+ * Maximum number of entities per page, defaults to 100.
8
8
  */
9
9
  limit?: number;
10
10
  searchTerm?: string;
@@ -3,10 +3,10 @@
3
3
  */
4
4
  import * as CandidApi from "../../../../..";
5
5
  export interface Payer {
6
- /** Auto-generated ID set on creation */
6
+ /** Auto-generated ID set on creation. */
7
7
  payerUuid: CandidApi.payers.v3.PayerUuid;
8
- /** The primary national payer ID of the payer */
8
+ /** The primary national payer ID of the payer. */
9
9
  payerId: string;
10
- /** The primary display name of the payer */
10
+ /** The primary display name of the payer. */
11
11
  payerName: string;
12
12
  }
@@ -62,7 +62,7 @@ class V2 {
62
62
  Authorization: await this._getAuthorizationHeader(),
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "candidhealth",
65
- "X-Fern-SDK-Version": "0.6.1",
65
+ "X-Fern-SDK-Version": "0.6.3",
66
66
  },
67
67
  contentType: "application/json",
68
68
  body: await serializers.auth.v2.AuthGetTokenRequest.jsonOrThrow(request, {
@@ -2,6 +2,8 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  export interface AuthGetTokenRequest {
5
+ /** Your application's Client ID. */
5
6
  clientId: string;
7
+ /** Your application's Client Secret. */
6
8
  clientSecret: string;
7
9
  }
@@ -3,6 +3,7 @@
3
3
  */
4
4
  export interface AuthGetTokenResponse {
5
5
  accessToken: string;
6
+ /** Time in seconds. */
6
7
  expiresIn: number;
7
8
  tokenType: string;
8
9
  }
@@ -48,7 +48,7 @@ class V2 {
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.1",
51
+ "X-Fern-SDK-Version": "0.6.3",
52
52
  },
53
53
  contentType: "application/json",
54
54
  body: await serializers.billingNotes.v2.StandaloneBillingNoteCreate.jsonOrThrow(request, {
@@ -5,6 +5,11 @@ import * as CandidApi from "../../../../..";
5
5
  export interface BillingNote extends CandidApi.billingNotes.v2.BillingNoteBase {
6
6
  billingNoteId: CandidApi.billingNotes.v2.BillingNoteId;
7
7
  encounterId: CandidApi.EncounterId;
8
+ /**
9
+ * An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/).
10
+ * For example, 2017-07-21T17:32:28Z.
11
+ *
12
+ */
8
13
  createdAt: Date;
9
14
  authorAuth0Id?: string;
10
15
  authorName?: string;
@@ -7,7 +7,157 @@
7
7
  * https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set
8
8
  *
9
9
  */
10
- export declare type FacilityTypeCode = "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "25" | "26" | "31" | "32" | "33" | "34" | "41" | "42" | "49" | "50" | "51" | "52" | "53" | "54" | "55" | "56" | "57" | "58" | "60" | "61" | "62" | "65" | "71" | "72" | "81" | "99";
10
+ export declare type FacilityTypeCode =
11
+ /**
12
+ * Pharmacy */
13
+ "01"
14
+ /**
15
+ * Telehealth */
16
+ | "02"
17
+ /**
18
+ * School */
19
+ | "03"
20
+ /**
21
+ * Homeless Shelter */
22
+ | "04"
23
+ /**
24
+ * Indian Health Service (Free Standing) */
25
+ | "05"
26
+ /**
27
+ * Indian Health Service (Provider Based) */
28
+ | "06"
29
+ /**
30
+ * Tribal Free Standing */
31
+ | "07"
32
+ /**
33
+ * Tribal Provider Based */
34
+ | "08"
35
+ /**
36
+ * Prison or Correctional Facility */
37
+ | "09"
38
+ /**
39
+ * Telehealth Patient Home */
40
+ | "10"
41
+ /**
42
+ * Office */
43
+ | "11"
44
+ /**
45
+ * Home */
46
+ | "12"
47
+ /**
48
+ * Assisted Living Facility */
49
+ | "13"
50
+ /**
51
+ * Group Home */
52
+ | "14"
53
+ /**
54
+ * Mobile Unit */
55
+ | "15"
56
+ /**
57
+ * Temporary Lodging */
58
+ | "16"
59
+ /**
60
+ * Walk-in Retail Health Clinic */
61
+ | "17"
62
+ /**
63
+ * Place of Employment Worksite */
64
+ | "18"
65
+ /**
66
+ * Off Campus Outpatient Hospital */
67
+ | "19"
68
+ /**
69
+ * Urgent Care Facility */
70
+ | "20"
71
+ /**
72
+ * Inpatient Hospital */
73
+ | "21"
74
+ /**
75
+ * Outpatient Hospital */
76
+ | "22"
77
+ /**
78
+ * Emergency Room Hospital */
79
+ | "23"
80
+ /**
81
+ * Ambulatory Surgical Center */
82
+ | "24"
83
+ /**
84
+ * Birthing Center */
85
+ | "25"
86
+ /**
87
+ * Military Treatment Facility */
88
+ | "26"
89
+ /**
90
+ * Skilled Nursing Facility */
91
+ | "31"
92
+ /**
93
+ * Nursing Facility */
94
+ | "32"
95
+ /**
96
+ * Custodial Care Facility */
97
+ | "33"
98
+ /**
99
+ * Hospice */
100
+ | "34"
101
+ /**
102
+ * Ambulance (Land) */
103
+ | "41"
104
+ /**
105
+ * Ambulance (Air or Water) */
106
+ | "42"
107
+ /**
108
+ * Independent Clinic */
109
+ | "49"
110
+ /**
111
+ * Federally Qualified Health Center */
112
+ | "50"
113
+ /**
114
+ * Inpatient Psychiatric Facility */
115
+ | "51"
116
+ /**
117
+ * Psychiatric Facility (Partial Hospitalization) */
118
+ | "52"
119
+ /**
120
+ * Community Mental Health Center */
121
+ | "53"
122
+ /**
123
+ * Intermediate Care Facility/Individuals with Intellectual Disabilities */
124
+ | "54"
125
+ /**
126
+ * Residential Substance Abuse Treatment Facility */
127
+ | "55"
128
+ /**
129
+ * Psychiatric Residential Treatment Center */
130
+ | "56"
131
+ /**
132
+ * Non-residential Substance Abuse Treatment Facility */
133
+ | "57"
134
+ /**
135
+ * Non-residential Opioid Treatment Facility */
136
+ | "58"
137
+ /**
138
+ * Mass Immunization Center */
139
+ | "60"
140
+ /**
141
+ * Comprehensive Inpatient Rehabilitation Facility */
142
+ | "61"
143
+ /**
144
+ * Comprehensive Outpatient Rehabilitation Facility */
145
+ | "62"
146
+ /**
147
+ * End Stage Renal Disease Treatment Facility */
148
+ | "65"
149
+ /**
150
+ * State or Local Public Health Clinic */
151
+ | "71"
152
+ /**
153
+ * Rural Health Clinic */
154
+ | "72"
155
+ /**
156
+ * Independent Laboratory */
157
+ | "81"
158
+ /**
159
+ * Other Unlisted Facility */
160
+ | "99";
11
161
  export declare const FacilityTypeCode: {
12
162
  readonly Pharmacy: "01";
13
163
  readonly Telehealth: "02";