@healthcloudai/hc-sdk 3.22.0 → 3.24.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.
- package/dist/index.cjs +77 -0
- package/dist/index.d.cts +1312 -4
- package/dist/index.d.ts +1312 -4
- package/dist/index.js +77 -0
- package/docs/clients/PatientClient.md +1 -0
- package/docs/clients/ProviderClient.md +7 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/CreateProviderPatientRequest.md +22 -0
- package/docs/models/EncounterClinicalState.md +31 -0
- package/docs/models/LabOrder.md +35 -0
- package/docs/models/LabOrderDiagnosis.md +18 -0
- package/docs/models/LabOrderErrorResponse.md +21 -0
- package/docs/models/LabOrderItemRequest.md +17 -0
- package/docs/models/LabOrderProvider.md +20 -0
- package/docs/models/LabOrderRequisitionResponse.md +20 -0
- package/docs/models/LabOrderTest.md +19 -0
- package/docs/models/LabOrderUnsentItem.md +19 -0
- package/docs/models/ListLabOrdersResponse.md +18 -0
- package/docs/models/PlaceLabOrderRequest.md +27 -0
- package/docs/models/PlaceLabOrderResponse.md +20 -0
- package/docs/models/ProviderEncounterStatusCounts.md +21 -0
- package/docs/models/ProviderHomeSummaryResponse.md +19 -0
- package/docs/models/ProviderPatientListResponse.md +19 -0
- package/docs/models/ProviderPatientResponse.md +17 -0
- package/docs/models/index.md +17 -0
- package/docs/operations/patient.getPatientEncounterClinicalState.md +170 -0
- package/docs/operations/provider.createPatient.md +155 -0
- package/docs/operations/provider.getHomeSummary.md +115 -0
- package/docs/operations/provider.getLabOrder.md +179 -0
- package/docs/operations/provider.getLabOrderRequisition.md +148 -0
- package/docs/operations/provider.listLabOrders.md +198 -0
- package/docs/operations/provider.listPatients.md +154 -0
- package/docs/operations/provider.placeLabOrder.md +384 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -935,6 +935,33 @@ 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
|
+
|
|
938
965
|
// src/models/openapi-generated/patient/models/EncounterEffect.ts
|
|
939
966
|
function EncounterEffectFromJSON(json) {
|
|
940
967
|
return EncounterEffectFromJSONTyped(json, false);
|
|
@@ -1135,6 +1162,20 @@ function encounterOperationResponse(value, key) {
|
|
|
1135
1162
|
} else if (code != null || body != null) throw invalid();
|
|
1136
1163
|
return EncounterOperationResponseFromJSON(value);
|
|
1137
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
|
+
}
|
|
1138
1179
|
|
|
1139
1180
|
// src/models/openapi-generated/patient/models/StediClaimsResponse.ts
|
|
1140
1181
|
function StediClaimsResponseFromJSON(json) {
|
|
@@ -3063,6 +3104,11 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3063
3104
|
const key = intakeOperationKey(idempotencyKey);
|
|
3064
3105
|
return encounterOperationResponse(await this.send("GET", `/patients/encounter/operations/${key}`), key);
|
|
3065
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
|
+
}
|
|
3066
3112
|
/** GET /patients/attributes - get the authenticated patient's arbitrary JSON attributes. */
|
|
3067
3113
|
getAttributes() {
|
|
3068
3114
|
return this.send("GET", "/patients/attributes", {});
|
|
@@ -3673,6 +3719,37 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3673
3719
|
getAppointment(appointmentId) {
|
|
3674
3720
|
return this.send("GET", "/appointments/{appointment_id}", { pathParams: { appointment_id: appointmentId } });
|
|
3675
3721
|
}
|
|
3722
|
+
/**
|
|
3723
|
+
* List or search the calling practitioner's own patients (GET /patients), one page at a time. Never tenant-wide: only patients assigned to the caller. `q` matches the start of a given or
|
|
3724
|
+
* family name; pass the previous page's `next_page_token` as `page_token` to read on. `page_size` is 1-100 (default 20).
|
|
3725
|
+
*/
|
|
3726
|
+
listPatients(filters) {
|
|
3727
|
+
return this.send("GET", "/patients", { query: filters });
|
|
3728
|
+
}
|
|
3729
|
+
/** Create a patient assigned to the calling practitioner (POST /patients). Returns the patient's demographic summary. */
|
|
3730
|
+
createPatient(request) {
|
|
3731
|
+
return this.send("POST", "/patients", { body: request });
|
|
3732
|
+
}
|
|
3733
|
+
/** Counts for the home screen (GET /dashboard/summary): the caller's own patients and encounters by status. */
|
|
3734
|
+
getHomeSummary() {
|
|
3735
|
+
return this.send("GET", "/dashboard/summary", {});
|
|
3736
|
+
}
|
|
3737
|
+
/** Place a real Quest lab order for a patient (POST /patients/{patient_id}/lab-orders). Confirm the tests with the clinician first. */
|
|
3738
|
+
placeLabOrder(patientId, request) {
|
|
3739
|
+
return this.send("POST", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, body: request });
|
|
3740
|
+
}
|
|
3741
|
+
/** List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or rejected). */
|
|
3742
|
+
listLabOrders(patientId, filters) {
|
|
3743
|
+
return this.send("GET", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, query: filters });
|
|
3744
|
+
}
|
|
3745
|
+
/** Get one lab order (GET /patients/{patient_id}/lab-orders/{order_id}). */
|
|
3746
|
+
getLabOrder(patientId, orderId) {
|
|
3747
|
+
return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}", { pathParams: { patient_id: patientId, order_id: orderId } });
|
|
3748
|
+
}
|
|
3749
|
+
/** Get a lab order's Quest requisition PDF (GET /patients/{patient_id}/lab-orders/{order_id}/requisition). */
|
|
3750
|
+
getLabOrderRequisition(patientId, orderId) {
|
|
3751
|
+
return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}/requisition", { pathParams: { patient_id: patientId, order_id: orderId } });
|
|
3752
|
+
}
|
|
3676
3753
|
/** Get a patient's consolidated health record (provider tenant scope). */
|
|
3677
3754
|
getPatientRecord(patientId) {
|
|
3678
3755
|
return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
|
|
@@ -53,6 +53,7 @@
|
|
|
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
|
|
56
57
|
- [`getPatientEncounterOperation`](../operations/patient.getPatientEncounterOperation.md) — Read the logged-in patient's keyed encounter journal state
|
|
57
58
|
- [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
|
|
58
59
|
- [`getPatientFlagsOperation`](../operations/patient.getPatientFlagsOperation.md) — Look up a keyed patient flag receipt
|
|
@@ -3,10 +3,14 @@
|
|
|
3
3
|
- [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
|
|
4
4
|
- [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
|
|
5
5
|
- [`connect`](../operations/provider.connect.md) — Health check
|
|
6
|
+
- [`createPatient`](../operations/provider.createPatient.md) — Create a patient on the calling practitioner's care team
|
|
6
7
|
- [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
|
|
7
8
|
- [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
|
|
8
9
|
- [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
|
|
9
10
|
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one encounter with patient demographics
|
|
11
|
+
- [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
|
|
12
|
+
- [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
|
|
13
|
+
- [`getLabOrderRequisition`](../operations/provider.getLabOrderRequisition.md) — Get the Quest requisition PDF of a lab order
|
|
10
14
|
- [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
|
|
11
15
|
- [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
|
|
12
16
|
- [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
|
|
@@ -14,9 +18,12 @@
|
|
|
14
18
|
- [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
|
|
15
19
|
- [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
|
|
16
20
|
- [`listEncounters`](../operations/provider.listEncounters.md) — List tenant encounters
|
|
21
|
+
- [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
|
|
22
|
+
- [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
|
|
17
23
|
- [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
|
|
18
24
|
- [`login`](../operations/provider.login.md) — Log in a practitioner
|
|
19
25
|
- [`logout`](../operations/provider.logout.md) — Sign out the practitioner and revoke their tokens
|
|
26
|
+
- [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
|
|
20
27
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
21
28
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
22
29
|
- [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:37a2d5556a9c16b7444db88d7c73bffc9b0ad52670ecbf9cfe0f07ced9817813",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -508,6 +508,7 @@
|
|
|
508
508
|
"models/CreateMedicationRequest.md",
|
|
509
509
|
"models/CreateMedicationResponse.md",
|
|
510
510
|
"models/CreatePatientTokenRequest.md",
|
|
511
|
+
"models/CreateProviderPatientRequest.md",
|
|
511
512
|
"models/CreateProviderTokenRequest.md",
|
|
512
513
|
"models/CreateQuestionnaireRequest.md",
|
|
513
514
|
"models/CreateQuestionnaireResponse.md",
|
|
@@ -581,6 +582,7 @@
|
|
|
581
582
|
"models/ElevenlabsUpdateToolRequest.md",
|
|
582
583
|
"models/EmergencyContact.md",
|
|
583
584
|
"models/EncounterClass.md",
|
|
585
|
+
"models/EncounterClinicalState.md",
|
|
584
586
|
"models/EncounterEffect.md",
|
|
585
587
|
"models/EncounterOperationError.md",
|
|
586
588
|
"models/EncounterOperationResponse.md",
|
|
@@ -1241,6 +1243,14 @@
|
|
|
1241
1243
|
"models/KnowledgeCollection.md",
|
|
1242
1244
|
"models/KnowledgeEntrySummary.md",
|
|
1243
1245
|
"models/KnowledgeSearchResult.md",
|
|
1246
|
+
"models/LabOrder.md",
|
|
1247
|
+
"models/LabOrderDiagnosis.md",
|
|
1248
|
+
"models/LabOrderErrorResponse.md",
|
|
1249
|
+
"models/LabOrderItemRequest.md",
|
|
1250
|
+
"models/LabOrderProvider.md",
|
|
1251
|
+
"models/LabOrderRequisitionResponse.md",
|
|
1252
|
+
"models/LabOrderTest.md",
|
|
1253
|
+
"models/LabOrderUnsentItem.md",
|
|
1244
1254
|
"models/LicenseVerification.md",
|
|
1245
1255
|
"models/ListActionsResponse.md",
|
|
1246
1256
|
"models/ListActivityResponse.md",
|
|
@@ -1255,6 +1265,7 @@
|
|
|
1255
1265
|
"models/ListImmunizationsResponse.md",
|
|
1256
1266
|
"models/ListImpiloDevicesResponse.md",
|
|
1257
1267
|
"models/ListKnowledgeResponse.md",
|
|
1268
|
+
"models/ListLabOrdersResponse.md",
|
|
1258
1269
|
"models/ListMedicalConceptsGetResponse.md",
|
|
1259
1270
|
"models/ListNotificationsResponse.md",
|
|
1260
1271
|
"models/ListObservationsResponse.md",
|
|
@@ -1402,6 +1413,8 @@
|
|
|
1402
1413
|
"models/PersonRelationship.md",
|
|
1403
1414
|
"models/Phone.md",
|
|
1404
1415
|
"models/PhoneType.md",
|
|
1416
|
+
"models/PlaceLabOrderRequest.md",
|
|
1417
|
+
"models/PlaceLabOrderResponse.md",
|
|
1405
1418
|
"models/PlaceTestOrderRequest.md",
|
|
1406
1419
|
"models/PlaceTestOrderResponse.md",
|
|
1407
1420
|
"models/PlaidCreateIdentityVerificationRequest.md",
|
|
@@ -1432,7 +1445,9 @@
|
|
|
1432
1445
|
"models/ProviderEncounterListResponse.md",
|
|
1433
1446
|
"models/ProviderEncounterRecord.md",
|
|
1434
1447
|
"models/ProviderEncounterResponse.md",
|
|
1448
|
+
"models/ProviderEncounterStatusCounts.md",
|
|
1435
1449
|
"models/ProviderGender.md",
|
|
1450
|
+
"models/ProviderHomeSummaryResponse.md",
|
|
1436
1451
|
"models/ProviderIdentifier.md",
|
|
1437
1452
|
"models/ProviderIdentifierType.md",
|
|
1438
1453
|
"models/ProviderLanguage.md",
|
|
@@ -1445,9 +1460,11 @@
|
|
|
1445
1460
|
"models/ProviderLocationRequest.md",
|
|
1446
1461
|
"models/ProviderOnboardingStatus.md",
|
|
1447
1462
|
"models/ProviderPatientAddress.md",
|
|
1463
|
+
"models/ProviderPatientListResponse.md",
|
|
1448
1464
|
"models/ProviderPatientPhone.md",
|
|
1449
1465
|
"models/ProviderPatientRecordResources.md",
|
|
1450
1466
|
"models/ProviderPatientRecordResponse.md",
|
|
1467
|
+
"models/ProviderPatientResponse.md",
|
|
1451
1468
|
"models/ProviderPatientSummary.md",
|
|
1452
1469
|
"models/ProviderPostgraduateTraining.md",
|
|
1453
1470
|
"models/ProviderProfessionalLiability.md",
|
|
@@ -3140,6 +3157,7 @@
|
|
|
3140
3157
|
"operations/patient.getPatientAlerts.md",
|
|
3141
3158
|
"operations/patient.getPatientAttributes.md",
|
|
3142
3159
|
"operations/patient.getPatientDashboard.md",
|
|
3160
|
+
"operations/patient.getPatientEncounterClinicalState.md",
|
|
3143
3161
|
"operations/patient.getPatientEncounterOperation.md",
|
|
3144
3162
|
"operations/patient.getPatientFlags.md",
|
|
3145
3163
|
"operations/patient.getPatientFlagsOperation.md",
|
|
@@ -3215,10 +3233,14 @@
|
|
|
3215
3233
|
"operations/provider.completePractitionerOnboarding.md",
|
|
3216
3234
|
"operations/provider.confirmResetPassword.md",
|
|
3217
3235
|
"operations/provider.connect.md",
|
|
3236
|
+
"operations/provider.createPatient.md",
|
|
3218
3237
|
"operations/provider.createPractitionerLocation.md",
|
|
3219
3238
|
"operations/provider.deletePractitionerLocation.md",
|
|
3220
3239
|
"operations/provider.getAppointment.md",
|
|
3221
3240
|
"operations/provider.getEncounter.md",
|
|
3241
|
+
"operations/provider.getHomeSummary.md",
|
|
3242
|
+
"operations/provider.getLabOrder.md",
|
|
3243
|
+
"operations/provider.getLabOrderRequisition.md",
|
|
3222
3244
|
"operations/provider.getPatientRecord.md",
|
|
3223
3245
|
"operations/provider.getPhoto.md",
|
|
3224
3246
|
"operations/provider.getPhotoUploadUrl.md",
|
|
@@ -3226,9 +3248,12 @@
|
|
|
3226
3248
|
"operations/provider.getPractitionerLocation.md",
|
|
3227
3249
|
"operations/provider.listAppointments.md",
|
|
3228
3250
|
"operations/provider.listEncounters.md",
|
|
3251
|
+
"operations/provider.listLabOrders.md",
|
|
3252
|
+
"operations/provider.listPatients.md",
|
|
3229
3253
|
"operations/provider.listPractitionerLocations.md",
|
|
3230
3254
|
"operations/provider.login.md",
|
|
3231
3255
|
"operations/provider.logout.md",
|
|
3256
|
+
"operations/provider.placeLabOrder.md",
|
|
3232
3257
|
"operations/provider.refreshToken.md",
|
|
3233
3258
|
"operations/provider.register.md",
|
|
3234
3259
|
"operations/provider.resendVerificationCode.md",
|
|
@@ -3254,7 +3279,7 @@
|
|
|
3254
3279
|
"operations/vitals.recordVitals.md"
|
|
3255
3280
|
],
|
|
3256
3281
|
"language": "nodejs",
|
|
3257
|
-
"modelCount":
|
|
3258
|
-
"operationCount":
|
|
3282
|
+
"modelCount": 2160,
|
|
3283
|
+
"operationCount": 1062,
|
|
3259
3284
|
"schemaVersion": 1
|
|
3260
3285
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -944,6 +944,7 @@ 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)
|
|
947
948
|
- [Read the logged-in patient's keyed encounter journal state](../operations/patient.getPatientEncounterOperation.md)
|
|
948
949
|
- [Get patient flags](../operations/patient.getPatientFlags.md)
|
|
949
950
|
- [Look up a keyed patient flag receipt](../operations/patient.getPatientFlagsOperation.md)
|
|
@@ -1019,10 +1020,14 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1019
1020
|
- [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
|
|
1020
1021
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
1021
1022
|
- [Health check](../operations/provider.connect.md)
|
|
1023
|
+
- [Create a patient on the calling practitioner's care team](../operations/provider.createPatient.md)
|
|
1022
1024
|
- [Add a practice location](../operations/provider.createPractitionerLocation.md)
|
|
1023
1025
|
- [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
|
|
1024
1026
|
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
1025
1027
|
- [Get one encounter with patient demographics](../operations/provider.getEncounter.md)
|
|
1028
|
+
- [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
|
|
1029
|
+
- [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
|
|
1030
|
+
- [Get the Quest requisition PDF of a lab order](../operations/provider.getLabOrderRequisition.md)
|
|
1026
1031
|
- [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
|
|
1027
1032
|
- [Get a practitioner photo](../operations/provider.getPhoto.md)
|
|
1028
1033
|
- [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
|
|
@@ -1030,9 +1035,12 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1030
1035
|
- [Get one practice location](../operations/provider.getPractitionerLocation.md)
|
|
1031
1036
|
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
1032
1037
|
- [List tenant encounters](../operations/provider.listEncounters.md)
|
|
1038
|
+
- [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
|
|
1039
|
+
- [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
|
|
1033
1040
|
- [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
|
|
1034
1041
|
- [Log in a practitioner](../operations/provider.login.md)
|
|
1035
1042
|
- [Sign out the practitioner and revoke their tokens](../operations/provider.logout.md)
|
|
1043
|
+
- [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
|
|
1036
1044
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1037
1045
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1038
1046
|
- [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
|
package/docs/index.md
CHANGED
|
@@ -952,6 +952,7 @@ 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`)
|
|
955
956
|
- [Read the logged-in patient's keyed encounter journal state](operations/patient.getPatientEncounterOperation.md) (`patient.getPatientEncounterOperation`)
|
|
956
957
|
- [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
|
|
957
958
|
- [Look up a keyed patient flag receipt](operations/patient.getPatientFlagsOperation.md) (`patient.getPatientFlagsOperation`)
|
|
@@ -1027,10 +1028,14 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1027
1028
|
- [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
|
|
1028
1029
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
1029
1030
|
- [Health check](operations/provider.connect.md) (`provider.connect`)
|
|
1031
|
+
- [Create a patient on the calling practitioner's care team](operations/provider.createPatient.md) (`provider.createPatient`)
|
|
1030
1032
|
- [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
|
|
1031
1033
|
- [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
|
|
1032
1034
|
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
1033
1035
|
- [Get one encounter with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
|
|
1036
|
+
- [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
|
|
1037
|
+
- [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
|
|
1038
|
+
- [Get the Quest requisition PDF of a lab order](operations/provider.getLabOrderRequisition.md) (`provider.getLabOrderRequisition`)
|
|
1034
1039
|
- [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
|
|
1035
1040
|
- [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
|
|
1036
1041
|
- [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
|
|
@@ -1038,9 +1043,12 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1038
1043
|
- [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
|
|
1039
1044
|
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
1040
1045
|
- [List tenant encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
|
|
1046
|
+
- [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
|
|
1047
|
+
- [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
|
|
1041
1048
|
- [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
|
|
1042
1049
|
- [Log in a practitioner](operations/provider.login.md) (`provider.login`)
|
|
1043
1050
|
- [Sign out the practitioner and revoke their tokens](operations/provider.logout.md) (`provider.logout`)
|
|
1051
|
+
- [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
|
|
1044
1052
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1045
1053
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1046
1054
|
- [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CreateProviderPatientRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `CreateProviderPatientRequest`
|
|
4
|
+
|
|
5
|
+
A new patient, assigned to the calling practitioner.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `date_of_birth` | `string` | Yes | date | | | No | Patient's date of birth (ISO date, not in the future). |
|
|
14
|
+
| `email` | `string|null` | No | | | | Yes | Patient's email address, when known. |
|
|
15
|
+
| `first_name` | `string` | Yes | | | | No | Patient's first (given) name. |
|
|
16
|
+
| `gender` | `string` | Yes | | male, female, other, unknown | | No | Administrative gender. |
|
|
17
|
+
| `last_name` | `string` | Yes | | | | No | Patient's last (family) name. |
|
|
18
|
+
| `phone` | `string|null` | No | | | | Yes | Patient's mobile phone number, 10-15 digits with an optional leading +. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
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,35 @@
|
|
|
1
|
+
# LabOrder
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrder`
|
|
4
|
+
|
|
5
|
+
One Quest requisition (one FHIR ServiceRequest).
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `abn_required` | `boolean` | Yes | | | | No | Quest flagged an Advance Beneficiary Notice. |
|
|
14
|
+
| `ack_code` | `string|null` | No | | | | Yes | Quest MSA-1 acknowledgment code (AA, AE, AR). |
|
|
15
|
+
| `authored_at` | `string|null` | No | | | | Yes | When the order was placed, ISO 8601 with offset. |
|
|
16
|
+
| `collection_modality` | `string` | Yes | | psc, home_kit | | No | |
|
|
17
|
+
| `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | |
|
|
18
|
+
| `expected_collection_at` | `string|null` | No | | | | Yes | OBR-7: expected PSC visit or kit collection. |
|
|
19
|
+
| `fhir_status` | `string` | Yes | | | | No | ServiceRequest.status: draft, active, completed (Quest reported every test final) or revoked. |
|
|
20
|
+
| `lab` | `string` | Yes | | | | No | Quest performing lab, MET. |
|
|
21
|
+
| `order_group_id` | `string` | Yes | | | | No | Shared by the requisitions of one placed order (ServiceRequest.requisition). |
|
|
22
|
+
| `order_id` | `string` | Yes | | | | No | FHIR ServiceRequest id. |
|
|
23
|
+
| `ordering_provider` | [`LabOrderProvider`](./LabOrderProvider.md) | Yes | | | | No | |
|
|
24
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
25
|
+
| `placer_order_number` | `string` | Yes | | | | No | Quest Lab Reference Number (ORC-2), printed on the requisition. |
|
|
26
|
+
| `quest_http_status` | `integer|null` | No | | | | Yes | HTTP status when Quest refused the request itself. |
|
|
27
|
+
| `requester` | `string|null` | No | | | | Yes | Who placed the order, e.g. Practitioner/{id}. |
|
|
28
|
+
| `requisition_available` | `boolean` | Yes | | | | No | A requisition PDF is stored; see .../requisition. |
|
|
29
|
+
| `source` | `string` | Yes | | provider_app, athena_ori | | No | |
|
|
30
|
+
| `status` | `string` | Yes | | submitting, accepted, rejected | | No | submitting: Quest's answer is not known yet; retry POST with the same idempotency_key. accepted: Quest answered AA. rejected: Quest refused it; the idempotency_key is used up. |
|
|
31
|
+
| `tests` | array of [`LabOrderTest`](./LabOrderTest.md) | Yes | | | | No | |
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# LabOrderDiagnosis
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderDiagnosis`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | ICD-10-CM code with its dot, e.g. R53.83. |
|
|
14
|
+
| `description` | `string|null` | No | | | | Yes | Printed on the requisition (DG1-4). |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# LabOrderErrorResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderErrorResponse`
|
|
4
|
+
|
|
5
|
+
4xx/503 body of the lab-order routes; ``fields`` name request or configuration fields only.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `code` | `string` | Yes | | | | No | Stable error code, e.g. aoe_answer_missing or quest_rejected. |
|
|
14
|
+
| `error` | `string` | Yes | | | | No | Human-readable explanation of why the request failed. |
|
|
15
|
+
| `fields` | `array` | No | | | | No | Offending fields, e.g. aoe_answers.395.75400658; a panel member is catalog_items.{id}. |
|
|
16
|
+
| `order_group_id` | `string|null` | No | | | | Yes | Set with code quest_rejected. |
|
|
17
|
+
| `orders` | array of [`LabOrder`](./LabOrder.md) | No | | | | No | With code quest_rejected: every requisition, so accepted ones are not re-ordered. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# LabOrderItemRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderItemRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `catalog_item_id` | `string` | Yes | uuid | | | No | Diagnostic catalog test or panel id; a panel is expanded to its tests. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LabOrderProvider
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderProvider`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `first_name` | `string` | Yes | | | | No | |
|
|
14
|
+
| `last_name` | `string` | Yes | | | | No | |
|
|
15
|
+
| `npi` | `string` | Yes | | | | No | Ordering provider NPI sent in ORC-12/OBR-16. |
|
|
16
|
+
| `source` | `string` | Yes | | roster, default_provider | | No | roster: the caller's own entry in the tenant's Quest roster. default_provider: the tenant default provider, for callers the tenant authorizes to order under it. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LabOrderRequisitionResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderRequisitionResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `content_type` | `string` | Yes | | | | No | application/pdf |
|
|
14
|
+
| `data_b64` | `string` | Yes | | | | No | Base64 requisition PDF, as Quest returned it. |
|
|
15
|
+
| `document_id` | `string` | Yes | | | | No | FHIR DocumentReference id. |
|
|
16
|
+
| `order_id` | `string` | Yes | | | | No | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# LabOrderTest
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderTest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `catalog_item_id` | `string` | Yes | | | | No | Catalog test that put this code on the requisition. |
|
|
14
|
+
| `description` | `string` | Yes | | | | No | Quest compendium description. |
|
|
15
|
+
| `quest_code` | `string` | Yes | | | | No | Quest order code sent in OBR-4. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# LabOrderUnsentItem
|
|
2
|
+
|
|
3
|
+
Model ID: `LabOrderUnsentItem`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `catalog_item_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `name` | `string` | Yes | | | | No | |
|
|
15
|
+
| `reason` | `string` | Yes | | | | No | Rapid tests are ordered through the kit flow, not Quest. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ListLabOrdersResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListLabOrdersResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `orders` | array of [`LabOrder`](./LabOrder.md) | Yes | | | | No | |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# PlaceLabOrderRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `PlaceLabOrderRequest`
|
|
4
|
+
|
|
5
|
+
Body of POST /patients/{patient_id}/lab-orders.
|
|
6
|
+
|
|
7
|
+
The service checks the rest: AOE answers against the stored Quest
|
|
8
|
+
compendium, ASCII-only text, the IANA time zone and the 60-character NTE limit.
|
|
9
|
+
|
|
10
|
+
Type: `object`
|
|
11
|
+
|
|
12
|
+
## Fields
|
|
13
|
+
|
|
14
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
15
|
+
|---|---|---:|---|---|---|---:|---|
|
|
16
|
+
| `aoe_answers` | `object` | No | | | | No | Ask-at-order-entry answers: Quest test code -> question code -> answer. Every active question of every ordered Quest code is required; the question text comes from the compendium. |
|
|
17
|
+
| `collection_timezone` | `string` | Yes | | | | No | IANA time zone of the collection site, e.g. America/New_York. |
|
|
18
|
+
| `comments` | `array` | No | | | | No | Order notes, at most 60 characters each (NTE). |
|
|
19
|
+
| `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | Unique ICD-10-CM codes. |
|
|
20
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter of this patient the order belongs to. |
|
|
21
|
+
| `expected_collection_date` | `string|null` | No | | | | Yes | Expected PSC visit, local date; defaults to tomorrow. Not before today. |
|
|
22
|
+
| `idempotency_key` | `string` | Yes | uuid | | | No | New UUID per order. A retry after 202, a timeout or a 5xx must reuse it with the same body. |
|
|
23
|
+
| `items` | array of [`LabOrderItemRequest`](./LabOrderItemRequest.md) | Yes | | | | No | Catalog tests and panels. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PlaceLabOrderResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `PlaceLabOrderResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `order_group_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `orders` | array of [`LabOrder`](./LabOrder.md) | Yes | | | | No | One per Quest requisition: one per collection modality. |
|
|
15
|
+
| `replayed` | `boolean` | Yes | | | | No | Every requisition already existed and was not sent again by this call. |
|
|
16
|
+
| `unsent_items` | array of [`LabOrderUnsentItem`](./LabOrderUnsentItem.md) | No | | | | No | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|