@healthcloudai/hc-sdk 3.26.0 → 3.28.0

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 (35) hide show
  1. package/dist/index.cjs +78 -3
  2. package/dist/index.d.cts +869 -338
  3. package/dist/index.d.ts +869 -338
  4. package/dist/index.js +78 -3
  5. package/docs/clients/PatientClient.md +1 -0
  6. package/docs/docs-manifest.json +9 -3
  7. package/docs/examples/index.md +1 -0
  8. package/docs/index.md +1 -0
  9. package/docs/models/CheckInEncounterResponse.md +1 -1
  10. package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
  11. package/docs/models/CheckInsuranceBenefitsResponse.md +28 -0
  12. package/docs/models/GetEncounterResponse.md +1 -1
  13. package/docs/models/InsuranceBenefit.md +27 -0
  14. package/docs/models/ProviderEncounterRecord.md +3 -1
  15. package/docs/models/ProviderIntakeContent.md +25 -0
  16. package/docs/models/ProviderIntakeSubmission.md +29 -0
  17. package/docs/models/ProviderPatientRecordResources.md +1 -1
  18. package/docs/models/ProviderQueueEncounter.md +1 -0
  19. package/docs/models/UpdateEncounterClinicalNoteRequest.md +2 -1
  20. package/docs/models/fieldagent.Encounter.md +1 -1
  21. package/docs/models/index.md +5 -0
  22. package/docs/models/patient.Encounter.md +1 -1
  23. package/docs/models/provider.Encounter.md +1 -1
  24. package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
  25. package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
  26. package/docs/operations/provider.claimEncounter.md +2 -0
  27. package/docs/operations/provider.getEncounter.md +2 -0
  28. package/docs/operations/provider.getEncounterQueue.md +1 -0
  29. package/docs/operations/provider.getPatientRecord.md +54 -0
  30. package/docs/operations/provider.listEncounters.md +2 -0
  31. package/docs/operations/provider.signEncounter.md +2 -0
  32. package/docs/operations/provider.updateEncounterClinicalNote.md +2 -0
  33. package/docs/operations/provider.updateEncounterDiagnoses.md +2 -0
  34. package/docs/operations/provider.updateEncounterStatus.md +2 -0
  35. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -1250,6 +1250,68 @@ function StediClaimsResponseFromJSONTyped(json, ignoreDiscriminator) {
1250
1250
  };
1251
1251
  }
1252
1252
 
1253
+ // src/models/openapi-generated/patient/models/CheckInsuranceBenefitsRequest.ts
1254
+ function CheckInsuranceBenefitsRequestToJSON(json) {
1255
+ return CheckInsuranceBenefitsRequestToJSONTyped(json, false);
1256
+ }
1257
+ function CheckInsuranceBenefitsRequestToJSONTyped(value, ignoreDiscriminator = false) {
1258
+ if (value == null) {
1259
+ return value;
1260
+ }
1261
+ return {
1262
+ "request_id": value["request_id"],
1263
+ "service_date": value["service_date"] == null ? value["service_date"] : value["service_date"].toISOString().substring(0, 10),
1264
+ "service_type_code": value["service_type_code"]
1265
+ };
1266
+ }
1267
+
1268
+ // src/models/openapi-generated/patient/models/InsuranceBenefit.ts
1269
+ function InsuranceBenefitFromJSON(json) {
1270
+ return InsuranceBenefitFromJSONTyped(json, false);
1271
+ }
1272
+ function InsuranceBenefitFromJSONTyped(json, ignoreDiscriminator) {
1273
+ if (json == null) {
1274
+ return json;
1275
+ }
1276
+ return {
1277
+ "additional_conditions": json["additional_conditions"] == null ? void 0 : json["additional_conditions"],
1278
+ "amount": json["amount"] === void 0 ? void 0 : json["amount"] === null ? null : json["amount"],
1279
+ "benefit_end": json["benefit_end"] === void 0 ? void 0 : json["benefit_end"] === null ? null : new Date(json["benefit_end"]),
1280
+ "benefit_start": json["benefit_start"] === void 0 ? void 0 : json["benefit_start"] === null ? null : new Date(json["benefit_start"]),
1281
+ "benefit_type": json["benefit_type"],
1282
+ "coinsurance_fraction": json["coinsurance_fraction"] === void 0 ? void 0 : json["coinsurance_fraction"] === null ? null : json["coinsurance_fraction"],
1283
+ "coverage_level": json["coverage_level"] == null ? void 0 : json["coverage_level"],
1284
+ "network": json["network"] == null ? void 0 : json["network"],
1285
+ "plan_index": json["plan_index"],
1286
+ "service_type_code": json["service_type_code"],
1287
+ "time_period": json["time_period"] == null ? void 0 : json["time_period"]
1288
+ };
1289
+ }
1290
+
1291
+ // src/models/openapi-generated/patient/models/CheckInsuranceBenefitsResponse.ts
1292
+ function CheckInsuranceBenefitsResponseFromJSON(json) {
1293
+ return CheckInsuranceBenefitsResponseFromJSONTyped(json, false);
1294
+ }
1295
+ function CheckInsuranceBenefitsResponseFromJSONTyped(json, ignoreDiscriminator) {
1296
+ if (json == null) {
1297
+ return json;
1298
+ }
1299
+ return {
1300
+ "benefits": json["benefits"] == null ? void 0 : json["benefits"].map(InsuranceBenefitFromJSON),
1301
+ "check_id": json["check_id"],
1302
+ "checked_at": new Date(json["checked_at"]),
1303
+ "coverage_id": json["coverage_id"] === void 0 ? void 0 : json["coverage_id"] === null ? null : json["coverage_id"],
1304
+ "endpoint_version": json["endpoint_version"] == null ? void 0 : json["endpoint_version"],
1305
+ "interpretation": json["interpretation"] == null ? void 0 : json["interpretation"],
1306
+ "network_determination": json["network_determination"] == null ? void 0 : json["network_determination"],
1307
+ "reason": json["reason"],
1308
+ "service_date": json["service_date"] === void 0 ? void 0 : json["service_date"] === null ? null : new Date(json["service_date"]),
1309
+ "service_type_code": json["service_type_code"],
1310
+ "source": json["source"] == null ? void 0 : json["source"],
1311
+ "status": json["status"]
1312
+ };
1313
+ }
1314
+
1253
1315
  // src/models/openapi-generated/patient/models/CheckEligibilityResponse.ts
1254
1316
  function CheckEligibilityResponseFromJSON(json) {
1255
1317
  return CheckEligibilityResponseFromJSONTyped(json, false);
@@ -3418,6 +3480,12 @@ var PatientClient = class extends BaseServiceClient {
3418
3480
  body: StediRawX12EligibilityRequestToJSON(request)
3419
3481
  });
3420
3482
  }
3483
+ /** Check reported benefits. Persist this exact request ID/body for retries, including HTTP 202. */
3484
+ async checkInsuranceBenefits(request) {
3485
+ return CheckInsuranceBenefitsResponseFromJSON(await this.send("POST", "/insurance/benefits/check", {
3486
+ body: CheckInsuranceBenefitsRequestToJSON(request)
3487
+ }));
3488
+ }
3421
3489
  /** List Stedi claims linked to the authenticated patient's FHIR Claim records. */
3422
3490
  async listInsuranceClaims(query) {
3423
3491
  const response = await this.send("GET", "/insurance/claims", { query });
@@ -3751,7 +3819,8 @@ var ProviderClient = class extends BaseServiceClient {
3751
3819
  }
3752
3820
  /**
3753
3821
  * The queue (GET /encounters/queue): the newest 10 encounters in the tenant that no provider has taken, newest created
3754
- * first, each with a minimal patient summary. Use the item's `fhir_id` with claimEncounter.
3822
+ * first, each with a minimal patient summary and `reported_symptoms` (what the patient reported, cut to 300 characters).
3823
+ * Use the item's `fhir_id` with claimEncounter.
3755
3824
  */
3756
3825
  getEncounterQueue() {
3757
3826
  return this.send("GET", "/encounters/queue", {});
@@ -3791,7 +3860,10 @@ var ProviderClient = class extends BaseServiceClient {
3791
3860
  getEncounter(encounterId) {
3792
3861
  return this.send("GET", "/encounters/{encounter_id}", { pathParams: { encounter_id: encounterId } });
3793
3862
  }
3794
- /** Update the clinical note and assessment for one encounter. */
3863
+ /**
3864
+ * Update the clinical note and assessment for one encounter. This saves the provider's own note (`provider_notes` on the
3865
+ * encounter) and mirrors it to a linked EHR; the patient's `reported_symptoms` / `notes` are never changed.
3866
+ */
3795
3867
  updateEncounterClinicalNote(encounterId, request) {
3796
3868
  return this.send("PATCH", "/encounters/{encounter_id}/clinical-note", {
3797
3869
  pathParams: { encounter_id: encounterId },
@@ -3898,7 +3970,10 @@ var ProviderClient = class extends BaseServiceClient {
3898
3970
  body: request != null ? request : {}
3899
3971
  });
3900
3972
  }
3901
- /** Get a patient's consolidated health record (provider tenant scope). */
3973
+ /**
3974
+ * Get a patient's consolidated health record (provider tenant scope). Each of `intake_submissions` carries what the patient
3975
+ * submitted: `sections` and `content` (the records it created, grouped like the record's own sections).
3976
+ */
3902
3977
  getPatientRecord(patientId) {
3903
3978
  return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
3904
3979
  }
@@ -14,6 +14,7 @@
14
14
  - [`cancelTestOrder`](../operations/patient.cancelTestOrder.md) — Cancel a diagnostic test order
15
15
  - [`checkEncounter`](../operations/patient.checkEncounter.md) — Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in
16
16
  - [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
17
+ - [`checkInsuranceBenefits`](../operations/patient.checkPatientInsuranceBenefits.md) — Check reported insurance benefits
17
18
  - [`checkInsuranceEligibility`](../operations/patient.checkPatientInsuranceEligibility.md) — Check insurance eligibility and benefits
18
19
  - [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
19
20
  - [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:e95a173c50b6a889818e2a0f518338dd91a28023a4daa1c4d0a9b1b50f223490",
2
+ "docsDataContentDigest": "sha256:ad1609cfb5b80159a75b462ee589f7f3a637bc80aaa3bf2d3275f4382182f033",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -455,6 +455,8 @@
455
455
  "models/CheckEncounterResponse.md",
456
456
  "models/CheckInEncounterRequest.md",
457
457
  "models/CheckInEncounterResponse.md",
458
+ "models/CheckInsuranceBenefitsRequest.md",
459
+ "models/CheckInsuranceBenefitsResponse.md",
458
460
  "models/ClaimEncounterResponse.md",
459
461
  "models/ClinicalObservation.md",
460
462
  "models/CmsGetCountyFipsRequest.md",
@@ -1231,6 +1233,7 @@
1231
1233
  "models/InitHealthRecordImportRequest.md",
1232
1234
  "models/InitHealthRecordImportResponse.md",
1233
1235
  "models/Insurance.md",
1236
+ "models/InsuranceBenefit.md",
1234
1237
  "models/InsurancePriority.md",
1235
1238
  "models/IntakeOperationError.md",
1236
1239
  "models/IntakeOperationResponse.md",
@@ -1463,6 +1466,8 @@
1463
1466
  "models/ProviderHomeSummaryResponse.md",
1464
1467
  "models/ProviderIdentifier.md",
1465
1468
  "models/ProviderIdentifierType.md",
1469
+ "models/ProviderIntakeContent.md",
1470
+ "models/ProviderIntakeSubmission.md",
1466
1471
  "models/ProviderLanguage.md",
1467
1472
  "models/ProviderLocation.md",
1468
1473
  "models/ProviderLocationAddressRequest.md",
@@ -3142,6 +3147,7 @@
3142
3147
  "operations/patient.cancelTestOrder.md",
3143
3148
  "operations/patient.checkEncounter.md",
3144
3149
  "operations/patient.checkInEncounter.md",
3150
+ "operations/patient.checkPatientInsuranceBenefits.md",
3145
3151
  "operations/patient.checkPatientInsuranceEligibility.md",
3146
3152
  "operations/patient.commsGetState.md",
3147
3153
  "operations/patient.commsGetUnreadCount.md",
@@ -3315,7 +3321,7 @@
3315
3321
  "operations/vitals.recordVitals.md"
3316
3322
  ],
3317
3323
  "language": "nodejs",
3318
- "modelCount": 2185,
3319
- "operationCount": 1073,
3324
+ "modelCount": 2190,
3325
+ "operationCount": 1074,
3320
3326
  "schemaVersion": 1
3321
3327
  }
@@ -904,6 +904,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
904
904
  - [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
905
905
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
906
906
  - [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
907
+ - [Check reported insurance benefits](../operations/patient.checkPatientInsuranceBenefits.md)
907
908
  - [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
908
909
  - [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
909
910
  - [Get unread message count](../operations/patient.commsGetUnreadCount.md)
package/docs/index.md CHANGED
@@ -912,6 +912,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
912
912
  - [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
913
913
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
914
914
  - [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
915
+ - [Check reported insurance benefits](operations/patient.checkPatientInsuranceBenefits.md) (`patient.checkPatientInsuranceBenefits`)
915
916
  - [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
916
917
  - [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
917
918
  - [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
@@ -23,7 +23,7 @@ Type: `object`
23
23
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
24
24
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
25
25
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
26
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
26
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
27
27
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
28
28
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
29
29
  | `openloop_encounter_status` | `string|null` | No | | | | Yes | `linked` when the OpenLoop appointment and encounter were linked successfully. |
@@ -0,0 +1,19 @@
1
+ # CheckInsuranceBenefitsRequest
2
+
3
+ Model ID: `CheckInsuranceBenefitsRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `request_id` | `string` | Yes | uuid | | | No | Stable ID for replay of this exact check; never automatically change on retry. |
14
+ | `service_date` | `string|null` | No | | | | Yes | ISO date. Omit for the payer's current date, as Stedi recommends. |
15
+ | `service_type_code` | `string` | Yes | | | | No | Requested X12 STC; not a product or procedure ID. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,28 @@
1
+ # CheckInsuranceBenefitsResponse
2
+
3
+ Model ID: `CheckInsuranceBenefitsResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `benefits` | array of [`InsuranceBenefit`](./InsuranceBenefit.md) | No | | | | No | |
14
+ | `check_id` | `string` | Yes | uuid | | | No | |
15
+ | `checked_at` | `string` | Yes | date-time | | | No | |
16
+ | `coverage_id` | `string|null` | No | | | | Yes | |
17
+ | `endpoint_version` | `string` | No | | | `"2026-06-01"` | No | |
18
+ | `interpretation` | `string` | No | | | `"reported_benefits_not_final_price"` | No | |
19
+ | `network_determination` | `string` | No | | | `"unknown"` | No | |
20
+ | `reason` | `string` | Yes | | | | No | |
21
+ | `service_date` | `string|null` | No | | | | Yes | |
22
+ | `service_type_code` | `string` | Yes | | | | No | |
23
+ | `source` | `string` | No | | | `"stedi"` | No | |
24
+ | `status` | `string` | Yes | | completed, pending, unavailable | | No | |
25
+
26
+ ## Example
27
+
28
+ None declared in canonical OpenAPI.
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -0,0 +1,27 @@
1
+ # InsuranceBenefit
2
+
3
+ Model ID: `InsuranceBenefit`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `additional_conditions` | `boolean` | No | | | `false` | No | Payer conditions need review; free-form payer text is not exposed. |
14
+ | `amount` | `string|null` | No | | | | Yes | Payer-reported monetary amount; null is unknown, not zero. |
15
+ | `benefit_end` | `string|null` | No | | | | Yes | |
16
+ | `benefit_start` | `string|null` | No | | | | Yes | |
17
+ | `benefit_type` | `string` | Yes | | copay, coinsurance, deductible, out_of_pocket | | No | |
18
+ | `coinsurance_fraction` | `string|null` | No | | | | Yes | Decimal fraction: 0.2 means 20%, not 0.2%. |
19
+ | `coverage_level` | `string` | No | | CHILDREN_ONLY, DEPENDENTS_ONLY, EMPLOYEE_AND_CHILDREN, EMPLOYEE_ONLY, EMPLOYEE_AND_SPOUSE, FAMILY, INDIVIDUAL, SPOUSE_AND_CHILDREN, SPOUSE_ONLY, UNKNOWN | `"UNKNOWN"` | No | |
20
+ | `network` | `string` | No | | IN_NETWORK, OUT_OF_NETWORK, IN_AND_OUT_OF_NETWORK, UNKNOWN | `"UNKNOWN"` | No | |
21
+ | `plan_index` | `integer` | Yes | | | | No | Keeps benefit entries from different returned plans separate. |
22
+ | `service_type_code` | `string` | Yes | | | | No | |
23
+ | `time_period` | `string` | No | | HOUR, DAY, 24_HOURS, YEARS, SERVICE_YEAR, CALENDAR_YEAR, YEAR_TO_DATE, CONTRACT, EPISODE, VISIT, OUTLIER, REMAINING, EXCEEDED, NOT_EXCEEDED, LIFETIME, LIFETIME_REMAINING, MONTH, WEEK, ADMISSION, UNKNOWN | `"UNKNOWN"` | No | |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`provider.EncounterLocation`](./provider.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -32,8 +32,10 @@ Type: `object`
32
32
  | `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
33
33
  | `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
34
34
  | `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
35
+ | `provider_notes` | `string|null` | No | | | | Yes | The provider's own clinical note, written with PATCH /encounters/{id}/clinical-note. Kept apart from the patient-reported text and not shown by the patient, EHR or field-agent APIs. Notes a provider wrote before this field existed are in `notes`, not here. |
35
36
  | `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
36
37
  | `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
38
+ | `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit: the symptom report and intake summaries collected in the patient app. Same text as `notes`, named for what it is. Null when the patient reported nothing. Never changed by a provider's clinical note. |
37
39
  | `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
38
40
  | `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
39
41
  | `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
@@ -0,0 +1,25 @@
1
+ # ProviderIntakeContent
2
+
3
+ Model ID: `ProviderIntakeContent`
4
+
5
+ The records an intake submission created, grouped like the health record's own sections.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergies` | array of [`provider.Allergy`](./provider.Allergy.md) | No | | | | No | |
14
+ | `conditions` | array of [`provider.Problem`](./provider.Problem.md) | No | | | | No | |
15
+ | `family_history` | array of [`provider.FamilyHistoryEntry`](./provider.FamilyHistoryEntry.md) | No | | | | No | |
16
+ | `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
17
+ | `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
18
+ | `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
19
+ | `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
20
+ | `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
21
+ | `social_history` | array of [`SocialHistory`](./SocialHistory.md) | No | | | | No | |
22
+
23
+ ## Example
24
+
25
+ None declared in canonical OpenAPI.
@@ -0,0 +1,29 @@
1
+ # ProviderIntakeSubmission
2
+
3
+ Model ID: `ProviderIntakeSubmission`
4
+
5
+ An intake the patient submitted, with what they submitted.
6
+
7
+ The delivery metadata is the patient intake response. `content` holds the submitted answers as the health record's own
8
+ sections (allergies, conditions, medications, immunizations, family_history, social_history, procedures, ...), because
9
+ intake answers are stored as FHIR records and the submissions table keeps metadata only.
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `content` | [`ProviderIntakeContent`](./ProviderIntakeContent.md) | No | | | | No | The records this submission created, grouped by health-record section, in the record's domain shape. |
18
+ | `content_complete` | `boolean` | No | | | `true` | No | False when some records this submission created could not be found in the record (for example a partial save), so `content` is not everything submitted. |
19
+ | `created_at` | `string` | Yes | date-time | | | No | |
20
+ | `invalid_entries` | `object|null` | No | | | | Yes | |
21
+ | `sections` | `array` | No | | | | No | The intake sections this submission carried, for example allergies or problems. |
22
+ | `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
23
+ | `submission_id` | `string` | Yes | uuid | | | No | |
24
+ | `unknown_fields` | `array|null` | No | | | | Yes | |
25
+ | `vendors` | `object` | Yes | | | | No | |
26
+
27
+ ## Example
28
+
29
+ None declared in canonical OpenAPI.
@@ -19,7 +19,7 @@ Type: `object`
19
19
  | `functional_status` | array of [`FunctionalStatus`](./FunctionalStatus.md) | No | | | | No | |
20
20
  | `gyn_history` | array of [`provider.GynHistory`](./provider.GynHistory.md) | No | | | | No | |
21
21
  | `immunizations` | array of [`provider.Immunization`](./provider.Immunization.md) | No | | | | No | |
22
- | `intake_submissions` | array of [`PatientIntakeResponse`](./PatientIntakeResponse.md) | No | | | | No | |
22
+ | `intake_submissions` | array of [`ProviderIntakeSubmission`](./ProviderIntakeSubmission.md) | No | | | | No | |
23
23
  | `medications` | array of [`provider.Medication`](./provider.Medication.md) | No | | | | No | |
24
24
  | `perinatal_history` | array of [`provider.PerinatalHistory`](./provider.PerinatalHistory.md) | No | | | | No | |
25
25
  | `procedures` | array of [`provider.Procedure`](./provider.Procedure.md) | No | | | | No | |
@@ -19,6 +19,7 @@ Type: `object`
19
19
  | `priority_display` | `string|null` | No | | | | Yes | Priority text, when available. |
20
20
  | `reason_code` | `string|null` | No | | | | Yes | Reason-for-visit code, when coded. |
21
21
  | `reason_display` | `string|null` | No | | | | Yes | Reason-for-visit text, when available. |
22
+ | `reported_symptoms` | `string|null` | No | | | | Yes | What the patient reported for this visit, cut to at most 300 characters and ending in an ellipsis when longer. Null when the patient reported nothing. The full text comes with the encounter once taken. |
22
23
  | `status` | `string` | Yes | | | | No | Encounter status, for example planned, arrived or triaged. |
23
24
  | `type_code` | `string|null` | No | | | | Yes | SNOMED CT encounter type code, when coded. |
24
25
  | `type_display` | `string|null` | No | | | | Yes | Encounter type text, when available. |
@@ -4,7 +4,8 @@ Model ID: `UpdateEncounterClinicalNoteRequest`
4
4
 
5
5
  FHIR notes and/or clinical assessment for one encounter.
6
6
 
7
- The FHIR Encounter stores the submitted content in its notes extension.
7
+ The FHIR Encounter stores the submitted content in its own provider-notes extension (`provider_notes`); the
8
+ patient-reported `notes` are never changed.
8
9
  When the encounter is linked to the configured EHR, ``notes`` is written
9
10
  to the EHR SOAP subjective field and ``assessment`` to its SOAP assessment
10
11
  field. At least one field must be supplied; the handler enforces that
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -405,6 +405,8 @@
405
405
  - [CheckEncounterResponse](CheckEncounterResponse.md)
406
406
  - [CheckInEncounterRequest](CheckInEncounterRequest.md)
407
407
  - [CheckInEncounterResponse](CheckInEncounterResponse.md)
408
+ - [CheckInsuranceBenefitsRequest](CheckInsuranceBenefitsRequest.md)
409
+ - [CheckInsuranceBenefitsResponse](CheckInsuranceBenefitsResponse.md)
408
410
  - [ClaimEncounterResponse](ClaimEncounterResponse.md)
409
411
  - [ClinicalObservation](ClinicalObservation.md)
410
412
  - [CMSCounty](CMSCounty.md)
@@ -1233,6 +1235,7 @@
1233
1235
  - [InitHealthRecordImportRequest](InitHealthRecordImportRequest.md)
1234
1236
  - [InitHealthRecordImportResponse](InitHealthRecordImportResponse.md)
1235
1237
  - [Insurance](Insurance.md)
1238
+ - [InsuranceBenefit](InsuranceBenefit.md)
1236
1239
  - [InsurancePriority](InsurancePriority.md)
1237
1240
  - [IntakeOperationError](IntakeOperationError.md)
1238
1241
  - [IntakeOperationResponse](IntakeOperationResponse.md)
@@ -1574,6 +1577,8 @@
1574
1577
  - [ProviderHomeSummaryResponse](ProviderHomeSummaryResponse.md)
1575
1578
  - [ProviderIdentifier](ProviderIdentifier.md)
1576
1579
  - [ProviderIdentifierType](ProviderIdentifierType.md)
1580
+ - [ProviderIntakeContent](ProviderIntakeContent.md)
1581
+ - [ProviderIntakeSubmission](ProviderIntakeSubmission.md)
1577
1582
  - [ProviderLanguage](ProviderLanguage.md)
1578
1583
  - [ProviderLocation](ProviderLocation.md)
1579
1584
  - [ProviderLocationAddressRequest](ProviderLocationAddressRequest.md)
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
@@ -22,7 +22,7 @@ Type: `object`
22
22
  | `hospitalization` | [`provider.EncounterHospitalization`](./provider.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`provider.EncounterLocation`](./provider.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
- | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
25
+ | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes: what the patient reported (symptom report and intake summaries collected in the patient app, as 'reported symptoms') and notes synced from an external EHR. A provider's own clinical note is kept separately (see provider_notes) and never replaces this text. |
26
26
  | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
27
  | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
28
28
  | `participants` | array of [`provider.EncounterParticipant`](./provider.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |