candidhealth 0.6.3 → 0.6.4

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 (93) 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 +7 -0
  3. package/api/resources/auth/resources/v2/types/AuthGetTokenResponse.d.ts +8 -0
  4. package/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  5. package/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +11 -0
  6. package/api/resources/claims/types/Claim.d.ts +76 -0
  7. package/api/resources/commons/types/Email.d.ts +4 -0
  8. package/api/resources/commons/types/PageToken.d.ts +4 -0
  9. package/api/resources/commons/types/PhoneNumber.d.ts +7 -0
  10. package/api/resources/commons/types/StreetAddressLongZip.d.ts +11 -0
  11. package/api/resources/commons/types/StreetAddressShortZip.d.ts +11 -0
  12. package/api/resources/diagnoses/types/Diagnosis.d.ts +12 -0
  13. package/api/resources/eligibility/resources/v2/client/Client.js +1 -1
  14. package/api/resources/encounterProviders/resources/v2/types/EncounterProvider.d.ts +20 -0
  15. package/api/resources/encounters/resources/v4/client/Client.js +4 -4
  16. package/api/resources/encounters/resources/v4/types/ClinicalNoteCategory.d.ts +13 -0
  17. package/api/resources/encounters/resources/v4/types/Encounter.d.ts +368 -0
  18. package/api/resources/encounters/resources/v4/types/EncounterPage.d.ts +370 -0
  19. package/api/resources/encounters/resources/v4/types/IntakeFollowUp.d.ts +8 -0
  20. package/api/resources/encounters/resources/v4/types/IntakeQuestion.d.ts +15 -0
  21. package/api/resources/encounters/resources/v4/types/IntakeResponseAndFollowUps.d.ts +11 -0
  22. package/api/resources/encounters/resources/v4/types/Intervention.d.ts +21 -0
  23. package/api/resources/encounters/resources/v4/types/Lab.d.ts +8 -0
  24. package/api/resources/encounters/resources/v4/types/Medication.d.ts +11 -0
  25. package/api/resources/encounters/resources/v4/types/PatientHistoryCategory.d.ts +18 -0
  26. package/api/resources/encounters/resources/v4/types/Vitals.d.ts +10 -0
  27. package/api/resources/era/types/Era.d.ts +8 -0
  28. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  29. package/api/resources/exports/resources/v3/client/Client.js +1 -1
  30. package/api/resources/exports/resources/v3/types/GetExportsResponse.d.ts +9 -0
  31. package/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  32. package/api/resources/guarantor/resources/v1/types/Guarantor.d.ts +25 -0
  33. package/api/resources/identifiers/types/Identifier.d.ts +12 -0
  34. package/api/resources/individual/types/Patient.d.ts +26 -0
  35. package/api/resources/individual/types/Subscriber.d.ts +33 -0
  36. package/api/resources/insuranceCard/types/InsuranceCard.d.ts +17 -0
  37. package/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  38. package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderPageV2.d.ts +29 -0
  39. package/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +27 -0
  40. package/api/resources/patientPayments/resources/v3/types/PatientPayment.d.ts +17 -0
  41. package/api/resources/payers/resources/v3/client/Client.js +2 -2
  42. package/api/resources/payers/resources/v3/types/Payer.d.ts +8 -0
  43. package/api/resources/payers/resources/v3/types/PayerPage.d.ts +10 -0
  44. package/api/resources/serviceFacility/types/EncounterServiceFacility.d.ts +15 -0
  45. package/api/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +64 -0
  46. package/api/resources/tags/types/Tag.d.ts +9 -0
  47. package/dist/api/resources/auth/resources/v2/client/Client.js +1 -1
  48. package/dist/api/resources/auth/resources/v2/types/AuthGetTokenRequest.d.ts +7 -0
  49. package/dist/api/resources/auth/resources/v2/types/AuthGetTokenResponse.d.ts +8 -0
  50. package/dist/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  51. package/dist/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts +11 -0
  52. package/dist/api/resources/claims/types/Claim.d.ts +76 -0
  53. package/dist/api/resources/commons/types/Email.d.ts +4 -0
  54. package/dist/api/resources/commons/types/PageToken.d.ts +4 -0
  55. package/dist/api/resources/commons/types/PhoneNumber.d.ts +7 -0
  56. package/dist/api/resources/commons/types/StreetAddressLongZip.d.ts +11 -0
  57. package/dist/api/resources/commons/types/StreetAddressShortZip.d.ts +11 -0
  58. package/dist/api/resources/diagnoses/types/Diagnosis.d.ts +12 -0
  59. package/dist/api/resources/eligibility/resources/v2/client/Client.js +1 -1
  60. package/dist/api/resources/encounterProviders/resources/v2/types/EncounterProvider.d.ts +20 -0
  61. package/dist/api/resources/encounters/resources/v4/client/Client.js +4 -4
  62. package/dist/api/resources/encounters/resources/v4/types/ClinicalNoteCategory.d.ts +13 -0
  63. package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts +368 -0
  64. package/dist/api/resources/encounters/resources/v4/types/EncounterPage.d.ts +370 -0
  65. package/dist/api/resources/encounters/resources/v4/types/IntakeFollowUp.d.ts +8 -0
  66. package/dist/api/resources/encounters/resources/v4/types/IntakeQuestion.d.ts +15 -0
  67. package/dist/api/resources/encounters/resources/v4/types/IntakeResponseAndFollowUps.d.ts +11 -0
  68. package/dist/api/resources/encounters/resources/v4/types/Intervention.d.ts +21 -0
  69. package/dist/api/resources/encounters/resources/v4/types/Lab.d.ts +8 -0
  70. package/dist/api/resources/encounters/resources/v4/types/Medication.d.ts +11 -0
  71. package/dist/api/resources/encounters/resources/v4/types/PatientHistoryCategory.d.ts +18 -0
  72. package/dist/api/resources/encounters/resources/v4/types/Vitals.d.ts +10 -0
  73. package/dist/api/resources/era/types/Era.d.ts +8 -0
  74. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  75. package/dist/api/resources/exports/resources/v3/client/Client.js +1 -1
  76. package/dist/api/resources/exports/resources/v3/types/GetExportsResponse.d.ts +9 -0
  77. package/dist/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  78. package/dist/api/resources/guarantor/resources/v1/types/Guarantor.d.ts +25 -0
  79. package/dist/api/resources/identifiers/types/Identifier.d.ts +12 -0
  80. package/dist/api/resources/individual/types/Patient.d.ts +26 -0
  81. package/dist/api/resources/individual/types/Subscriber.d.ts +33 -0
  82. package/dist/api/resources/insuranceCard/types/InsuranceCard.d.ts +17 -0
  83. package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  84. package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderPageV2.d.ts +29 -0
  85. package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts +27 -0
  86. package/dist/api/resources/patientPayments/resources/v3/types/PatientPayment.d.ts +17 -0
  87. package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
  88. package/dist/api/resources/payers/resources/v3/types/Payer.d.ts +8 -0
  89. package/dist/api/resources/payers/resources/v3/types/PayerPage.d.ts +10 -0
  90. package/dist/api/resources/serviceFacility/types/EncounterServiceFacility.d.ts +15 -0
  91. package/dist/api/resources/serviceLines/resources/v2/types/ServiceLine.d.ts +64 -0
  92. package/dist/api/resources/tags/types/Tag.d.ts +9 -0
  93. package/package.json +1 -1
@@ -2,6 +2,18 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as CandidApi from "../../..";
5
+ /**
6
+ * @example
7
+ * {
8
+ * diagnosisId: CandidApi.DiagnosisId("5C770E00-4BBF-42AF-A73F-99C5E91FC0DB"),
9
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
10
+ * updatedAt: new Date("2023-01-01T00:00:00.000Z"),
11
+ * encounterId: CandidApi.EncounterId("3F63985B-51A4-4DD4-9418-7D50B2520792"),
12
+ * name: "John Doe",
13
+ * codeType: CandidApi.DiagnosisTypeCode.Abf,
14
+ * code: "I10"
15
+ * }
16
+ */
5
17
  export interface Diagnosis extends CandidApi.StandaloneDiagnosisCreate {
6
18
  diagnosisId: CandidApi.DiagnosisId;
7
19
  createdAt: Date;
@@ -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.3",
68
+ "X-Fern-SDK-Version": "0.6.4",
69
69
  },
70
70
  contentType: "application/json",
71
71
  body: request,
@@ -2,6 +2,26 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as CandidApi from "../../../../..";
5
+ /**
6
+ * @example
7
+ * {
8
+ * providerId: CandidApi.encounterProviders.v2.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9
+ * address: {
10
+ * address1: "123 Main St",
11
+ * address2: "Apt 1",
12
+ * city: "New York",
13
+ * state: CandidApi.State.Ny,
14
+ * zipCode: "10001",
15
+ * zipPlusFourCode: "1234"
16
+ * },
17
+ * taxId: "123456789",
18
+ * npi: "1234567890",
19
+ * taxonomyCode: "207Q00000X",
20
+ * firstName: "John",
21
+ * lastName: "Doe",
22
+ * organizationName: "Organization Name"
23
+ * }
24
+ */
5
25
  export interface EncounterProvider extends CandidApi.encounterProviders.v2.EncounterProviderBase {
6
26
  providerId: CandidApi.encounterProviders.v2.ProviderId;
7
27
  address: CandidApi.StreetAddressLongZip;
@@ -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.3",
106
+ "X-Fern-SDK-Version": "0.6.4",
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.3",
136
+ "X-Fern-SDK-Version": "0.6.4",
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.3",
165
+ "X-Fern-SDK-Version": "0.6.4",
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.3",
215
+ "X-Fern-SDK-Version": "0.6.4",
216
216
  },
217
217
  contentType: "application/json",
218
218
  body: await serializers.encounters.v4.EncounterUpdate.jsonOrThrow(request, {
@@ -2,6 +2,19 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as CandidApi from "../../../../..";
5
+ /**
6
+ * @example
7
+ * {
8
+ * category: CandidApi.encounters.v4.NoteCategory.Clinical,
9
+ * notes: ["Patient complained of mild chest pain."],
10
+ * notesStructured: [{
11
+ * text: "Mild chest pain since morning.",
12
+ * authorName: "John Doe",
13
+ * authorNpi: CandidApi.Npi("1234567890"),
14
+ * timestamp: new Date("2023-01-01T00:00:00.000Z")
15
+ * }]
16
+ * }
17
+ */
5
18
  export interface ClinicalNoteCategory {
6
19
  category: CandidApi.encounters.v4.NoteCategory;
7
20
  notes: string[];
@@ -2,6 +2,374 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as CandidApi from "../../../../..";
5
+ /**
6
+ * @example
7
+ * {
8
+ * encounterId: CandidApi.EncounterId("B2506E84-4470-4CBA-8A68-6883367739E1"),
9
+ * claims: [{
10
+ * claimId: CandidApi.ClaimId("DD9D7F82-37B5-449D-AA63-26925398335B"),
11
+ * status: CandidApi.ClaimStatus.BillerReceived,
12
+ * clearinghouse: "Change Healthcare",
13
+ * clearinghouseClaimId: "5BA7C3AB-2BC2-496C-8B10-6CAC73D0729D",
14
+ * payerClaimId: "9BB9F259-9756-4F16-8F53-9DBB9F7EB1BB",
15
+ * serviceLines: [{
16
+ * modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
17
+ * chargeAmountCents: 10000,
18
+ * allowedAmountCents: 8000,
19
+ * insuranceBalanceCents: 0,
20
+ * patientBalanceCents: 2000,
21
+ * paidAmountCents: 8000,
22
+ * patientResponsibilityCents: 2000,
23
+ * diagnosisIdZero: CandidApi.DiagnosisId("4AC84BCD-12F5-4F86-A57B-E06749127C98"),
24
+ * diagnosisIdOne: CandidApi.DiagnosisId("EEA5CA5A-8B43-45FD-8CBD-C6CC1103E759"),
25
+ * diagnosisIdTwo: CandidApi.DiagnosisId("5C4AA029-2DB9-4202-916E-E93C708F65FF"),
26
+ * diagnosisIdThree: CandidApi.DiagnosisId("81795126-A3AC-443C-B47E-7259A16AB4A2"),
27
+ * serviceLineEraData: {
28
+ * serviceLineAdjustments: [{
29
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
30
+ * adjustmentGroupCode: "CO",
31
+ * adjustmentReasonCode: "CO",
32
+ * adjustmentAmountCents: 1000,
33
+ * adjustmentNote: "test_note"
34
+ * }],
35
+ * remittanceAdviceRemarkCodes: ["N362"]
36
+ * },
37
+ * serviceLineManualAdjustments: [{
38
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
39
+ * adjustmentGroupCode: "CO",
40
+ * adjustmentReasonCode: "CO",
41
+ * adjustmentAmountCents: 1000,
42
+ * adjustmentNote: "test_note"
43
+ * }],
44
+ * relatedInvoices: [{
45
+ * id: CandidApi.InvoiceId("901BE2F1-41BC-456E-9987-4FE2F84F9D75"),
46
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
47
+ * updatedAt: new Date("2023-01-01T00:00:00.000Z"),
48
+ * organzationId: CandidApi.OrganizationId("F13F73D4-4344-46EA-9D93-33BCFFBB9F36"),
49
+ * sourceId: "9B626577-8808-4F28-9ED1-F0DFF0D49BBC",
50
+ * sourceCustomerId: "624D1972-8C69-4C2F-AEFA-10856F734DB3",
51
+ * patientExternalId: CandidApi.PatientExternalId("10FED4D6-4C5A-48DF-838A-EEF45A74788D"),
52
+ * note: "test_note",
53
+ * dueDate: CandidApi.Date_("2023-10-10"),
54
+ * status: CandidApi.InvoiceStatus.Draft,
55
+ * url: "https://example.com",
56
+ * customerInvoiceUrl: "https://example.com",
57
+ * items: [{
58
+ * serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
59
+ * amountCents: 500
60
+ * }]
61
+ * }],
62
+ * denialReason: {
63
+ * reason: CandidApi.serviceLines.v2.DenialReasonContent.AuthorizationRequired
64
+ * },
65
+ * placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
66
+ * serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
67
+ * procedureCode: "99213",
68
+ * quantity: CandidApi.Decimal("1"),
69
+ * units: CandidApi.ServiceLineUnits.Mj,
70
+ * claimId: CandidApi.ClaimId("026A1FB8-748E-4859-A2D7-3EA9E07D25AE"),
71
+ * dateOfServiceRange: {
72
+ * startDate: CandidApi.Date_("2023-01-01"),
73
+ * endDate: CandidApi.Date_("2023-01-03")
74
+ * }
75
+ * }],
76
+ * eras: [{
77
+ * eraId: CandidApi.EraId("4D844EF1-2253-43CD-A4F1-6DB7E65CB54B"),
78
+ * checkNumber: "CHK12345",
79
+ * checkDate: CandidApi.Date_("2023-10-12")
80
+ * }]
81
+ * }],
82
+ * patient: {
83
+ * individualId: CandidApi.IndividualId("93DDBEBF-4956-4482-9A6C-21499B7E4E5D"),
84
+ * phoneNumbers: [{
85
+ * number: "1234567890",
86
+ * type: CandidApi.PhoneNumberType.Home
87
+ * }],
88
+ * phoneConsent: true,
89
+ * email: CandidApi.Email("johndoe@joincandidhealth.com"),
90
+ * emailConsent: true,
91
+ * externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
92
+ * dateOfBirth: CandidApi.Date_("2000-01-01"),
93
+ * address: {
94
+ * address1: "123 Main St",
95
+ * address2: "Apt 1",
96
+ * city: "New York",
97
+ * state: CandidApi.State.Ny,
98
+ * zipCode: "10001",
99
+ * zipPlusFourCode: "1234"
100
+ * },
101
+ * firstName: "John",
102
+ * lastName: "Doe",
103
+ * gender: CandidApi.Gender.Male
104
+ * },
105
+ * guarantor: {
106
+ * guarantorId: CandidApi.guarantor.v1.GuarantorId("8BBDBE63-58D3-4D40-98C9-40403C050977"),
107
+ * phoneNumbers: [{
108
+ * number: "1234567890",
109
+ * type: CandidApi.PhoneNumberType.Home
110
+ * }],
111
+ * phoneConsent: true,
112
+ * email: CandidApi.Email("johndoe@joincandidhealth.com"),
113
+ * emailConsent: true,
114
+ * firstName: "John",
115
+ * lastName: "Doe",
116
+ * externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
117
+ * dateOfBirth: "2000-01-01",
118
+ * address: {
119
+ * address1: "123 Main St",
120
+ * address2: "Apt 1",
121
+ * city: "New York",
122
+ * state: CandidApi.State.Ny,
123
+ * zipCode: "10001",
124
+ * zipPlusFourCode: "1234"
125
+ * }
126
+ * },
127
+ * billingProvider: {
128
+ * providerId: CandidApi.encounterProviders.v2.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
129
+ * address: {
130
+ * address1: "123 Main St",
131
+ * address2: "Apt 1",
132
+ * city: "New York",
133
+ * state: CandidApi.State.Ny,
134
+ * zipCode: "10001",
135
+ * zipPlusFourCode: "1234"
136
+ * },
137
+ * taxId: "123456789",
138
+ * npi: "1234567890",
139
+ * taxonomyCode: "207Q00000X",
140
+ * firstName: "John",
141
+ * lastName: "Doe",
142
+ * organizationName: "Organization Name"
143
+ * },
144
+ * renderingProvider: {
145
+ * providerId: CandidApi.encounterProviders.v2.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
146
+ * address: {
147
+ * address1: "123 Main St",
148
+ * address2: "Apt 1",
149
+ * city: "New York",
150
+ * state: CandidApi.State.Ny,
151
+ * zipCode: "10001",
152
+ * zipPlusFourCode: "1234"
153
+ * },
154
+ * taxId: "123456789",
155
+ * npi: "1234567890",
156
+ * taxonomyCode: "207Q00000X",
157
+ * firstName: "John",
158
+ * lastName: "Doe",
159
+ * organizationName: "Organization Name"
160
+ * },
161
+ * referringProvider: {
162
+ * providerId: CandidApi.encounterProviders.v2.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
163
+ * address: {
164
+ * address1: "123 Main St",
165
+ * address2: "Apt 1",
166
+ * city: "New York",
167
+ * state: CandidApi.State.Ny,
168
+ * zipCode: "10001",
169
+ * zipPlusFourCode: "1234"
170
+ * },
171
+ * taxId: "123456789",
172
+ * npi: "1234567890",
173
+ * taxonomyCode: "207Q00000X",
174
+ * firstName: "John",
175
+ * lastName: "Doe",
176
+ * organizationName: "Organization Name"
177
+ * },
178
+ * serviceFacility: {
179
+ * serviceFacilityId: CandidApi.ServiceFacilityId("2861487B-232C-4DED-A874-616A5DB0688F"),
180
+ * organizationName: "Test Organization",
181
+ * address: {
182
+ * address1: "123 Main St",
183
+ * address2: "Apt 1",
184
+ * city: "New York",
185
+ * state: CandidApi.State.Ny,
186
+ * zipCode: "10001",
187
+ * zipPlusFourCode: "1234"
188
+ * }
189
+ * },
190
+ * subscriberPrimary: {
191
+ * individualId: CandidApi.IndividualId("797348A9-E7E8-4E59-8628-95390D079C0B"),
192
+ * insuranceCard: {
193
+ * insuranceCardId: CandidApi.InsuranceCardId("CA5B7711-4419-4161-9B7C-3494AC40C8D4"),
194
+ * memberId: "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
195
+ * payerName: "John Doe",
196
+ * payerId: "836DDAA6-863F-4020-ACCA-205A689F0002",
197
+ * rxBin: "610014",
198
+ * rxPcn: "MEDDPRIME",
199
+ * imageUrlFront: "https://s3.amazonaws.com/front.jpg",
200
+ * imageUrlBack: "https://s3.amazonaws.com/back.jpg",
201
+ * groupNumber: "ABC12345",
202
+ * planName: "Silver PPO Plan",
203
+ * planType: CandidApi.SourceOfPaymentCode.SelfPay,
204
+ * insuranceType: CandidApi.InsuranceTypeCode.C01
205
+ * },
206
+ * patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
207
+ * dateOfBirth: CandidApi.Date_("2000-01-01"),
208
+ * address: {
209
+ * address1: "123 Main St",
210
+ * address2: "Apt 1",
211
+ * city: "New York",
212
+ * state: CandidApi.State.Ny,
213
+ * zipCode: "10001",
214
+ * zipPlusFourCode: "1234"
215
+ * },
216
+ * firstName: "John",
217
+ * lastName: "Doe",
218
+ * gender: CandidApi.Gender.Male
219
+ * },
220
+ * subscriberSecondary: {
221
+ * individualId: CandidApi.IndividualId("797348A9-E7E8-4E59-8628-95390D079C0B"),
222
+ * insuranceCard: {
223
+ * insuranceCardId: CandidApi.InsuranceCardId("CA5B7711-4419-4161-9B7C-3494AC40C8D4"),
224
+ * memberId: "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
225
+ * payerName: "John Doe",
226
+ * payerId: "836DDAA6-863F-4020-ACCA-205A689F0002",
227
+ * rxBin: "610014",
228
+ * rxPcn: "MEDDPRIME",
229
+ * imageUrlFront: "https://s3.amazonaws.com/front.jpg",
230
+ * imageUrlBack: "https://s3.amazonaws.com/back.jpg",
231
+ * groupNumber: "ABC12345",
232
+ * planName: "Silver PPO Plan",
233
+ * planType: CandidApi.SourceOfPaymentCode.SelfPay,
234
+ * insuranceType: CandidApi.InsuranceTypeCode.C01
235
+ * },
236
+ * patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
237
+ * dateOfBirth: CandidApi.Date_("2000-01-01"),
238
+ * address: {
239
+ * address1: "123 Main St",
240
+ * address2: "Apt 1",
241
+ * city: "New York",
242
+ * state: CandidApi.State.Ny,
243
+ * zipCode: "10001",
244
+ * zipPlusFourCode: "1234"
245
+ * },
246
+ * firstName: "John",
247
+ * lastName: "Doe",
248
+ * gender: CandidApi.Gender.Male
249
+ * },
250
+ * url: CandidApi.LinkUrl("https://example.com"),
251
+ * diagnoses: [{
252
+ * diagnosisId: CandidApi.DiagnosisId("5C770E00-4BBF-42AF-A73F-99C5E91FC0DB"),
253
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
254
+ * updatedAt: new Date("2023-01-01T00:00:00.000Z"),
255
+ * encounterId: CandidApi.EncounterId("3F63985B-51A4-4DD4-9418-7D50B2520792"),
256
+ * name: "John Doe",
257
+ * codeType: CandidApi.DiagnosisTypeCode.Abf,
258
+ * code: "I10"
259
+ * }],
260
+ * clinicalNotes: [{
261
+ * category: CandidApi.encounters.v4.NoteCategory.Clinical,
262
+ * notes: ["Patient complained of mild chest pain."],
263
+ * notesStructured: [{
264
+ * text: "Mild chest pain since morning.",
265
+ * authorName: "John Doe",
266
+ * authorNpi: CandidApi.Npi("1234567890"),
267
+ * timestamp: new Date("2023-01-01T00:00:00.000Z")
268
+ * }]
269
+ * }],
270
+ * billingNotes: [{
271
+ * billingNoteId: CandidApi.billingNotes.v2.BillingNoteId("99882EEA-936F-4E71-BC4F-520E4D14E3E2"),
272
+ * encounterId: CandidApi.EncounterId("8BCFB6A8-2876-4111-9E3F-602B541FCF62"),
273
+ * createdAt: new Date("2023-01-01T00:00:00.000Z"),
274
+ * authorAuth0Id: "F0DE3BF9-F9A1-4FA7-BF6B-28C0B46BADD8",
275
+ * authorName: "John Doe",
276
+ * text: "Patient was billed for an MRI."
277
+ * }],
278
+ * placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
279
+ * placeOfServiceCodeAsSubmitted: CandidApi.FacilityTypeCode.Pharmacy,
280
+ * patientHistories: [{
281
+ * category: CandidApi.encounters.v4.PatientHistoryCategoryEnum.PresentIllness,
282
+ * questions: [{
283
+ * id: CandidApi.encounters.v4.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
284
+ * text: "Do you have any allergies?",
285
+ * responses: [{
286
+ * response: "No allergies",
287
+ * followUps: [{
288
+ * id: CandidApi.encounters.v4.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
289
+ * text: "Do you have any allergies?",
290
+ * response: "No allergies"
291
+ * }]
292
+ * }]
293
+ * }]
294
+ * }],
295
+ * patientPayments: [{
296
+ * patientPaymentId: CandidApi.patientPayments.v3.PatientPaymentId("CF237BE1-E793-4BBF-8958-61D5179D1D0D"),
297
+ * organizationId: CandidApi.OrganizationId("0788CA2A-B20D-4B8E-B8D4-07FA0B3B4907"),
298
+ * sourceInternalId: "D1A76039-D5C5-4323-A2FC-B7C8B6AEF6A4",
299
+ * source: CandidApi.patientPayments.v3.PatientPaymentSource.ManualEntry,
300
+ * amountCents: 2000,
301
+ * paymentTimestamp: new Date("2023-01-01T00:00:00.000Z"),
302
+ * status: CandidApi.patientPayments.v3.PatientPaymentStatus.Pending,
303
+ * paymentName: "John Doe",
304
+ * paymentNote: "test payment note",
305
+ * patientExternalId: CandidApi.PatientExternalId("B7437260-D6B4-48CF-B9D7-753C09F34E76"),
306
+ * encounterExternalId: CandidApi.EncounterExternalId("0F26B9C3-199F-4CBB-A166-B87EA7C631BB"),
307
+ * serviceLineId: CandidApi.ServiceLineId("B557DC86-C629-478C-850A-02D45AC11783")
308
+ * }],
309
+ * tags: [{
310
+ * creatorId: "00EB5A46-35C6-441B-9751-AF307AEF5888",
311
+ * tagId: CandidApi.TagId("void-claim-submitted"),
312
+ * description: "to indicate claims where a void claim has been submitted",
313
+ * color: CandidApi.TagColorEnum.Black
314
+ * }],
315
+ * codingAttribution: CandidApi.encounters.v4.CodingAttributionType.Candid,
316
+ * workQueueId: CandidApi.WorkQueueId("000856FE-1024-418F-BF96-2E7347AB4520"),
317
+ * workQueueMembershipActivatedAt: new Date("2023-01-01T00:00:00.000Z"),
318
+ * ownerOfNextAction: CandidApi.encounters.v4.EncounterOwnerOfNextActionType.Candid,
319
+ * externalId: CandidApi.EncounterExternalId("5C21490F-A9C0-45F4-B5DB-136E3AEC617A"),
320
+ * dateOfService: CandidApi.Date_("2023-01-01"),
321
+ * endDateOfService: CandidApi.Date_("2023-01-05"),
322
+ * priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("PA1234567"),
323
+ * patientAuthorizedRelease: true,
324
+ * benefitsAssignedToProvider: true,
325
+ * providerAcceptsAssignment: true,
326
+ * appointmentType: "Routine Checkup",
327
+ * existingMedications: [{
328
+ * name: "Lisinopril",
329
+ * rxCui: CandidApi.encounters.v4.RxCui("860975"),
330
+ * dosage: "10mg",
331
+ * dosageForm: "Tablet",
332
+ * frequency: "Once Daily",
333
+ * asNeeded: true
334
+ * }],
335
+ * vitals: {
336
+ * heightIn: 70,
337
+ * weightLbs: 165,
338
+ * bloodPressureSystolicMmhg: 115,
339
+ * bloodPressureDiastolicMmhg: 85,
340
+ * bodyTemperatureF: 98
341
+ * },
342
+ * interventions: [{
343
+ * name: "Physical Therapy Session",
344
+ * category: CandidApi.encounters.v4.InterventionCategory.Lifestyle,
345
+ * description: "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
346
+ * medication: {
347
+ * name: "Lisinopril",
348
+ * rxCui: CandidApi.encounters.v4.RxCui("860975"),
349
+ * dosage: "10mg",
350
+ * dosageForm: "Tablet",
351
+ * frequency: "Once Daily",
352
+ * asNeeded: true
353
+ * },
354
+ * labs: [{
355
+ * name: "Genetic Health Labs",
356
+ * code: "GH12345",
357
+ * codeType: CandidApi.encounters.v4.LabCodeType.Quest
358
+ * }]
359
+ * }],
360
+ * payToAddress: {
361
+ * address1: "123 Main St",
362
+ * address2: "Apt 1",
363
+ * city: "New York",
364
+ * state: CandidApi.State.Ny,
365
+ * zipCode: "10001",
366
+ * zipPlusFourCode: "1234"
367
+ * },
368
+ * synchronicity: CandidApi.encounters.v4.SynchronicityType.Synchronous,
369
+ * billableStatus: CandidApi.encounters.v4.BillableStatusType.Billable,
370
+ * responsibleParty: CandidApi.encounters.v4.ResponsiblePartyType.InsurancePay
371
+ * }
372
+ */
5
373
  export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
6
374
  encounterId: CandidApi.EncounterId;
7
375
  claims: CandidApi.Claim[];