@healthcloudai/hc-sdk 3.5.2 → 3.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +153 -17
- package/dist/index.d.cts +1618 -182
- package/dist/index.d.ts +1618 -182
- package/dist/index.js +153 -17
- package/docs/clients/AppointmentsClient.md +1 -1
- package/docs/clients/PatientClient.md +4 -1
- package/docs/clients/ProviderClient.md +1 -0
- package/docs/docs-manifest.json +28 -5
- package/docs/examples/index.md +6 -2
- package/docs/index.md +6 -2
- package/docs/models/AddPatientIntakeRequest.md +24 -0
- package/docs/models/AddPatientIntakeResponse.md +17 -0
- package/docs/models/AdvanceDirective.md +31 -0
- package/docs/models/AdvanceDirectiveType.md +15 -0
- package/docs/models/AthenaListAppointmentsRequest.md +1 -1
- package/docs/models/CarequalityRetrieveDocumentsRequest.md +1 -1
- package/docs/models/DirectiveScope.md +15 -0
- package/docs/models/DirectiveStatus.md +15 -0
- package/docs/models/GetAppointmentTelehealthLinkResponse.md +1 -1
- package/docs/models/GetHealthRecordResponse.md +2 -2
- package/docs/models/Immunization.md +40 -0
- package/docs/models/ImmunizationRoute.md +15 -0
- package/docs/models/ImmunizationStatus.md +15 -0
- package/docs/models/ListDirectivesResponse.md +1 -1
- package/docs/models/ListImmunizationsResponse.md +1 -1
- package/docs/models/ListProceduresResponse.md +1 -1
- package/docs/models/OpenAIEmbedRequest.md +1 -1
- package/docs/models/Procedure.md +37 -0
- package/docs/models/ProcedureLaterality.md +15 -0
- package/docs/models/ProcedureStatus.md +15 -0
- package/docs/models/SendGridSendEmailRequest.md +1 -1
- package/docs/models/StediClaimsResponse.md +18 -0
- package/docs/models/StediEligibilityBatchItem.md +22 -0
- package/docs/models/StediEligibilityBatchRequest.md +17 -0
- package/docs/models/StediEligibilityBatchResponse.md +17 -0
- package/docs/models/StediEligibilityCheckRequest.md +21 -0
- package/docs/models/StediRawX12EligibilityRequest.md +17 -0
- package/docs/models/VaccinationSite.md +15 -0
- package/docs/models/ehr.ImmunizationReaction.md +20 -0
- package/docs/models/ehr.ListMedicationsResponse.md +1 -1
- package/docs/models/index.md +20 -1
- package/docs/operations/appointments.getTelehealthLink.md +4 -4
- package/docs/operations/connectors.athenaListAppointments.md +1 -3
- package/docs/operations/connectors.carequalityRetrieveDocuments.md +11 -7
- package/docs/operations/connectors.openaiEmbed.md +3 -7
- package/docs/operations/connectors.sendgridSend.md +3 -7
- package/docs/operations/diagnostics.lookupTestByGs1.md +11 -3
- package/docs/operations/ehr.listMedications.md +2 -2
- package/docs/operations/patient.addPatientIntake.md +138 -0
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +170 -0
- package/docs/operations/patient.listMedications.md +2 -2
- package/docs/operations/patient.listPatientInsuranceClaims.md +181 -0
- package/docs/operations/patient.submitPatientRawX12Eligibility.md +162 -0
- package/docs/operations/provider.submitInsuranceEligibilityBatch.md +164 -0
- package/package.json +1 -1
- package/docs/models/CheckEligibilityRequest.md +0 -23
- package/docs/operations/patient.checkEligibility.md +0 -147
package/dist/index.js
CHANGED
|
@@ -909,22 +909,47 @@ var MCPClient = class extends BaseServiceClient {
|
|
|
909
909
|
}
|
|
910
910
|
};
|
|
911
911
|
|
|
912
|
-
// src/models/openapi-generated/patient/models/
|
|
913
|
-
function
|
|
914
|
-
return
|
|
912
|
+
// src/models/openapi-generated/patient/models/StediClaimsResponse.ts
|
|
913
|
+
function StediClaimsResponseFromJSON(json) {
|
|
914
|
+
return StediClaimsResponseFromJSONTyped(json, false);
|
|
915
915
|
}
|
|
916
|
-
function
|
|
916
|
+
function StediClaimsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
917
|
+
if (json == null) {
|
|
918
|
+
return json;
|
|
919
|
+
}
|
|
920
|
+
return {
|
|
921
|
+
"items": json["items"] == null ? void 0 : json["items"],
|
|
922
|
+
"next_page_token": json["nextPageToken"] === void 0 ? void 0 : json["nextPageToken"] === null ? null : json["nextPageToken"]
|
|
923
|
+
};
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
// src/models/openapi-generated/patient/models/StediEligibilityCheckRequest.ts
|
|
927
|
+
function StediEligibilityCheckRequestToJSON(json) {
|
|
928
|
+
return StediEligibilityCheckRequestToJSONTyped(json, false);
|
|
929
|
+
}
|
|
930
|
+
function StediEligibilityCheckRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
917
931
|
if (value == null) {
|
|
918
932
|
return value;
|
|
919
933
|
}
|
|
920
934
|
return {
|
|
921
|
-
"
|
|
922
|
-
"
|
|
923
|
-
"last_name": value["last_name"],
|
|
924
|
-
"member_id": value["member_id"],
|
|
925
|
-
"npi": value["npi"],
|
|
935
|
+
"dependent": value["dependent"],
|
|
936
|
+
"encounter": value["encounter"],
|
|
926
937
|
"payer_id": value["payer_id"],
|
|
927
|
-
"
|
|
938
|
+
"provider": value["provider"],
|
|
939
|
+
"subscriber": value["subscriber"]
|
|
940
|
+
};
|
|
941
|
+
}
|
|
942
|
+
|
|
943
|
+
// src/models/openapi-generated/patient/models/StediRawX12EligibilityRequest.ts
|
|
944
|
+
function StediRawX12EligibilityRequestToJSON(json) {
|
|
945
|
+
return StediRawX12EligibilityRequestToJSONTyped(json, false);
|
|
946
|
+
}
|
|
947
|
+
function StediRawX12EligibilityRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
948
|
+
if (value == null) {
|
|
949
|
+
return value;
|
|
950
|
+
}
|
|
951
|
+
return {
|
|
952
|
+
"x12": value["x12"]
|
|
928
953
|
};
|
|
929
954
|
}
|
|
930
955
|
|
|
@@ -1130,6 +1155,7 @@ function IntakeSurgeryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1130
1155
|
return value;
|
|
1131
1156
|
}
|
|
1132
1157
|
return {
|
|
1158
|
+
...value,
|
|
1133
1159
|
"anesthesia_type": value["anesthesia_type"],
|
|
1134
1160
|
"body_sites": value["body_sites"],
|
|
1135
1161
|
"complications": value["complications"],
|
|
@@ -1185,6 +1211,7 @@ function IntakeFamilyHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1185
1211
|
return value;
|
|
1186
1212
|
}
|
|
1187
1213
|
return {
|
|
1214
|
+
...value,
|
|
1188
1215
|
"age_at_death": value["age_at_death"],
|
|
1189
1216
|
"biological": value["biological"],
|
|
1190
1217
|
"born_date": value["born_date"] == null ? value["born_date"] : value["born_date"].toISOString().substring(0, 10),
|
|
@@ -1209,6 +1236,7 @@ function PerinatalHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1209
1236
|
return value;
|
|
1210
1237
|
}
|
|
1211
1238
|
return {
|
|
1239
|
+
...value,
|
|
1212
1240
|
"delivery_date": value["delivery_date"] == null ? value["delivery_date"] : value["delivery_date"].toISOString().substring(0, 10),
|
|
1213
1241
|
"delivery_method": value["delivery_method"],
|
|
1214
1242
|
"gestational_age_weeks": value["gestational_age_weeks"],
|
|
@@ -1229,6 +1257,7 @@ function GynHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1229
1257
|
return value;
|
|
1230
1258
|
}
|
|
1231
1259
|
return {
|
|
1260
|
+
...value,
|
|
1232
1261
|
"cervical_screening_history": value["cervical_screening_history"],
|
|
1233
1262
|
"contraception": value["contraception"],
|
|
1234
1263
|
"last_menstrual_period": value["last_menstrual_period"] == null ? value["last_menstrual_period"] : value["last_menstrual_period"].toISOString().substring(0, 10),
|
|
@@ -1347,6 +1376,7 @@ function IntakeSocialHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1347
1376
|
return value;
|
|
1348
1377
|
}
|
|
1349
1378
|
return {
|
|
1379
|
+
...value,
|
|
1350
1380
|
"alcohol": AlcoholUseToJSON(value["alcohol"]),
|
|
1351
1381
|
"contraception": value["contraception"],
|
|
1352
1382
|
"diet_category": DietCategoryToJSON(value["diet_category"]),
|
|
@@ -1388,6 +1418,7 @@ function IntakeCancerTreatmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1388
1418
|
return value;
|
|
1389
1419
|
}
|
|
1390
1420
|
return {
|
|
1421
|
+
...value,
|
|
1391
1422
|
"description": value["description"],
|
|
1392
1423
|
"end_date": value["end_date"] == null ? value["end_date"] : value["end_date"].toISOString().substring(0, 10),
|
|
1393
1424
|
"facility": value["facility"],
|
|
@@ -1436,6 +1467,7 @@ function IntakeCancerCaseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1436
1467
|
return value;
|
|
1437
1468
|
}
|
|
1438
1469
|
return {
|
|
1470
|
+
...value,
|
|
1439
1471
|
"biomarkers": value["biomarkers"],
|
|
1440
1472
|
"cancer_type": value["cancer_type"],
|
|
1441
1473
|
"diagnosis_date": value["diagnosis_date"] == null ? value["diagnosis_date"] : value["diagnosis_date"].toISOString().substring(0, 10),
|
|
@@ -1467,6 +1499,7 @@ function IntakeMedicationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1467
1499
|
return value;
|
|
1468
1500
|
}
|
|
1469
1501
|
return {
|
|
1502
|
+
...value,
|
|
1470
1503
|
"authored_on": value["authored_on"] == null ? value["authored_on"] : value["authored_on"].toISOString().substring(0, 10),
|
|
1471
1504
|
"brand_name": value["brand_name"],
|
|
1472
1505
|
"discontinued_reason": value["discontinued_reason"],
|
|
@@ -1554,6 +1587,7 @@ function IntakeAllergyToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1554
1587
|
return value;
|
|
1555
1588
|
}
|
|
1556
1589
|
return {
|
|
1590
|
+
...value,
|
|
1557
1591
|
"allergen": value["allergen"],
|
|
1558
1592
|
"allergen_code": CodedConceptToJSON(value["allergen_code"]),
|
|
1559
1593
|
"asserted_date": value["asserted_date"] == null ? value["asserted_date"] : value["asserted_date"].toISOString().substring(0, 10),
|
|
@@ -1592,6 +1626,7 @@ function IntakeProblemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1592
1626
|
return value;
|
|
1593
1627
|
}
|
|
1594
1628
|
return {
|
|
1629
|
+
...value,
|
|
1595
1630
|
"asserted_date": value["asserted_date"] == null ? value["asserted_date"] : value["asserted_date"].toISOString().substring(0, 10),
|
|
1596
1631
|
"body_site": value["body_site"],
|
|
1597
1632
|
"categories": value["categories"] == null ? void 0 : value["categories"].map(ProblemCategoryToJSON),
|
|
@@ -1649,6 +1684,7 @@ function IntakeVaccineToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1649
1684
|
return value;
|
|
1650
1685
|
}
|
|
1651
1686
|
return {
|
|
1687
|
+
...value,
|
|
1652
1688
|
"administered_by": value["administered_by"],
|
|
1653
1689
|
"administered_date": value["administered_date"] == null ? value["administered_date"] : value["administered_date"].toISOString().substring(0, 10),
|
|
1654
1690
|
"administered_datetime": value["administered_datetime"] == null ? value["administered_datetime"] : value["administered_datetime"].toISOString(),
|
|
@@ -2007,8 +2043,51 @@ function PatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
2007
2043
|
};
|
|
2008
2044
|
}
|
|
2009
2045
|
|
|
2046
|
+
// src/models/openapi-generated/patient/models/Summary.ts
|
|
2047
|
+
function SummaryToJSON(json) {
|
|
2048
|
+
return SummaryToJSONTyped(json, false);
|
|
2049
|
+
}
|
|
2050
|
+
function SummaryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2051
|
+
return value;
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
// src/models/openapi-generated/patient/models/AddPatientIntakeRequest.ts
|
|
2055
|
+
function AddPatientIntakeRequestToJSON(json) {
|
|
2056
|
+
return AddPatientIntakeRequestToJSONTyped(json, false);
|
|
2057
|
+
}
|
|
2058
|
+
function AddPatientIntakeRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2059
|
+
if (value == null) {
|
|
2060
|
+
return value;
|
|
2061
|
+
}
|
|
2062
|
+
return {
|
|
2063
|
+
"patient_id": value["patient_id"],
|
|
2064
|
+
"section": value["section"],
|
|
2065
|
+
"summary": SummaryToJSON(value["summary"])
|
|
2066
|
+
};
|
|
2067
|
+
}
|
|
2068
|
+
|
|
2069
|
+
// src/models/openapi-generated/patient/models/AddPatientIntakeResponse.ts
|
|
2070
|
+
function AddPatientIntakeResponseFromJSON(json) {
|
|
2071
|
+
return AddPatientIntakeResponseFromJSONTyped(json, false);
|
|
2072
|
+
}
|
|
2073
|
+
function AddPatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2074
|
+
if (json == null) {
|
|
2075
|
+
return json;
|
|
2076
|
+
}
|
|
2077
|
+
return {
|
|
2078
|
+
"error_messages": json["error_messages"] == null ? void 0 : json["error_messages"]
|
|
2079
|
+
};
|
|
2080
|
+
}
|
|
2081
|
+
|
|
2010
2082
|
// src/clients/PatientClient.ts
|
|
2011
2083
|
var PatientClient = class extends BaseServiceClient {
|
|
2084
|
+
/** Add one agent-collected intake section and return actionable validation errors. */
|
|
2085
|
+
async addToIntake(patientId, section, summary) {
|
|
2086
|
+
const response = await this.send("POST", "/healthrecords/intake/add", {
|
|
2087
|
+
body: AddPatientIntakeRequestToJSON({ patient_id: patientId, section, summary })
|
|
2088
|
+
});
|
|
2089
|
+
return AddPatientIntakeResponseFromJSON(response);
|
|
2090
|
+
}
|
|
2012
2091
|
/** Add patient-reported history; each call creates a new server-identified submission. */
|
|
2013
2092
|
async submitPatientIntake(request) {
|
|
2014
2093
|
const response = await this.send("POST", "/patients/health-record/intake", {
|
|
@@ -2407,17 +2486,23 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2407
2486
|
body: request
|
|
2408
2487
|
});
|
|
2409
2488
|
}
|
|
2410
|
-
|
|
2411
|
-
// `InsuranceEligibilityResponse` for why it stays a raw `JsonValue`.
|
|
2412
|
-
//
|
|
2413
|
-
// `CheckEligibilityRequest.date_of_birth` is generated as a `Date` (OpenAPI
|
|
2414
|
-
// `date` format); `...ToJSON` is the generated serializer that renders it
|
|
2415
|
-
// back to the `YYYY-MM-DD` wire format instead of a full ISO datetime.
|
|
2489
|
+
/** Check the authenticated patient's payer eligibility and benefits. */
|
|
2416
2490
|
checkInsuranceEligibility(request) {
|
|
2417
2491
|
return this.send("POST", "/insurance/eligibility", {
|
|
2418
|
-
body:
|
|
2492
|
+
body: StediEligibilityCheckRequestToJSON(request)
|
|
2493
|
+
});
|
|
2494
|
+
}
|
|
2495
|
+
/** Submit a raw X12 270 eligibility request for the authenticated patient. */
|
|
2496
|
+
submitRawX12InsuranceEligibility(request) {
|
|
2497
|
+
return this.send("POST", "/insurance/eligibility/x12", {
|
|
2498
|
+
body: StediRawX12EligibilityRequestToJSON(request)
|
|
2419
2499
|
});
|
|
2420
2500
|
}
|
|
2501
|
+
/** List Stedi claims linked to the authenticated patient's FHIR Claim records. */
|
|
2502
|
+
async listInsuranceClaims(query) {
|
|
2503
|
+
const response = await this.send("GET", "/insurance/claims", { query });
|
|
2504
|
+
return StediClaimsResponseFromJSON(response);
|
|
2505
|
+
}
|
|
2421
2506
|
// ── Assistant API — classify/ocr/chat are public (auth: false); the 3
|
|
2422
2507
|
// knowledge/action routes require a bearer token (default auth behaviour). ──
|
|
2423
2508
|
classifyVoiceCommand(request) {
|
|
@@ -2728,6 +2813,50 @@ var PersonClient = class extends BaseServiceClient {
|
|
|
2728
2813
|
}
|
|
2729
2814
|
};
|
|
2730
2815
|
|
|
2816
|
+
// src/models/openapi-generated/provider/models/StediEligibilityBatchItem.ts
|
|
2817
|
+
function StediEligibilityBatchItemToJSON(json) {
|
|
2818
|
+
return StediEligibilityBatchItemToJSONTyped(json, false);
|
|
2819
|
+
}
|
|
2820
|
+
function StediEligibilityBatchItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2821
|
+
if (value == null) {
|
|
2822
|
+
return value;
|
|
2823
|
+
}
|
|
2824
|
+
return {
|
|
2825
|
+
"dependent": value["dependent"],
|
|
2826
|
+
"encounter": value["encounter"],
|
|
2827
|
+
"provider": value["provider"],
|
|
2828
|
+
"submitter_transaction_identifier": value["submitter_transaction_identifier"],
|
|
2829
|
+
"subscriber": value["subscriber"],
|
|
2830
|
+
"trading_partner_service_id": value["trading_partner_service_id"]
|
|
2831
|
+
};
|
|
2832
|
+
}
|
|
2833
|
+
|
|
2834
|
+
// src/models/openapi-generated/provider/models/StediEligibilityBatchRequest.ts
|
|
2835
|
+
function StediEligibilityBatchRequestToJSON(json) {
|
|
2836
|
+
return StediEligibilityBatchRequestToJSONTyped(json, false);
|
|
2837
|
+
}
|
|
2838
|
+
function StediEligibilityBatchRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2839
|
+
if (value == null) {
|
|
2840
|
+
return value;
|
|
2841
|
+
}
|
|
2842
|
+
return {
|
|
2843
|
+
"items": value["items"].map(StediEligibilityBatchItemToJSON)
|
|
2844
|
+
};
|
|
2845
|
+
}
|
|
2846
|
+
|
|
2847
|
+
// src/models/openapi-generated/provider/models/StediEligibilityBatchResponse.ts
|
|
2848
|
+
function StediEligibilityBatchResponseFromJSON(json) {
|
|
2849
|
+
return StediEligibilityBatchResponseFromJSONTyped(json, false);
|
|
2850
|
+
}
|
|
2851
|
+
function StediEligibilityBatchResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2852
|
+
if (json == null) {
|
|
2853
|
+
return json;
|
|
2854
|
+
}
|
|
2855
|
+
return {
|
|
2856
|
+
"batch_id": json["batchId"]
|
|
2857
|
+
};
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2731
2860
|
// src/clients/ProviderClient.ts
|
|
2732
2861
|
var ProviderClient = class extends BaseServiceClient {
|
|
2733
2862
|
constructor(http, getTenantId = () => void 0) {
|
|
@@ -2737,6 +2866,13 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
2737
2866
|
connect() {
|
|
2738
2867
|
return this.connectService();
|
|
2739
2868
|
}
|
|
2869
|
+
/** Submit multiple insurance eligibility checks for asynchronous processing. */
|
|
2870
|
+
async submitInsuranceEligibilityBatch(request) {
|
|
2871
|
+
const response = await this.send("POST", "/insurance/eligibility/batch", {
|
|
2872
|
+
body: StediEligibilityBatchRequestToJSON(request)
|
|
2873
|
+
});
|
|
2874
|
+
return StediEligibilityBatchResponseFromJSON(response);
|
|
2875
|
+
}
|
|
2740
2876
|
// ─── Auth (public, no Bearer) ──────────────────────────────────────
|
|
2741
2877
|
register(request) {
|
|
2742
2878
|
return this.send("POST", "/auth/register", { body: withTenantId(request, this.getTenantId()), auth: false });
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
- [`cancel`](../operations/appointments.cancel.md) — Cancel an appointment
|
|
5
5
|
- [`connect`](../operations/appointments.connect.md) — Health check
|
|
6
6
|
- [`createSlot`](../operations/appointments.createSlot.md) — Create a new slot
|
|
7
|
-
- [`getTelehealthLink`](../operations/appointments.getTelehealthLink.md) — Get
|
|
7
|
+
- [`getTelehealthLink`](../operations/appointments.getTelehealthLink.md) — Get an authorized appointment's telehealth join link
|
|
8
8
|
- [`listPatientAppointments`](../operations/appointments.listPatientAppointments.md) — List patient appointments
|
|
9
9
|
- [`listSlots`](../operations/appointments.listSlots.md) — List available slots
|
|
10
10
|
- [`reschedule`](../operations/appointments.reschedule.md) — Reschedule an appointment
|
|
@@ -3,14 +3,15 @@
|
|
|
3
3
|
- [`saveDependent`](../operations/patient.addDependent.md) — Add a dependent
|
|
4
4
|
- [`createInsurance`](../operations/patient.addInsurance.md) — Add insurance coverage
|
|
5
5
|
- [`saveNotification`](../operations/patient.addNotification.md) — Add a notification
|
|
6
|
+
- [`addToIntake`](../operations/patient.addPatientIntake.md) — Add one structured patient intake section
|
|
6
7
|
- [`scanIdentityDocument`](../operations/patient.analyzeIdentityDocument.md) — OCR an identity document
|
|
7
8
|
- [`askAssistant`](../operations/patient.assistantChat.md) — Grounded assistant chat
|
|
8
9
|
- [`classifyVoiceCommand`](../operations/patient.assistantClassify.md) — Classify a voice command into an action code
|
|
9
10
|
- [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
|
|
10
11
|
- [`ocrInsuranceDocument`](../operations/patient.assistantOcrInsurance.md) — OCR an insurance card via vision LLM
|
|
11
|
-
- [`checkInsuranceEligibility`](../operations/patient.checkEligibility.md) — Check insurance eligibility
|
|
12
12
|
- [`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
|
|
13
13
|
- [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
|
|
14
|
+
- [`checkInsuranceEligibility`](../operations/patient.checkPatientInsuranceEligibility.md) — Check insurance eligibility and benefits
|
|
14
15
|
- [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
|
|
15
16
|
- [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
|
|
16
17
|
- [`listConversations`](../operations/patient.commsListConversations.md) — List conversations
|
|
@@ -62,12 +63,14 @@
|
|
|
62
63
|
- [`listKnowledge`](../operations/patient.listKnowledge.md) — List knowledge-base collections and entries
|
|
63
64
|
- [`listMedications`](../operations/patient.listMedications.md) — List medications
|
|
64
65
|
- [`listNotifications`](../operations/patient.listNotifications.md) — List notifications
|
|
66
|
+
- [`listInsuranceClaims`](../operations/patient.listPatientInsuranceClaims.md) — List claims for the authenticated patient
|
|
65
67
|
- [`nearestLocations`](../operations/patient.nearestLocations.md) — Find nearby healthcare locations
|
|
66
68
|
- [`getPhotoUploadUrl`](../operations/patient.photoUploadUrl.md) — Get a photo upload URL
|
|
67
69
|
- [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
|
|
68
70
|
- [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
|
|
69
71
|
- [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
|
|
70
72
|
- [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
|
|
73
|
+
- [`submitRawX12InsuranceEligibility`](../operations/patient.submitPatientRawX12Eligibility.md) — Submit a raw X12 270 eligibility request
|
|
71
74
|
- [`submitSummary`](../operations/patient.submitSummary.md) — Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections
|
|
72
75
|
- [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
|
|
73
76
|
- [`updateCommunicationConsent`](../operations/patient.updateCommunicationConsent.md) — Update SMS/phone contact-preference consent
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
- [`login`](../operations/provider.login.md) — Log in a practitioner
|
|
9
9
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
10
10
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
11
|
+
- [`submitInsuranceEligibilityBatch`](../operations/provider.submitInsuranceEligibilityBatch.md) — Submit multiple insurance eligibility checks
|
|
11
12
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
|
12
13
|
- [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
|
|
13
14
|
- [`uploadPhoto`](../operations/provider.uploadPhoto.md) — Upload a practitioner photo
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:aaa665826f96cc59f5727ad4bd0e98cbbac66bff472897354f945836b5c06d1a",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -60,8 +60,12 @@
|
|
|
60
60
|
"models/AddInsuranceRequest.md",
|
|
61
61
|
"models/AddInsuranceResponse.md",
|
|
62
62
|
"models/AddNotificationResponse.md",
|
|
63
|
+
"models/AddPatientIntakeRequest.md",
|
|
64
|
+
"models/AddPatientIntakeResponse.md",
|
|
63
65
|
"models/Address.md",
|
|
64
66
|
"models/AddressType.md",
|
|
67
|
+
"models/AdvanceDirective.md",
|
|
68
|
+
"models/AdvanceDirectiveType.md",
|
|
65
69
|
"models/AgentDashboardResponse.md",
|
|
66
70
|
"models/Allergy.md",
|
|
67
71
|
"models/AllergyCategory.md",
|
|
@@ -436,7 +440,6 @@
|
|
|
436
440
|
"models/CarequalityRetrieveDocumentsRequest.md",
|
|
437
441
|
"models/CarequalityRetrieveDocumentsResponse.md",
|
|
438
442
|
"models/ChatMessageRecord.md",
|
|
439
|
-
"models/CheckEligibilityRequest.md",
|
|
440
443
|
"models/CheckEncounterRequest.md",
|
|
441
444
|
"models/CheckEncounterResponse.md",
|
|
442
445
|
"models/CheckInEncounterRequest.md",
|
|
@@ -509,6 +512,8 @@
|
|
|
509
512
|
"models/DependentResponse.md",
|
|
510
513
|
"models/DiagnosticTest.md",
|
|
511
514
|
"models/DiagnosticTestRelationship.md",
|
|
515
|
+
"models/DirectiveScope.md",
|
|
516
|
+
"models/DirectiveStatus.md",
|
|
512
517
|
"models/DischargeDisposition.md",
|
|
513
518
|
"models/DocumentSummary.md",
|
|
514
519
|
"models/DocumentSummarySearchRequest.md",
|
|
@@ -1071,6 +1076,9 @@
|
|
|
1071
1076
|
"models/HealthieUpdateUserRequest.md",
|
|
1072
1077
|
"models/HealthieUpdateUserResponse.md",
|
|
1073
1078
|
"models/HeartRateVital.md",
|
|
1079
|
+
"models/Immunization.md",
|
|
1080
|
+
"models/ImmunizationRoute.md",
|
|
1081
|
+
"models/ImmunizationStatus.md",
|
|
1074
1082
|
"models/ImpiloAddress.md",
|
|
1075
1083
|
"models/ImpiloAlertConfig.md",
|
|
1076
1084
|
"models/ImpiloAlertConfiguration.md",
|
|
@@ -1362,6 +1370,9 @@
|
|
|
1362
1370
|
"models/ProblemClinicalStatus.md",
|
|
1363
1371
|
"models/ProblemSeverity.md",
|
|
1364
1372
|
"models/ProblemVerificationStatus.md",
|
|
1373
|
+
"models/Procedure.md",
|
|
1374
|
+
"models/ProcedureLaterality.md",
|
|
1375
|
+
"models/ProcedureStatus.md",
|
|
1365
1376
|
"models/ProviderAcceptedInsurance.md",
|
|
1366
1377
|
"models/ProviderContactPoint.md",
|
|
1367
1378
|
"models/ProviderEducationCredential.md",
|
|
@@ -1701,10 +1712,16 @@
|
|
|
1701
1712
|
"models/StediCheckClaimStatusRequest.md",
|
|
1702
1713
|
"models/StediCheckCoordinationOfBenefitsRequest.md",
|
|
1703
1714
|
"models/StediCheckEligibilityRequest.md",
|
|
1715
|
+
"models/StediClaimsResponse.md",
|
|
1704
1716
|
"models/StediDiscoverInsuranceRequest.md",
|
|
1717
|
+
"models/StediEligibilityBatchItem.md",
|
|
1718
|
+
"models/StediEligibilityBatchRequest.md",
|
|
1719
|
+
"models/StediEligibilityBatchResponse.md",
|
|
1720
|
+
"models/StediEligibilityCheckRequest.md",
|
|
1705
1721
|
"models/StediEligibilityCheckResponse.md",
|
|
1706
1722
|
"models/StediGet835EraReportRequest.md",
|
|
1707
1723
|
"models/StediGetInsuranceDiscoveryResultsRequest.md",
|
|
1724
|
+
"models/StediRawX12EligibilityRequest.md",
|
|
1708
1725
|
"models/StediSubmitClaimRequest.md",
|
|
1709
1726
|
"models/StediSubmitInstitutionalClaimRequest.md",
|
|
1710
1727
|
"models/StediSubmitProfessionalClaimRequest.md",
|
|
@@ -1783,6 +1800,7 @@
|
|
|
1783
1800
|
"models/UpsertInviteRequest.md",
|
|
1784
1801
|
"models/UpsertMessageRequest.md",
|
|
1785
1802
|
"models/UpsertPresenceRequest.md",
|
|
1803
|
+
"models/VaccinationSite.md",
|
|
1786
1804
|
"models/VectorCollection.md",
|
|
1787
1805
|
"models/VectorSearchDocumentsRequest.md",
|
|
1788
1806
|
"models/VectorSearchHit.md",
|
|
@@ -1937,6 +1955,7 @@
|
|
|
1937
1955
|
"models/ehr.CodedConcept.md",
|
|
1938
1956
|
"models/ehr.ConnectResponse.md",
|
|
1939
1957
|
"models/ehr.FamilyCondition.md",
|
|
1958
|
+
"models/ehr.ImmunizationReaction.md",
|
|
1940
1959
|
"models/ehr.ListDiagnosticsResponse.md",
|
|
1941
1960
|
"models/ehr.ListEncountersResponse.md",
|
|
1942
1961
|
"models/ehr.ListMedicationsResponse.md",
|
|
@@ -2937,14 +2956,15 @@
|
|
|
2937
2956
|
"operations/patient.addDependent.md",
|
|
2938
2957
|
"operations/patient.addInsurance.md",
|
|
2939
2958
|
"operations/patient.addNotification.md",
|
|
2959
|
+
"operations/patient.addPatientIntake.md",
|
|
2940
2960
|
"operations/patient.analyzeIdentityDocument.md",
|
|
2941
2961
|
"operations/patient.assistantChat.md",
|
|
2942
2962
|
"operations/patient.assistantClassify.md",
|
|
2943
2963
|
"operations/patient.assistantOcr.md",
|
|
2944
2964
|
"operations/patient.assistantOcrInsurance.md",
|
|
2945
|
-
"operations/patient.checkEligibility.md",
|
|
2946
2965
|
"operations/patient.checkEncounter.md",
|
|
2947
2966
|
"operations/patient.checkInEncounter.md",
|
|
2967
|
+
"operations/patient.checkPatientInsuranceEligibility.md",
|
|
2948
2968
|
"operations/patient.commsGetState.md",
|
|
2949
2969
|
"operations/patient.commsGetUnreadCount.md",
|
|
2950
2970
|
"operations/patient.commsListConversations.md",
|
|
@@ -2997,6 +3017,7 @@
|
|
|
2997
3017
|
"operations/patient.listKnowledge.md",
|
|
2998
3018
|
"operations/patient.listMedications.md",
|
|
2999
3019
|
"operations/patient.listNotifications.md",
|
|
3020
|
+
"operations/patient.listPatientInsuranceClaims.md",
|
|
3000
3021
|
"operations/patient.login.md",
|
|
3001
3022
|
"operations/patient.nearestLocations.md",
|
|
3002
3023
|
"operations/patient.photoUploadUrl.md",
|
|
@@ -3008,6 +3029,7 @@
|
|
|
3008
3029
|
"operations/patient.setPreferredPharmacy.md",
|
|
3009
3030
|
"operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
|
|
3010
3031
|
"operations/patient.submitPatientIntake.md",
|
|
3032
|
+
"operations/patient.submitPatientRawX12Eligibility.md",
|
|
3011
3033
|
"operations/patient.submitSummary.md",
|
|
3012
3034
|
"operations/patient.updateAddress.md",
|
|
3013
3035
|
"operations/patient.updateCommunicationConsent.md",
|
|
@@ -3045,6 +3067,7 @@
|
|
|
3045
3067
|
"operations/provider.login.md",
|
|
3046
3068
|
"operations/provider.register.md",
|
|
3047
3069
|
"operations/provider.resetPassword.md",
|
|
3070
|
+
"operations/provider.submitInsuranceEligibilityBatch.md",
|
|
3048
3071
|
"operations/provider.updatePhone.md",
|
|
3049
3072
|
"operations/provider.updatePractitioner.md",
|
|
3050
3073
|
"operations/provider.uploadPhoto.md",
|
|
@@ -3061,7 +3084,7 @@
|
|
|
3061
3084
|
"operations/vitals.recordVitals.md"
|
|
3062
3085
|
],
|
|
3063
3086
|
"language": "nodejs",
|
|
3064
|
-
"modelCount":
|
|
3065
|
-
"operationCount":
|
|
3087
|
+
"modelCount": 2010,
|
|
3088
|
+
"operationCount": 1017,
|
|
3066
3089
|
"schemaVersion": 1
|
|
3067
3090
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -6,7 +6,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
6
6
|
- [Cancel an appointment](../operations/appointments.cancel.md)
|
|
7
7
|
- [Health check](../operations/appointments.connect.md)
|
|
8
8
|
- [Create a new slot](../operations/appointments.createSlot.md)
|
|
9
|
-
- [Get
|
|
9
|
+
- [Get an authorized appointment's telehealth join link](../operations/appointments.getTelehealthLink.md)
|
|
10
10
|
- [List patient appointments](../operations/appointments.listPatientAppointments.md)
|
|
11
11
|
- [List available slots](../operations/appointments.listSlots.md)
|
|
12
12
|
- [Reschedule an appointment](../operations/appointments.reschedule.md)
|
|
@@ -893,14 +893,15 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
893
893
|
- [Add a dependent](../operations/patient.addDependent.md)
|
|
894
894
|
- [Add insurance coverage](../operations/patient.addInsurance.md)
|
|
895
895
|
- [Add a notification](../operations/patient.addNotification.md)
|
|
896
|
+
- [Add one structured patient intake section](../operations/patient.addPatientIntake.md)
|
|
896
897
|
- [OCR an identity document](../operations/patient.analyzeIdentityDocument.md)
|
|
897
898
|
- [Grounded assistant chat](../operations/patient.assistantChat.md)
|
|
898
899
|
- [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
|
|
899
900
|
- [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
|
|
900
901
|
- [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
|
|
901
|
-
- [Check insurance eligibility](../operations/patient.checkEligibility.md)
|
|
902
902
|
- [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)
|
|
903
903
|
- [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
|
|
904
|
+
- [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
|
|
904
905
|
- [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
|
|
905
906
|
- [Get unread message count](../operations/patient.commsGetUnreadCount.md)
|
|
906
907
|
- [List conversations](../operations/patient.commsListConversations.md)
|
|
@@ -953,6 +954,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
953
954
|
- [List knowledge-base collections and entries](../operations/patient.listKnowledge.md)
|
|
954
955
|
- [List medications](../operations/patient.listMedications.md)
|
|
955
956
|
- [List notifications](../operations/patient.listNotifications.md)
|
|
957
|
+
- [List claims for the authenticated patient](../operations/patient.listPatientInsuranceClaims.md)
|
|
956
958
|
- [Log in a patient](../operations/patient.login.md)
|
|
957
959
|
- [Find nearby healthcare locations](../operations/patient.nearestLocations.md)
|
|
958
960
|
- [Get a photo upload URL](../operations/patient.photoUploadUrl.md)
|
|
@@ -964,6 +966,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
964
966
|
- [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
|
|
965
967
|
- [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
|
|
966
968
|
- [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
|
|
969
|
+
- [Submit a raw X12 270 eligibility request](../operations/patient.submitPatientRawX12Eligibility.md)
|
|
967
970
|
- [Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections](../operations/patient.submitSummary.md)
|
|
968
971
|
- [Update home address](../operations/patient.updateAddress.md)
|
|
969
972
|
- [Update SMS/phone contact-preference consent](../operations/patient.updateCommunicationConsent.md)
|
|
@@ -1001,6 +1004,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1001
1004
|
- [Log in a practitioner](../operations/provider.login.md)
|
|
1002
1005
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1003
1006
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1007
|
+
- [Submit multiple insurance eligibility checks](../operations/provider.submitInsuranceEligibilityBatch.md)
|
|
1004
1008
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
|
1005
1009
|
- [Update a practitioner profile](../operations/provider.updatePractitioner.md)
|
|
1006
1010
|
- [Upload a practitioner photo](../operations/provider.uploadPhoto.md)
|
package/docs/index.md
CHANGED
|
@@ -14,7 +14,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
14
14
|
- [Cancel an appointment](operations/appointments.cancel.md) (`appointments.cancel`)
|
|
15
15
|
- [Health check](operations/appointments.connect.md) (`appointments.connect`)
|
|
16
16
|
- [Create a new slot](operations/appointments.createSlot.md) (`appointments.createSlot`)
|
|
17
|
-
- [Get
|
|
17
|
+
- [Get an authorized appointment's telehealth join link](operations/appointments.getTelehealthLink.md) (`appointments.getTelehealthLink`)
|
|
18
18
|
- [List patient appointments](operations/appointments.listPatientAppointments.md) (`appointments.listPatientAppointments`)
|
|
19
19
|
- [List available slots](operations/appointments.listSlots.md) (`appointments.listSlots`)
|
|
20
20
|
- [Reschedule an appointment](operations/appointments.reschedule.md) (`appointments.reschedule`)
|
|
@@ -901,14 +901,15 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
901
901
|
- [Add a dependent](operations/patient.addDependent.md) (`patient.addDependent`)
|
|
902
902
|
- [Add insurance coverage](operations/patient.addInsurance.md) (`patient.addInsurance`)
|
|
903
903
|
- [Add a notification](operations/patient.addNotification.md) (`patient.addNotification`)
|
|
904
|
+
- [Add one structured patient intake section](operations/patient.addPatientIntake.md) (`patient.addPatientIntake`)
|
|
904
905
|
- [OCR an identity document](operations/patient.analyzeIdentityDocument.md) (`patient.analyzeIdentityDocument`)
|
|
905
906
|
- [Grounded assistant chat](operations/patient.assistantChat.md) (`patient.assistantChat`)
|
|
906
907
|
- [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
|
|
907
908
|
- [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
|
|
908
909
|
- [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
|
|
909
|
-
- [Check insurance eligibility](operations/patient.checkEligibility.md) (`patient.checkEligibility`)
|
|
910
910
|
- [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`)
|
|
911
911
|
- [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
|
|
912
|
+
- [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
|
|
912
913
|
- [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
|
|
913
914
|
- [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
|
|
914
915
|
- [List conversations](operations/patient.commsListConversations.md) (`patient.commsListConversations`)
|
|
@@ -961,6 +962,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
961
962
|
- [List knowledge-base collections and entries](operations/patient.listKnowledge.md) (`patient.listKnowledge`)
|
|
962
963
|
- [List medications](operations/patient.listMedications.md) (`patient.listMedications`)
|
|
963
964
|
- [List notifications](operations/patient.listNotifications.md) (`patient.listNotifications`)
|
|
965
|
+
- [List claims for the authenticated patient](operations/patient.listPatientInsuranceClaims.md) (`patient.listPatientInsuranceClaims`)
|
|
964
966
|
- [Log in a patient](operations/patient.login.md) (`patient.login`)
|
|
965
967
|
- [Find nearby healthcare locations](operations/patient.nearestLocations.md) (`patient.nearestLocations`)
|
|
966
968
|
- [Get a photo upload URL](operations/patient.photoUploadUrl.md) (`patient.photoUploadUrl`)
|
|
@@ -972,6 +974,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
972
974
|
- [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
|
|
973
975
|
- [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
|
|
974
976
|
- [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
|
|
977
|
+
- [Submit a raw X12 270 eligibility request](operations/patient.submitPatientRawX12Eligibility.md) (`patient.submitPatientRawX12Eligibility`)
|
|
975
978
|
- [Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections](operations/patient.submitSummary.md) (`patient.submitSummary`)
|
|
976
979
|
- [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
|
|
977
980
|
- [Update SMS/phone contact-preference consent](operations/patient.updateCommunicationConsent.md) (`patient.updateCommunicationConsent`)
|
|
@@ -1009,6 +1012,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1009
1012
|
- [Log in a practitioner](operations/provider.login.md) (`provider.login`)
|
|
1010
1013
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1011
1014
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1015
|
+
- [Submit multiple insurance eligibility checks](operations/provider.submitInsuranceEligibilityBatch.md) (`provider.submitInsuranceEligibilityBatch`)
|
|
1012
1016
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
|
1013
1017
|
- [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
|
|
1014
1018
|
- [Upload a practitioner photo](operations/provider.uploadPhoto.md) (`provider.uploadPhoto`)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AddPatientIntakeRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `AddPatientIntakeRequest`
|
|
4
|
+
|
|
5
|
+
One intake section collected by an agent.
|
|
6
|
+
|
|
7
|
+
``summary`` accepts the established, structured section object and the
|
|
8
|
+
agent-tool shorthand string. The latter is deliberately normalized by
|
|
9
|
+
the Patient API before clinical persistence; it is *not* accepted by the
|
|
10
|
+
legacy bulk intake endpoint.
|
|
11
|
+
|
|
12
|
+
Type: `object`
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
|
+
|---|---|---:|---|---|---|---:|---|
|
|
18
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
19
|
+
| `section` | `string` | Yes | | allergies, cancer_cases, family_history, gyn_history, perinatal_history, medications, problems, social_history, surgical_history, vaccines | | No | |
|
|
20
|
+
| `summary` | `object|string` | Yes | | | | No | |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AddPatientIntakeResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AddPatientIntakeResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error_messages` | `array` | No | | | | No | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# AdvanceDirective
|
|
2
|
+
|
|
3
|
+
Model ID: `AdvanceDirective`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `directive_id` | `string` | No | uuid | | | No | |
|
|
14
|
+
| `document_location` | `string|null` | No | | | `null` | Yes | |
|
|
15
|
+
| `effective_date` | `string|null` | No | | | `null` | Yes | |
|
|
16
|
+
| `expiration_date` | `string|null` | No | | | `null` | Yes | |
|
|
17
|
+
| `fhir_id` | `string|null` | No | | | `null` | Yes | |
|
|
18
|
+
| `instructions` | `string|null` | No | | | `null` | Yes | |
|
|
19
|
+
| `on_file` | `boolean` | No | | | `false` | No | |
|
|
20
|
+
| `proxy_name` | `string|null` | No | | | `null` | Yes | |
|
|
21
|
+
| `proxy_phone` | `string|null` | No | | | `null` | Yes | |
|
|
22
|
+
| `proxy_relationship` | `string|null` | No | | | `null` | Yes | |
|
|
23
|
+
| `scope` | [`DirectiveScope`](./DirectiveScope.md) | No | | | `"adr"` | No | |
|
|
24
|
+
| `status` | [`DirectiveStatus`](./DirectiveStatus.md) | No | | | `"active"` | No | |
|
|
25
|
+
| `type` | [`AdvanceDirectiveType`](./AdvanceDirectiveType.md) | Yes | | | | No | |
|
|
26
|
+
| `verified_by` | `string|null` | No | | | `null` | Yes | |
|
|
27
|
+
| `verified_date` | `string|null` | No | | | `null` | Yes | |
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
None declared in canonical OpenAPI.
|