@healthcloudai/hc-sdk 2.6.1 → 2.6.2
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.d.cts +20 -8
- package/dist/index.d.ts +20 -8
- package/docs/docs-manifest.json +1 -1
- package/docs/models/InitHealthRecordImportResponse.md +2 -0
- package/docs/models/fieldagent.ResetPasswordRequest.md +1 -1
- package/docs/models/person.ResetPasswordRequest.md +1 -1
- package/docs/models/provider.ResetPasswordRequest.md +1 -1
- package/docs/operations/diagnostics.getTestResult.md +1 -1
- package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
- package/docs/operations/fieldagent.resetPassword.md +1 -1
- package/docs/operations/patient.initHealthRecordImport.md +3 -1
- package/docs/operations/patient.resetPassword.md +1 -1
- package/docs/operations/person.resetPassword.md +1 -1
- package/docs/operations/provider.resetPassword.md +1 -1
- package/package.json +1 -1
- /package/docs/models/{GoogleAiEmbedRequest.md → GoogleAIEmbedRequest.md} +0 -0
- /package/docs/models/{GoogleAiGenerateRequest.md → GoogleAIGenerateRequest.md} +0 -0
- /package/docs/models/{GoogleAiInvokeA1cVisionCaptureRequest.md → GoogleAIInvokeA1cVisionCaptureRequest.md} +0 -0
- /package/docs/models/{OpenaiBuildResponseCreatePayloadRequest.md → OpenAIBuildResponseCreatePayloadRequest.md} +0 -0
- /package/docs/models/{OpenaiChatJsonRequest.md → OpenAIChatJsonRequest.md} +0 -0
- /package/docs/models/{OpenaiChatRequest.md → OpenAIChatRequest.md} +0 -0
- /package/docs/models/{OpenaiCreateAssistantRequest.md → OpenAICreateAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiDeleteAssistantRequest.md → OpenAIDeleteAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiEmbedRequest.md → OpenAIEmbedRequest.md} +0 -0
- /package/docs/models/{OpenaiGetAssistantRequest.md → OpenAIGetAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiModerateRequest.md → OpenAIModerateRequest.md} +0 -0
- /package/docs/models/{OpenaiUpdateAssistantRequest.md → OpenAIUpdateAssistantRequest.md} +0 -0
- /package/docs/models/{SendgridListTemplatesRequest.md → SendGridListTemplatesRequest.md} +0 -0
- /package/docs/models/{SteadymdAddAllergyIntoleranceRequest.md → SteadyMDAddAllergyIntoleranceRequest.md} +0 -0
- /package/docs/models/{SteadymdClaimIdentityVerificationRequest.md → SteadyMDClaimIdentityVerificationRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultRequest.md → SteadyMDCreateConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeLabRequisitionRequest.md → SteadyMDCreateEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeRequest.md → SteadyMDCreateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateIntakeRequest.md → SteadyMDCreateIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderRequest.md → SteadyMDCreateLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderResultRequest.md → SteadyMDCreateLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateMessageRequest.md → SteadyMDCreateMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdCreatePatientRequest.md → SteadyMDCreatePatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetClinicianRequest.md → SteadyMDGetClinicianRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultAvailabilityRequest.md → SteadyMDGetConsultAvailabilityRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultRequest.md → SteadyMDGetConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeLabRequisitionRequest.md → SteadyMDGetEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeRequest.md → SteadyMDGetEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeSignedDocumentsRequest.md → SteadyMDGetEpisodeSignedDocumentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetIntakeRequest.md → SteadyMDGetIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderPdfRequest.md → SteadyMDGetLabOrderPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderRequest.md → SteadyMDGetLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetMessageRequest.md → SteadyMDGetMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdGetPatientRequest.md → SteadyMDGetPatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramAppointmentsRequest.md → SteadyMDGetProgramAppointmentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramConsultOptionsRequest.md → SteadyMDGetProgramConsultOptionsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramLabsRequest.md → SteadyMDGetProgramLabsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramRequest.md → SteadyMDGetProgramRequest.md} +0 -0
- /package/docs/models/{SteadymdListConsultsRequest.md → SteadyMDListConsultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListIntakesRequest.md → SteadyMDListIntakesRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrdersRequest.md → SteadyMDListLabOrdersRequest.md} +0 -0
- /package/docs/models/{SteadymdListMessagesRequest.md → SteadyMDListMessagesRequest.md} +0 -0
- /package/docs/models/{SteadymdListPharmaciesRequest.md → SteadyMDListPharmaciesRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramCliniciansRequest.md → SteadyMDListProgramCliniciansRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramsRequest.md → SteadyMDListProgramsRequest.md} +0 -0
- /package/docs/models/{SteadymdPatchEpisodeRequest.md → SteadyMDPatchEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdScheduleConsultAppointmentRequest.md → SteadyMDScheduleConsultAppointmentRequest.md} +0 -0
- /package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateEpisodeRequest.md → SteadyMDUpdateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateIntakeRequest.md → SteadyMDUpdateIntakeRequest.md} +0 -0
package/dist/index.d.cts
CHANGED
|
@@ -761,6 +761,11 @@ interface Gs1LookupQuery {
|
|
|
761
761
|
gs1: string;
|
|
762
762
|
}
|
|
763
763
|
interface Gs1LookupResult {
|
|
764
|
+
gs1_parsed?: Record<string, unknown>;
|
|
765
|
+
product?: Record<string, unknown> | null;
|
|
766
|
+
raw_gs1?: string;
|
|
767
|
+
/** Present only when the parsed GTIN supports SAFE CDX image processing (currently OraQuick HIV). */
|
|
768
|
+
scan_upload?: ScanUploadUrlResponse;
|
|
764
769
|
[key: string]: unknown;
|
|
765
770
|
}
|
|
766
771
|
interface ScanUploadUrlRequest {
|
|
@@ -772,7 +777,10 @@ interface ScanUploadUrlRequest {
|
|
|
772
777
|
content_type?: string;
|
|
773
778
|
}
|
|
774
779
|
interface ScanUploadUrlResponse {
|
|
780
|
+
test_id?: string;
|
|
775
781
|
upload_url?: string;
|
|
782
|
+
expires_in?: number;
|
|
783
|
+
storage_key?: string;
|
|
776
784
|
[key: string]: unknown;
|
|
777
785
|
}
|
|
778
786
|
type RapidTestType$1 = "covid19" | "influenza_a" | "influenza_b" | "rsv" | "strep" | "hiv" | "pregnancy" | "mono" | "uti_dipstick" | "blood_glucose" | "other";
|
|
@@ -795,15 +803,19 @@ interface RapidTestResponse {
|
|
|
795
803
|
encounter_id?: string;
|
|
796
804
|
[key: string]: unknown;
|
|
797
805
|
}
|
|
806
|
+
/**
|
|
807
|
+
* SAFE CDX processed-result envelope actually returned by the backend
|
|
808
|
+
* (hc/apis/diagnostics/src/app.py::get_test_result on healthcloud-services
|
|
809
|
+
* main) — clinical/CVML fields live under `data`, not top-level. The
|
|
810
|
+
* backend's own OpenAPI contract does not declare a response schema for
|
|
811
|
+
* this operation yet, so this is authored from observed behavior rather
|
|
812
|
+
* than the (stale) pinned contract.
|
|
813
|
+
*/
|
|
798
814
|
interface TestResult {
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
result?: Record<string, unknown>;
|
|
804
|
-
panels?: Record<string, unknown>[];
|
|
805
|
-
created_at?: string;
|
|
806
|
-
updated_at?: string;
|
|
815
|
+
success?: boolean;
|
|
816
|
+
data?: Record<string, unknown>;
|
|
817
|
+
message?: string;
|
|
818
|
+
code?: number;
|
|
807
819
|
[key: string]: unknown;
|
|
808
820
|
}
|
|
809
821
|
|
package/dist/index.d.ts
CHANGED
|
@@ -761,6 +761,11 @@ interface Gs1LookupQuery {
|
|
|
761
761
|
gs1: string;
|
|
762
762
|
}
|
|
763
763
|
interface Gs1LookupResult {
|
|
764
|
+
gs1_parsed?: Record<string, unknown>;
|
|
765
|
+
product?: Record<string, unknown> | null;
|
|
766
|
+
raw_gs1?: string;
|
|
767
|
+
/** Present only when the parsed GTIN supports SAFE CDX image processing (currently OraQuick HIV). */
|
|
768
|
+
scan_upload?: ScanUploadUrlResponse;
|
|
764
769
|
[key: string]: unknown;
|
|
765
770
|
}
|
|
766
771
|
interface ScanUploadUrlRequest {
|
|
@@ -772,7 +777,10 @@ interface ScanUploadUrlRequest {
|
|
|
772
777
|
content_type?: string;
|
|
773
778
|
}
|
|
774
779
|
interface ScanUploadUrlResponse {
|
|
780
|
+
test_id?: string;
|
|
775
781
|
upload_url?: string;
|
|
782
|
+
expires_in?: number;
|
|
783
|
+
storage_key?: string;
|
|
776
784
|
[key: string]: unknown;
|
|
777
785
|
}
|
|
778
786
|
type RapidTestType$1 = "covid19" | "influenza_a" | "influenza_b" | "rsv" | "strep" | "hiv" | "pregnancy" | "mono" | "uti_dipstick" | "blood_glucose" | "other";
|
|
@@ -795,15 +803,19 @@ interface RapidTestResponse {
|
|
|
795
803
|
encounter_id?: string;
|
|
796
804
|
[key: string]: unknown;
|
|
797
805
|
}
|
|
806
|
+
/**
|
|
807
|
+
* SAFE CDX processed-result envelope actually returned by the backend
|
|
808
|
+
* (hc/apis/diagnostics/src/app.py::get_test_result on healthcloud-services
|
|
809
|
+
* main) — clinical/CVML fields live under `data`, not top-level. The
|
|
810
|
+
* backend's own OpenAPI contract does not declare a response schema for
|
|
811
|
+
* this operation yet, so this is authored from observed behavior rather
|
|
812
|
+
* than the (stale) pinned contract.
|
|
813
|
+
*/
|
|
798
814
|
interface TestResult {
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
result?: Record<string, unknown>;
|
|
804
|
-
panels?: Record<string, unknown>[];
|
|
805
|
-
created_at?: string;
|
|
806
|
-
updated_at?: string;
|
|
815
|
+
success?: boolean;
|
|
816
|
+
data?: Record<string, unknown>;
|
|
817
|
+
message?: string;
|
|
818
|
+
code?: number;
|
|
807
819
|
[key: string]: unknown;
|
|
808
820
|
}
|
|
809
821
|
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:90801279447f9821beec4a9253955e18ac6c540dfdeee67576aa32c734ef6038",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -11,6 +11,8 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `imported` | `boolean` | Yes | | | | No | True when the health-record import was initiated successfully. |
|
|
14
|
+
| `run_id` | `string|null` | No | | | | Yes | Runner run id for correlating the async import. |
|
|
15
|
+
| `status` | `string|null` | No | | | | Yes | Runner-reported status of the triggered run (e.g. accepted). |
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Model ID: `fieldagent.ResetPasswordRequest`
|
|
4
4
|
|
|
5
5
|
Request body for POST /auth/reset-password — starts Cognito's
|
|
6
|
-
|
|
6
|
+
password reset flow. A confirmation code is emailed via SendGrid; the
|
|
7
7
|
client then calls fieldagent.confirmResetPassword with that code.
|
|
8
8
|
|
|
9
9
|
Type: `object`
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Model ID: `person.ResetPasswordRequest`
|
|
4
4
|
|
|
5
5
|
Request body for POST /auth/reset-password — starts Cognito's
|
|
6
|
-
|
|
6
|
+
password reset flow. A confirmation code is emailed via SendGrid; the
|
|
7
7
|
client then calls person.confirmResetPassword with that code.
|
|
8
8
|
|
|
9
9
|
Type: `object`
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Model ID: `provider.ResetPasswordRequest`
|
|
4
4
|
|
|
5
5
|
Request body for POST /auth/reset-password — starts Cognito's
|
|
6
|
-
|
|
6
|
+
password reset flow. A confirmation code is emailed via SendGrid; the
|
|
7
7
|
client then calls provider.confirmResetPassword with that code.
|
|
8
8
|
|
|
9
9
|
Type: `object`
|
|
@@ -151,7 +151,7 @@ curl -X GET \
|
|
|
151
151
|
|
|
152
152
|
## Notes
|
|
153
153
|
|
|
154
|
-
|
|
154
|
+
- Interim note pending a backend contract update: since the SAFE CDX integration (merged to healthcloud-services main 2026-08-21), the live response no longer matches the `SingleTestResultResponse` schema shown on this page. The actual response is `{success: boolean, data: object, message: string, code: integer}`, where `data` carries the processed SAFE CVML result (including `userID`, `testID`, `uploadID`, and analyte-specific fields) rather than the documented `test_id`/`patient_id`/`panels` fields. `SingleTestResultResponse` will be replaced once the backend declares a typed response model for this operation and the contract is re-synced. Confirmed live against DEV on 2026-08-21.
|
|
155
155
|
|
|
156
156
|
## Prepared Test Console scenario
|
|
157
157
|
|
|
@@ -149,7 +149,7 @@ curl -X GET \
|
|
|
149
149
|
|
|
150
150
|
## Notes
|
|
151
151
|
|
|
152
|
-
|
|
152
|
+
- Interim note pending a backend contract update: since the SAFE CDX integration (merged to healthcloud-services main 2026-08-21), for the OraQuick HIV GTIN (00608337001792) the live response also includes a `scan_upload` field — `{test_id, upload_url, expires_in, storage_key}`, a SAFE CDX presigned S3 upload URL generated inline. This field is not yet declared on the `GS1LookupResponse` schema shown on this page; it will appear once the backend contract is re-synced. Confirmed live against DEV on 2026-08-21.
|
|
153
153
|
|
|
154
154
|
## Prepared Test Console scenario
|
|
155
155
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `fieldagent.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to fieldagent.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password-reset confirmation code and email it to the patient via SendGrid. No authentication is required. Follow up with `patient.confirmResetPassword` once the code is received.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `person.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to person.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `provider.resetPassword`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate a password reset code and email it to the account via SendGrid; the client submits that code plus the new password to provider.confirmResetPassword — no other server round-trip is needed in between.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
package/package.json
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md}
RENAMED
|
File without changes
|
/package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md}
RENAMED
|
File without changes
|
/package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|