@healthcloudai/hc-sdk 3.21.0 → 3.23.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 (36) hide show
  1. package/dist/index.cjs +212 -1
  2. package/dist/index.d.cts +821 -2
  3. package/dist/index.d.ts +821 -2
  4. package/dist/index.js +212 -1
  5. package/docs/clients/PatientClient.md +3 -0
  6. package/docs/clients/QuestClient.md +1 -1
  7. package/docs/docs-manifest.json +17 -3
  8. package/docs/examples/index.md +4 -1
  9. package/docs/index.md +4 -1
  10. package/docs/models/CatalogItemKind.md +15 -0
  11. package/docs/models/CatalogVendor.md +15 -0
  12. package/docs/models/CollectionModality.md +15 -0
  13. package/docs/models/EncounterClinicalState.md +31 -0
  14. package/docs/models/EncounterEffect.md +18 -0
  15. package/docs/models/EncounterOperationError.md +18 -0
  16. package/docs/models/EncounterOperationResponse.md +22 -0
  17. package/docs/models/EncounterSections.md +22 -0
  18. package/docs/models/GetTestOrderResponse.md +1 -0
  19. package/docs/models/ObservedEncounterResponse.md +26 -0
  20. package/docs/models/OrderItem.md +4 -0
  21. package/docs/models/PlaceTestOrderResponse.md +1 -0
  22. package/docs/models/QuestRetrieveCompendiumResponse.md +5 -0
  23. package/docs/models/SubmitEncounterOperationRequest.md +18 -0
  24. package/docs/models/TestOrder.md +1 -0
  25. package/docs/models/UnknownEncounterOperation.md +18 -0
  26. package/docs/models/index.md +11 -0
  27. package/docs/operations/connectors.questRetrieveCompendium.md +17 -2
  28. package/docs/operations/patient.getPatientEncounterClinicalState.md +170 -0
  29. package/docs/operations/patient.getPatientEncounterOperation.md +151 -0
  30. package/docs/operations/patient.getTestOrder.md +1 -0
  31. package/docs/operations/patient.listOrderItems.md +12 -4
  32. package/docs/operations/patient.listTestOrders.md +1 -0
  33. package/docs/operations/patient.placeTestOrder.md +2 -0
  34. package/docs/operations/patient.submitPatientEncounterOperation.md +161 -0
  35. package/docs/operations/patient.submitPatientIntakeOperation.md +1 -1
  36. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -935,6 +935,105 @@ var MCPClient = class extends BaseServiceClient {
935
935
  }
936
936
  };
937
937
 
938
+ // src/models/openapi-generated/patient/models/EncounterClinicalState.ts
939
+ function EncounterClinicalStateFromJSON(json) {
940
+ return EncounterClinicalStateFromJSONTyped(json, false);
941
+ }
942
+ function EncounterClinicalStateFromJSONTyped(json, ignoreDiscriminator) {
943
+ if (json == null) {
944
+ return json;
945
+ }
946
+ return {
947
+ "clinical_outcome": json["clinical_outcome"] == null ? void 0 : json["clinical_outcome"],
948
+ "ehr": json["ehr"] == null ? void 0 : json["ehr"],
949
+ "ehr_notes": json["ehr_notes"] == null ? void 0 : json["ehr_notes"],
950
+ "encounter_id": json["encounter_id"] === void 0 ? void 0 : json["encounter_id"] === null ? null : json["encounter_id"],
951
+ "fhir_encounter": json["fhir_encounter"] == null ? void 0 : json["fhir_encounter"],
952
+ "idempotency_key": json["idempotency_key"],
953
+ "insurance": json["insurance"] == null ? void 0 : json["insurance"],
954
+ "journal_status": json["journal_status"],
955
+ "notes_fhir": json["notes_fhir"] == null ? void 0 : json["notes_fhir"],
956
+ "patient_id": json["patient_id"],
957
+ "reason": json["reason"],
958
+ "request_hash": json["request_hash"],
959
+ "resource_version": json["resource_version"] === void 0 ? void 0 : json["resource_version"] === null ? null : json["resource_version"],
960
+ "response_code": json["response_code"] === void 0 ? void 0 : json["response_code"] === null ? null : json["response_code"],
961
+ "retry_allowed": json["retry_allowed"] == null ? void 0 : json["retry_allowed"]
962
+ };
963
+ }
964
+
965
+ // src/models/openapi-generated/patient/models/EncounterEffect.ts
966
+ function EncounterEffectFromJSON(json) {
967
+ return EncounterEffectFromJSONTyped(json, false);
968
+ }
969
+ function EncounterEffectFromJSONTyped(json, ignoreDiscriminator) {
970
+ if (json == null) {
971
+ return json;
972
+ }
973
+ return {
974
+ "error_present": json["error_present"],
975
+ "status": json["status"]
976
+ };
977
+ }
978
+
979
+ // src/models/openapi-generated/patient/models/EncounterSections.ts
980
+ function EncounterSectionsFromJSON(json) {
981
+ return EncounterSectionsFromJSONTyped(json, false);
982
+ }
983
+ function EncounterSectionsFromJSONTyped(json, ignoreDiscriminator) {
984
+ if (json == null) {
985
+ return json;
986
+ }
987
+ return {
988
+ "assessment": json["assessment"] === void 0 ? void 0 : json["assessment"] === null ? null : EncounterEffectFromJSON(json["assessment"]),
989
+ "hpi": json["hpi"] === void 0 ? void 0 : json["hpi"] === null ? null : EncounterEffectFromJSON(json["hpi"]),
990
+ "overall": EncounterEffectFromJSON(json["overall"]),
991
+ "plan": json["plan"] === void 0 ? void 0 : json["plan"] === null ? null : EncounterEffectFromJSON(json["plan"]),
992
+ "reason_for_visit": json["reason_for_visit"] === void 0 ? void 0 : json["reason_for_visit"] === null ? null : EncounterEffectFromJSON(json["reason_for_visit"]),
993
+ "ros": json["ros"] === void 0 ? void 0 : json["ros"] === null ? null : EncounterEffectFromJSON(json["ros"])
994
+ };
995
+ }
996
+
997
+ // src/models/openapi-generated/patient/models/ObservedEncounterResponse.ts
998
+ function ObservedEncounterResponseFromJSON(json) {
999
+ return ObservedEncounterResponseFromJSONTyped(json, false);
1000
+ }
1001
+ function ObservedEncounterResponseFromJSONTyped(json, ignoreDiscriminator) {
1002
+ if (json == null) {
1003
+ return json;
1004
+ }
1005
+ return {
1006
+ "athena_encounter": json["athena_encounter"] === void 0 ? void 0 : json["athena_encounter"] === null ? null : EncounterEffectFromJSON(json["athena_encounter"]),
1007
+ "athena_insurance": json["athena_insurance"] === void 0 ? void 0 : json["athena_insurance"] === null ? null : EncounterEffectFromJSON(json["athena_insurance"]),
1008
+ "clinical_outcome": json["clinical_outcome"] == null ? void 0 : json["clinical_outcome"],
1009
+ "created": json["created"] === void 0 ? void 0 : json["created"] === null ? null : json["created"],
1010
+ "encounter_id": json["encounter_id"] === void 0 ? void 0 : json["encounter_id"] === null ? null : json["encounter_id"],
1011
+ "error_present": json["error_present"],
1012
+ "notes_athena_sections": json["notes_athena_sections"] === void 0 ? void 0 : json["notes_athena_sections"] === null ? null : EncounterSectionsFromJSON(json["notes_athena_sections"]),
1013
+ "notes_fhir": json["notes_fhir"] === void 0 ? void 0 : json["notes_fhir"] === null ? null : EncounterEffectFromJSON(json["notes_fhir"]),
1014
+ "openloop_encounter": json["openloop_encounter"] === void 0 ? void 0 : json["openloop_encounter"] === null ? null : EncounterEffectFromJSON(json["openloop_encounter"]),
1015
+ "steadymd_encounter": json["steadymd_encounter"] === void 0 ? void 0 : json["steadymd_encounter"] === null ? null : EncounterEffectFromJSON(json["steadymd_encounter"])
1016
+ };
1017
+ }
1018
+
1019
+ // src/models/openapi-generated/patient/models/EncounterOperationResponse.ts
1020
+ function EncounterOperationResponseFromJSON(json) {
1021
+ return EncounterOperationResponseFromJSONTyped(json, false);
1022
+ }
1023
+ function EncounterOperationResponseFromJSONTyped(json, ignoreDiscriminator) {
1024
+ if (json == null) {
1025
+ return json;
1026
+ }
1027
+ return {
1028
+ "idempotency_key": json["idempotency_key"],
1029
+ "patient_id": json["patient_id"],
1030
+ "request_hash": json["request_hash"],
1031
+ "response_body": json["response_body"] === void 0 ? void 0 : json["response_body"] === null ? null : ObservedEncounterResponseFromJSON(json["response_body"]),
1032
+ "response_code": json["response_code"] === void 0 ? void 0 : json["response_code"] === null ? null : json["response_code"],
1033
+ "status": json["status"]
1034
+ };
1035
+ }
1036
+
938
1037
  // src/models/openapi-generated/patient/models/ObservedIntakeResponse.ts
939
1038
  function ObservedIntakeResponseFromJSON(json) {
940
1039
  return ObservedIntakeResponseFromJSONTyped(json, false);
@@ -1014,6 +1113,70 @@ function intakeOperationResponse(value, key) {
1014
1113
  return IntakeOperationResponseFromJSON(value);
1015
1114
  }
1016
1115
 
1116
+ // src/clients/encounterOperations.ts
1117
+ var effects = ["athena_encounter", "athena_insurance", "openloop_encounter", "steadymd_encounter", "notes_fhir"];
1118
+ var sections2 = ["reason_for_visit", "hpi", "ros", "assessment", "plan"];
1119
+ var statuses = /* @__PURE__ */ new Set(["linked", "failed", "partial", "skipped_no_athena", "skipped_no_openloop", "skipped_no_steadymd", "skipped_no_notes", "skipped_no_content", "skipped_no_package_configured", "skipped_no_openai", "skipped_no_athena_integration", "skipped", "unknown"]);
1120
+ var record2 = (value) => !!value && typeof value === "object" && !Array.isArray(value);
1121
+ function encounterRequestSnapshot(request) {
1122
+ const invalid = () => new Error("Valid bounded exact encounter notes are required");
1123
+ if (!record2(request) || Object.keys(request).sort().join(",") !== "idempotency_key,notes") throw invalid();
1124
+ for (const name of Object.getOwnPropertyNames(request)) {
1125
+ const descriptor = Object.getOwnPropertyDescriptor(request, name);
1126
+ if (!descriptor.enumerable || !("value" in descriptor)) throw invalid();
1127
+ }
1128
+ if (Object.getOwnPropertySymbols(request).length) throw invalid();
1129
+ const key = intakeOperationKey(request.idempotency_key), notes = request.notes;
1130
+ if (typeof notes !== "string" || new TextEncoder().encode(notes).length > 65536) throw invalid();
1131
+ const blank = Array.from(notes).every((character) => !character.trim() || character.charCodeAt(0) >= 28 && character.charCodeAt(0) <= 31 || character.charCodeAt(0) === 133);
1132
+ if (blank) throw invalid();
1133
+ for (const character of notes) {
1134
+ const point = character.codePointAt(0);
1135
+ if (point >= 55296 && point <= 57343) throw invalid();
1136
+ }
1137
+ return { idempotency_key: key, notes };
1138
+ }
1139
+ function encounterOperationResponse(value, key) {
1140
+ const invalid = () => new Error("Invalid or mismatched encounter operation response; reconcile the original key");
1141
+ function closed(item, required, optional = []) {
1142
+ if (!record2(item) || required.some((name) => !Object.prototype.hasOwnProperty.call(item, name)) || Object.keys(item).some((name) => ![...required, ...optional].includes(name))) throw invalid();
1143
+ }
1144
+ function effect(item) {
1145
+ closed(item, ["status", "error_present"]);
1146
+ if (typeof item.status !== "string" || !statuses.has(item.status) || typeof item.error_present !== "boolean") throw invalid();
1147
+ }
1148
+ const identifier = (item) => typeof item === "string" && item.length <= 64 && /^[A-Za-z0-9.-]+$/.test(item) && item.trim() === item;
1149
+ closed(value, ["idempotency_key", "patient_id", "request_hash", "status"], ["response_code", "response_body"]);
1150
+ if (value.idempotency_key !== key || !identifier(value.patient_id) || typeof value.request_hash !== "string" || value.request_hash.length !== 64 || !/^[0-9a-f]{64}$/.test(value.request_hash) || typeof value.status !== "string" || !["reserved", "dispatching", "unknown", "recorded"].includes(value.status)) throw invalid();
1151
+ const code = value.response_code, body = value.response_body;
1152
+ if (value.status === "recorded") {
1153
+ if (typeof code !== "number" || !Number.isInteger(code) || code < 100 || code > 599) throw invalid();
1154
+ closed(body, ["clinical_outcome", "error_present"], [...effects, "encounter_id", "created", "notes_athena_sections"]);
1155
+ if (body.clinical_outcome !== "unknown" || typeof body.error_present !== "boolean" || body.encounter_id != null && !identifier(body.encounter_id) || body.created != null && typeof body.created !== "boolean") throw invalid();
1156
+ for (const name of effects) if (body[name] != null) effect(body[name]);
1157
+ if (body.notes_athena_sections != null) {
1158
+ closed(body.notes_athena_sections, ["overall"], sections2);
1159
+ effect(body.notes_athena_sections.overall);
1160
+ for (const name of sections2) if (body.notes_athena_sections[name] != null) effect(body.notes_athena_sections[name]);
1161
+ }
1162
+ } else if (code != null || body != null) throw invalid();
1163
+ return EncounterOperationResponseFromJSON(value);
1164
+ }
1165
+ function encounterClinicalState(value, key) {
1166
+ const invalid = () => new Error("Invalid or mismatched encounter clinical state; no retry authorized");
1167
+ const required = ["idempotency_key", "patient_id", "request_hash", "journal_status", "fhir_encounter", "notes_fhir", "ehr", "insurance", "ehr_notes", "clinical_outcome", "retry_allowed", "reason"];
1168
+ const identifier = (item) => typeof item === "string" && item.length <= 64 && /^[A-Za-z0-9.-]+$/.test(item) && item.trim() === item;
1169
+ if (!record2(value) || required.some((name) => !Object.prototype.hasOwnProperty.call(value, name)) || Object.keys(value).some((name) => ![...required, "response_code", "encounter_id", "resource_version"].includes(name)) || value.idempotency_key !== key || !identifier(value.patient_id) || typeof value.request_hash !== "string" || value.request_hash.length !== 64 || !/^[0-9a-f]{64}$/.test(value.request_hash) || typeof value.journal_status !== "string" || !["reserved", "dispatching", "unknown", "recorded"].includes(value.journal_status) || typeof value.fhir_encounter !== "string" || !["present", "unknown"].includes(value.fhir_encounter) || typeof value.notes_fhir !== "string" || !["matches", "unknown"].includes(value.notes_fhir) || ["ehr", "insurance", "ehr_notes", "clinical_outcome"].some((name) => value[name] !== "unknown") || value.retry_allowed !== false || typeof value.reason !== "string" || !["journal_unresolved", "no_recorded_encounter", "resource_unavailable", "resource_mismatch", "resource_unversioned", "resource_inactive", "notes_unverified", "notes_match"].includes(value.reason)) throw invalid();
1170
+ const code = value.response_code;
1171
+ if (value.journal_status === "recorded") {
1172
+ if (typeof code !== "number" || !Number.isInteger(code) || code < 100 || code > 599) throw invalid();
1173
+ } else if (code != null) throw invalid();
1174
+ if (value.fhir_encounter === "present") {
1175
+ if (value.journal_status !== "recorded" || !identifier(value.encounter_id) || !identifier(value.resource_version) || value.reason !== (value.notes_fhir === "matches" ? "notes_match" : "notes_unverified")) throw invalid();
1176
+ } else if (value.encounter_id != null || value.resource_version != null || value.notes_fhir !== "unknown" || ["notes_match", "notes_unverified"].includes(value.reason)) throw invalid();
1177
+ return EncounterClinicalStateFromJSON(value);
1178
+ }
1179
+
1017
1180
  // src/models/openapi-generated/patient/models/StediClaimsResponse.ts
1018
1181
  function StediClaimsResponseFromJSON(json) {
1019
1182
  return StediClaimsResponseFromJSONTyped(json, false);
@@ -2328,6 +2491,30 @@ function ListDeliveryOrdersResponseFromJSONTyped(json, ignoreDiscriminator) {
2328
2491
  };
2329
2492
  }
2330
2493
 
2494
+ // src/models/openapi-generated/patient/models/CatalogVendor.ts
2495
+ function CatalogVendorFromJSON(json) {
2496
+ return CatalogVendorFromJSONTyped(json, false);
2497
+ }
2498
+ function CatalogVendorFromJSONTyped(json, ignoreDiscriminator) {
2499
+ return json;
2500
+ }
2501
+
2502
+ // src/models/openapi-generated/patient/models/CatalogItemKind.ts
2503
+ function CatalogItemKindFromJSON(json) {
2504
+ return CatalogItemKindFromJSONTyped(json, false);
2505
+ }
2506
+ function CatalogItemKindFromJSONTyped(json, ignoreDiscriminator) {
2507
+ return json;
2508
+ }
2509
+
2510
+ // src/models/openapi-generated/patient/models/CollectionModality.ts
2511
+ function CollectionModalityFromJSON(json) {
2512
+ return CollectionModalityFromJSONTyped(json, false);
2513
+ }
2514
+ function CollectionModalityFromJSONTyped(json, ignoreDiscriminator) {
2515
+ return json;
2516
+ }
2517
+
2331
2518
  // src/models/openapi-generated/patient/models/OrderItem.ts
2332
2519
  function OrderItemFromJSON(json) {
2333
2520
  return OrderItemFromJSONTyped(json, false);
@@ -2337,9 +2524,13 @@ function OrderItemFromJSONTyped(json, ignoreDiscriminator) {
2337
2524
  return json;
2338
2525
  }
2339
2526
  return {
2527
+ "collection_modalities": json["collection_modalities"] == null ? void 0 : json["collection_modalities"].map(CollectionModalityFromJSON),
2528
+ "collection_modality": CollectionModalityFromJSON(json["collection_modality"]),
2340
2529
  "id": json["id"],
2341
2530
  "image": json["image"] === void 0 ? void 0 : json["image"] === null ? null : json["image"],
2342
- "name": json["name"]
2531
+ "kind": CatalogItemKindFromJSON(json["kind"]),
2532
+ "name": json["name"],
2533
+ "vendor": CatalogVendorFromJSON(json["vendor"])
2343
2534
  };
2344
2535
  }
2345
2536
 
@@ -2480,6 +2671,7 @@ function PlaceTestOrderResponseFromJSONTyped(json, ignoreDiscriminator) {
2480
2671
  "patient_fhir_id": json["patient_fhir_id"] === void 0 ? void 0 : json["patient_fhir_id"] === null ? null : json["patient_fhir_id"],
2481
2672
  "performer_name": json["performer_name"] === void 0 ? void 0 : json["performer_name"] === null ? null : json["performer_name"],
2482
2673
  "priority": json["priority"] == null ? void 0 : OrderPriorityFromJSON(json["priority"]),
2674
+ "quest_placer_order_number": json["quest_placer_order_number"] === void 0 ? void 0 : json["quest_placer_order_number"] === null ? null : json["quest_placer_order_number"],
2483
2675
  "reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
2484
2676
  "requester_name": json["requester_name"] === void 0 ? void 0 : json["requester_name"] === null ? null : json["requester_name"],
2485
2677
  "requester_npi": json["requester_npi"] === void 0 ? void 0 : json["requester_npi"] === null ? null : json["requester_npi"],
@@ -2520,6 +2712,7 @@ function GetTestOrderResponseFromJSONTyped(json, ignoreDiscriminator) {
2520
2712
  "patient_fhir_id": json["patient_fhir_id"] === void 0 ? void 0 : json["patient_fhir_id"] === null ? null : json["patient_fhir_id"],
2521
2713
  "performer_name": json["performer_name"] === void 0 ? void 0 : json["performer_name"] === null ? null : json["performer_name"],
2522
2714
  "priority": json["priority"] == null ? void 0 : OrderPriorityFromJSON(json["priority"]),
2715
+ "quest_placer_order_number": json["quest_placer_order_number"] === void 0 ? void 0 : json["quest_placer_order_number"] === null ? null : json["quest_placer_order_number"],
2523
2716
  "reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
2524
2717
  "requester_name": json["requester_name"] === void 0 ? void 0 : json["requester_name"] === null ? null : json["requester_name"],
2525
2718
  "requester_npi": json["requester_npi"] === void 0 ? void 0 : json["requester_npi"] === null ? null : json["requester_npi"],
@@ -2560,6 +2753,7 @@ function TestOrderFromJSONTyped(json, ignoreDiscriminator) {
2560
2753
  "patient_fhir_id": json["patient_fhir_id"] === void 0 ? void 0 : json["patient_fhir_id"] === null ? null : json["patient_fhir_id"],
2561
2754
  "performer_name": json["performer_name"] === void 0 ? void 0 : json["performer_name"] === null ? null : json["performer_name"],
2562
2755
  "priority": json["priority"] == null ? void 0 : OrderPriorityFromJSON(json["priority"]),
2756
+ "quest_placer_order_number": json["quest_placer_order_number"] === void 0 ? void 0 : json["quest_placer_order_number"] === null ? null : json["quest_placer_order_number"],
2563
2757
  "reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
2564
2758
  "requester_name": json["requester_name"] === void 0 ? void 0 : json["requester_name"] === null ? null : json["requester_name"],
2565
2759
  "requester_npi": json["requester_npi"] === void 0 ? void 0 : json["requester_npi"] === null ? null : json["requester_npi"],
@@ -2898,6 +3092,23 @@ var PatientClient = class extends BaseServiceClient {
2898
3092
  const key = intakeOperationKey(idempotencyKey);
2899
3093
  return intakeOperationResponse(await this.send("GET", `/patients/intake/operations/${key}`), key);
2900
3094
  }
3095
+ /** Submit exact reviewed notes once. Recorded HTTP never settles clinical effects.
3096
+ * Pending/unknown remains unresolved; reconcile the original key, with no retry or fallback.
3097
+ */
3098
+ async submitPatientEncounterOperation(request) {
3099
+ const body = encounterRequestSnapshot(request);
3100
+ return encounterOperationResponse(await this.send("POST", "/patients/encounter/operations", { body }), body.idempotency_key);
3101
+ }
3102
+ /** Read only the original key. A 404 does not prove no clinical effects. */
3103
+ async getPatientEncounterOperation(idempotencyKey) {
3104
+ const key = intakeOperationKey(idempotencyKey);
3105
+ return encounterOperationResponse(await this.send("GET", `/patients/encounter/operations/${key}`), key);
3106
+ }
3107
+ /** Read only original-key FHIR facts. Never authorizes clinical completion or retry. */
3108
+ async getPatientEncounterClinicalState(idempotencyKey) {
3109
+ const key = intakeOperationKey(idempotencyKey);
3110
+ return encounterClinicalState(await this.send("GET", `/patients/encounter/operations/${key}/clinical-state`), key);
3111
+ }
2901
3112
  /** GET /patients/attributes - get the authenticated patient's arbitrary JSON attributes. */
2902
3113
  getAttributes() {
2903
3114
  return this.send("GET", "/patients/attributes", {});
@@ -53,6 +53,8 @@
53
53
  - [`getPatientAlerts`](../operations/patient.getPatientAlerts.md) — Get patient dashboard alerts
54
54
  - [`getAttributes`](../operations/patient.getPatientAttributes.md) — Get patient attributes
55
55
  - [`getDashboard`](../operations/patient.getPatientDashboard.md) — Get the patient dashboard summary
56
+ - [`getPatientEncounterClinicalState`](../operations/patient.getPatientEncounterClinicalState.md) — Read current FHIR facts for the authenticated patient's original encounter key
57
+ - [`getPatientEncounterOperation`](../operations/patient.getPatientEncounterOperation.md) — Read the logged-in patient's keyed encounter journal state
56
58
  - [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
57
59
  - [`getPatientFlagsOperation`](../operations/patient.getPatientFlagsOperation.md) — Look up a keyed patient flag receipt
58
60
  - [`getPatientIntake`](../operations/patient.getPatientIntake.md) — Get own patient intake submission and delivery status
@@ -86,6 +88,7 @@
86
88
  - [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
87
89
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
88
90
  - [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
91
+ - [`submitPatientEncounterOperation`](../operations/patient.submitPatientEncounterOperation.md) — Execute or replay one keyed agent encounter operation
89
92
  - [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
90
93
  - [`submitPatientIntakeOperation`](../operations/patient.submitPatientIntakeOperation.md) — Execute or replay one keyed agent intake operation
91
94
  - [`submitRawX12InsuranceEligibility`](../operations/patient.submitPatientRawX12Eligibility.md) — Submit a raw X12 270 eligibility request
@@ -21,7 +21,7 @@
21
21
  - [`requestCompendiums`](../operations/connectors.questRequestCompendiums.md) — Request compendiums (Quest)
22
22
  - [`requestCompendiumsOnDemand`](../operations/connectors.questRequestCompendiumsOnDemand.md) — Request compendiums on demand (Quest)
23
23
  - [`retrieveAndExtractCompendium`](../operations/connectors.questRetrieveAndExtractCompendium.md) — Retrieve a compendium zip and return {filename: base64_content}
24
- - [`retrieveCompendium`](../operations/connectors.questRetrieveCompendium.md) — Retrieve a compendium zip and return as a Base64-encoded dict
24
+ - [`retrieveCompendium`](../operations/connectors.questRetrieveCompendium.md) — Retrieve a compendium zip as Base64, or as a short-lived download URL
25
25
  - [`submitFullOrder`](../operations/connectors.questSubmitFullOrder.md) — Submit full order (Quest)
26
26
  - [`submitOrder`](../operations/connectors.questSubmitOrder.md) — Submit order (Quest)
27
27
  - [`syncCompendiums`](../operations/connectors.questSyncCompendiums.md) — Download all available compendium files; ack each one
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:88a0aadd3400544fa7395dfe762aa6d04c595a8e2109855a7d9e58221f8fe0cb",
2
+ "docsDataContentDigest": "sha256:3cc44dfe6b6c58864456a393ecf73a669aa0cc1a30d87b4cdf8333bc27f77d79",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -446,6 +446,8 @@
446
446
  "models/CarequalityQueryDocumentsResponse.md",
447
447
  "models/CarequalityRetrieveDocumentsRequest.md",
448
448
  "models/CarequalityRetrieveDocumentsResponse.md",
449
+ "models/CatalogItemKind.md",
450
+ "models/CatalogVendor.md",
449
451
  "models/ChatMessageRecord.md",
450
452
  "models/CheckEligibilityRequest.md",
451
453
  "models/CheckEligibilityResponse.md",
@@ -457,6 +459,7 @@
457
459
  "models/CmsGetCountyFipsRequest.md",
458
460
  "models/CmsSearchHealthPlansRequest.md",
459
461
  "models/CmsSearchHealthPlansResponse.md",
462
+ "models/CollectionModality.md",
460
463
  "models/CommGroupRecord.md",
461
464
  "models/CommsGetStateResponse.md",
462
465
  "models/CommsGetUnreadCountResponse.md",
@@ -578,6 +581,11 @@
578
581
  "models/ElevenlabsUpdateToolRequest.md",
579
582
  "models/EmergencyContact.md",
580
583
  "models/EncounterClass.md",
584
+ "models/EncounterClinicalState.md",
585
+ "models/EncounterEffect.md",
586
+ "models/EncounterOperationError.md",
587
+ "models/EncounterOperationResponse.md",
588
+ "models/EncounterSections.md",
581
589
  "models/EncounterStatus.md",
582
590
  "models/Ethnicity.md",
583
591
  "models/ExerciseFrequency.md",
@@ -1302,6 +1310,7 @@
1302
1310
  "models/NppesVerifyProviderResponse.md",
1303
1311
  "models/ObservationComponent.md",
1304
1312
  "models/ObservationStatus.md",
1313
+ "models/ObservedEncounterResponse.md",
1305
1314
  "models/ObservedIntakeResponse.md",
1306
1315
  "models/OnboardEncounterPayload.md",
1307
1316
  "models/OnboardEncounterStepResult.md",
@@ -1811,6 +1820,7 @@
1811
1820
  "models/StripeVerifyConnectionResponse.md",
1812
1821
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md",
1813
1822
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md",
1823
+ "models/SubmitEncounterOperationRequest.md",
1814
1824
  "models/SubmitIntakeOperationRequest.md",
1815
1825
  "models/SubmitSummaryRequest.md",
1816
1826
  "models/SubscriberRelationship.md",
@@ -1839,6 +1849,7 @@
1839
1849
  "models/UberGetUndeliveredOrdersResponse.md",
1840
1850
  "models/UberUpdateDeliveryRequest.md",
1841
1851
  "models/UberWaypoint.md",
1852
+ "models/UnknownEncounterOperation.md",
1842
1853
  "models/UnknownFlagOperation.md",
1843
1854
  "models/UnknownIntakeOperation.md",
1844
1855
  "models/UpdateAddressRequest.md",
@@ -3130,6 +3141,8 @@
3130
3141
  "operations/patient.getPatientAlerts.md",
3131
3142
  "operations/patient.getPatientAttributes.md",
3132
3143
  "operations/patient.getPatientDashboard.md",
3144
+ "operations/patient.getPatientEncounterClinicalState.md",
3145
+ "operations/patient.getPatientEncounterOperation.md",
3133
3146
  "operations/patient.getPatientFlags.md",
3134
3147
  "operations/patient.getPatientFlagsOperation.md",
3135
3148
  "operations/patient.getPatientIntake.md",
@@ -3168,6 +3181,7 @@
3168
3181
  "operations/patient.searchKnowledge.md",
3169
3182
  "operations/patient.setPreferredPharmacy.md",
3170
3183
  "operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
3184
+ "operations/patient.submitPatientEncounterOperation.md",
3171
3185
  "operations/patient.submitPatientIntake.md",
3172
3186
  "operations/patient.submitPatientIntakeOperation.md",
3173
3187
  "operations/patient.submitPatientRawX12Eligibility.md",
@@ -3242,7 +3256,7 @@
3242
3256
  "operations/vitals.recordVitals.md"
3243
3257
  ],
3244
3258
  "language": "nodejs",
3245
- "modelCount": 2133,
3246
- "operationCount": 1052,
3259
+ "modelCount": 2144,
3260
+ "operationCount": 1055,
3247
3261
  "schemaVersion": 1
3248
3262
  }
@@ -593,7 +593,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
593
593
  - [Request compendiums (Quest)](../operations/connectors.questRequestCompendiums.md)
594
594
  - [Request compendiums on demand (Quest)](../operations/connectors.questRequestCompendiumsOnDemand.md)
595
595
  - [Retrieve a compendium zip and return {filename: base64_content}](../operations/connectors.questRetrieveAndExtractCompendium.md)
596
- - [Retrieve a compendium zip and return as a Base64-encoded dict](../operations/connectors.questRetrieveCompendium.md)
596
+ - [Retrieve a compendium zip as Base64, or as a short-lived download URL](../operations/connectors.questRetrieveCompendium.md)
597
597
  - [Submit full order (Quest)](../operations/connectors.questSubmitFullOrder.md)
598
598
  - [Submit order (Quest)](../operations/connectors.questSubmitOrder.md)
599
599
  - [Download all available compendium files; ack each one](../operations/connectors.questSyncCompendiums.md)
@@ -944,6 +944,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
944
944
  - [Get patient dashboard alerts](../operations/patient.getPatientAlerts.md)
945
945
  - [Get patient attributes](../operations/patient.getPatientAttributes.md)
946
946
  - [Get the patient dashboard summary](../operations/patient.getPatientDashboard.md)
947
+ - [Read current FHIR facts for the authenticated patient's original encounter key](../operations/patient.getPatientEncounterClinicalState.md)
948
+ - [Read the logged-in patient's keyed encounter journal state](../operations/patient.getPatientEncounterOperation.md)
947
949
  - [Get patient flags](../operations/patient.getPatientFlags.md)
948
950
  - [Look up a keyed patient flag receipt](../operations/patient.getPatientFlagsOperation.md)
949
951
  - [Get own patient intake submission and delivery status](../operations/patient.getPatientIntake.md)
@@ -982,6 +984,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
982
984
  - [Search the knowledge base](../operations/patient.searchKnowledge.md)
983
985
  - [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
984
986
  - [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
987
+ - [Execute or replay one keyed agent encounter operation](../operations/patient.submitPatientEncounterOperation.md)
985
988
  - [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
986
989
  - [Execute or replay one keyed agent intake operation](../operations/patient.submitPatientIntakeOperation.md)
987
990
  - [Submit a raw X12 270 eligibility request](../operations/patient.submitPatientRawX12Eligibility.md)
package/docs/index.md CHANGED
@@ -601,7 +601,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
601
601
  - [Request compendiums (Quest)](operations/connectors.questRequestCompendiums.md) (`connectors.questRequestCompendiums`)
602
602
  - [Request compendiums on demand (Quest)](operations/connectors.questRequestCompendiumsOnDemand.md) (`connectors.questRequestCompendiumsOnDemand`)
603
603
  - [Retrieve a compendium zip and return {filename: base64_content}](operations/connectors.questRetrieveAndExtractCompendium.md) (`connectors.questRetrieveAndExtractCompendium`)
604
- - [Retrieve a compendium zip and return as a Base64-encoded dict](operations/connectors.questRetrieveCompendium.md) (`connectors.questRetrieveCompendium`)
604
+ - [Retrieve a compendium zip as Base64, or as a short-lived download URL](operations/connectors.questRetrieveCompendium.md) (`connectors.questRetrieveCompendium`)
605
605
  - [Submit full order (Quest)](operations/connectors.questSubmitFullOrder.md) (`connectors.questSubmitFullOrder`)
606
606
  - [Submit order (Quest)](operations/connectors.questSubmitOrder.md) (`connectors.questSubmitOrder`)
607
607
  - [Download all available compendium files; ack each one](operations/connectors.questSyncCompendiums.md) (`connectors.questSyncCompendiums`)
@@ -952,6 +952,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
952
952
  - [Get patient dashboard alerts](operations/patient.getPatientAlerts.md) (`patient.getPatientAlerts`)
953
953
  - [Get patient attributes](operations/patient.getPatientAttributes.md) (`patient.getPatientAttributes`)
954
954
  - [Get the patient dashboard summary](operations/patient.getPatientDashboard.md) (`patient.getPatientDashboard`)
955
+ - [Read current FHIR facts for the authenticated patient's original encounter key](operations/patient.getPatientEncounterClinicalState.md) (`patient.getPatientEncounterClinicalState`)
956
+ - [Read the logged-in patient's keyed encounter journal state](operations/patient.getPatientEncounterOperation.md) (`patient.getPatientEncounterOperation`)
955
957
  - [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
956
958
  - [Look up a keyed patient flag receipt](operations/patient.getPatientFlagsOperation.md) (`patient.getPatientFlagsOperation`)
957
959
  - [Get own patient intake submission and delivery status](operations/patient.getPatientIntake.md) (`patient.getPatientIntake`)
@@ -990,6 +992,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
990
992
  - [Search the knowledge base](operations/patient.searchKnowledge.md) (`patient.searchKnowledge`)
991
993
  - [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
992
994
  - [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
995
+ - [Execute or replay one keyed agent encounter operation](operations/patient.submitPatientEncounterOperation.md) (`patient.submitPatientEncounterOperation`)
993
996
  - [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
994
997
  - [Execute or replay one keyed agent intake operation](operations/patient.submitPatientIntakeOperation.md) (`patient.submitPatientIntakeOperation`)
995
998
  - [Submit a raw X12 270 eligibility request](operations/patient.submitPatientRawX12Eligibility.md) (`patient.submitPatientRawX12Eligibility`)
@@ -0,0 +1,15 @@
1
+ # CatalogItemKind
2
+
3
+ Model ID: `CatalogItemKind`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # CatalogVendor
2
+
3
+ Model ID: `CatalogVendor`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # CollectionModality
2
+
3
+ Model ID: `CollectionModality`
4
+
5
+ Where and by whom the specimen is collected.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,31 @@
1
+ # EncounterClinicalState
2
+
3
+ Model ID: `EncounterClinicalState`
4
+
5
+ Current versioned FHIR facts; never proof of causation or all-provider completion.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `clinical_outcome` | `string` | No | | | `"unknown"` | No | |
14
+ | `ehr` | `string` | No | | | `"unknown"` | No | |
15
+ | `ehr_notes` | `string` | No | | | `"unknown"` | No | |
16
+ | `encounter_id` | `string|null` | No | | | | Yes | |
17
+ | `fhir_encounter` | `string` | No | | present, unknown | `"unknown"` | No | |
18
+ | `idempotency_key` | `string` | Yes | | | | No | |
19
+ | `insurance` | `string` | No | | | `"unknown"` | No | |
20
+ | `journal_status` | `string` | Yes | | reserved, dispatching, unknown, recorded | | No | |
21
+ | `notes_fhir` | `string` | No | | matches, unknown | `"unknown"` | No | |
22
+ | `patient_id` | `string` | Yes | | | | No | |
23
+ | `reason` | `string` | Yes | | journal_unresolved, no_recorded_encounter, resource_unavailable, resource_mismatch, resource_unversioned, resource_inactive, notes_unverified, notes_match | | No | |
24
+ | `request_hash` | `string` | Yes | | | | No | |
25
+ | `resource_version` | `string|null` | No | | | | Yes | |
26
+ | `response_code` | `integer|null` | No | | | | Yes | |
27
+ | `retry_allowed` | `boolean` | No | | | `false` | No | |
28
+
29
+ ## Example
30
+
31
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # EncounterEffect
2
+
3
+ Model ID: `EncounterEffect`
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_present` | `boolean` | Yes | | | | No | |
14
+ | `status` | `string` | Yes | | linked, failed, partial, skipped_no_athena, skipped_no_openloop, skipped_no_steadymd, skipped_no_notes, skipped_no_content, skipped_no_package_configured, skipped_no_openai, skipped_no_athena_integration, skipped, unknown | | No | |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # EncounterOperationError
2
+
3
+ Model ID: `EncounterOperationError`
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` | `string` | Yes | | | | No | |
14
+ | `outcome` | [`UnknownEncounterOperation`](./UnknownEncounterOperation.md) | No | | | | Yes | |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,22 @@
1
+ # EncounterOperationResponse
2
+
3
+ Model ID: `EncounterOperationResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `idempotency_key` | `string` | Yes | | | | No | |
14
+ | `patient_id` | `string` | Yes | | | | No | |
15
+ | `request_hash` | `string` | Yes | | | | No | |
16
+ | `response_body` | [`ObservedEncounterResponse`](./ObservedEncounterResponse.md) | No | | | | Yes | |
17
+ | `response_code` | `integer|null` | No | | | | Yes | |
18
+ | `status` | `string` | Yes | | reserved, dispatching, unknown, recorded | | No | |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -0,0 +1,22 @@
1
+ # EncounterSections
2
+
3
+ Model ID: `EncounterSections`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `assessment` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
14
+ | `hpi` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
15
+ | `overall` | [`EncounterEffect`](./EncounterEffect.md) | Yes | | | | No | |
16
+ | `plan` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
17
+ | `reason_for_visit` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
18
+ | `ros` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -30,6 +30,7 @@ Type: `object`
30
30
  | `patient_fhir_id` | `string|null` | No | | | | Yes | |
31
31
  | `performer_name` | `string|null` | No | | | | Yes | |
32
32
  | `priority` | [`OrderPriority`](./OrderPriority.md) | No | | | `"routine"` | No | |
33
+ | `quest_placer_order_number` | `string|null` | No | | | | Yes | Quest Lab Reference Number (ORC-2) of an order placed with Quest; such an order is cancelled with Quest, not here. |
33
34
  | `reason` | `string|null` | No | | | | Yes | |
34
35
  | `requester_name` | `string|null` | No | | | | Yes | |
35
36
  | `requester_npi` | `string|null` | No | | | | Yes | |