@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.
Files changed (71) hide show
  1. package/dist/index.d.cts +20 -8
  2. package/dist/index.d.ts +20 -8
  3. package/docs/docs-manifest.json +1 -1
  4. package/docs/models/InitHealthRecordImportResponse.md +2 -0
  5. package/docs/models/fieldagent.ResetPasswordRequest.md +1 -1
  6. package/docs/models/person.ResetPasswordRequest.md +1 -1
  7. package/docs/models/provider.ResetPasswordRequest.md +1 -1
  8. package/docs/operations/diagnostics.getTestResult.md +1 -1
  9. package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
  10. package/docs/operations/fieldagent.resetPassword.md +1 -1
  11. package/docs/operations/patient.initHealthRecordImport.md +3 -1
  12. package/docs/operations/patient.resetPassword.md +1 -1
  13. package/docs/operations/person.resetPassword.md +1 -1
  14. package/docs/operations/provider.resetPassword.md +1 -1
  15. package/package.json +1 -1
  16. /package/docs/models/{GoogleAiEmbedRequest.md → GoogleAIEmbedRequest.md} +0 -0
  17. /package/docs/models/{GoogleAiGenerateRequest.md → GoogleAIGenerateRequest.md} +0 -0
  18. /package/docs/models/{GoogleAiInvokeA1cVisionCaptureRequest.md → GoogleAIInvokeA1cVisionCaptureRequest.md} +0 -0
  19. /package/docs/models/{OpenaiBuildResponseCreatePayloadRequest.md → OpenAIBuildResponseCreatePayloadRequest.md} +0 -0
  20. /package/docs/models/{OpenaiChatJsonRequest.md → OpenAIChatJsonRequest.md} +0 -0
  21. /package/docs/models/{OpenaiChatRequest.md → OpenAIChatRequest.md} +0 -0
  22. /package/docs/models/{OpenaiCreateAssistantRequest.md → OpenAICreateAssistantRequest.md} +0 -0
  23. /package/docs/models/{OpenaiDeleteAssistantRequest.md → OpenAIDeleteAssistantRequest.md} +0 -0
  24. /package/docs/models/{OpenaiEmbedRequest.md → OpenAIEmbedRequest.md} +0 -0
  25. /package/docs/models/{OpenaiGetAssistantRequest.md → OpenAIGetAssistantRequest.md} +0 -0
  26. /package/docs/models/{OpenaiModerateRequest.md → OpenAIModerateRequest.md} +0 -0
  27. /package/docs/models/{OpenaiUpdateAssistantRequest.md → OpenAIUpdateAssistantRequest.md} +0 -0
  28. /package/docs/models/{SendgridListTemplatesRequest.md → SendGridListTemplatesRequest.md} +0 -0
  29. /package/docs/models/{SteadymdAddAllergyIntoleranceRequest.md → SteadyMDAddAllergyIntoleranceRequest.md} +0 -0
  30. /package/docs/models/{SteadymdClaimIdentityVerificationRequest.md → SteadyMDClaimIdentityVerificationRequest.md} +0 -0
  31. /package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md} +0 -0
  32. /package/docs/models/{SteadymdCreateConsultRequest.md → SteadyMDCreateConsultRequest.md} +0 -0
  33. /package/docs/models/{SteadymdCreateEpisodeLabRequisitionRequest.md → SteadyMDCreateEpisodeLabRequisitionRequest.md} +0 -0
  34. /package/docs/models/{SteadymdCreateEpisodeRequest.md → SteadyMDCreateEpisodeRequest.md} +0 -0
  35. /package/docs/models/{SteadymdCreateIntakeRequest.md → SteadyMDCreateIntakeRequest.md} +0 -0
  36. /package/docs/models/{SteadymdCreateLabOrderRequest.md → SteadyMDCreateLabOrderRequest.md} +0 -0
  37. /package/docs/models/{SteadymdCreateLabOrderResultRequest.md → SteadyMDCreateLabOrderResultRequest.md} +0 -0
  38. /package/docs/models/{SteadymdCreateMessageRequest.md → SteadyMDCreateMessageRequest.md} +0 -0
  39. /package/docs/models/{SteadymdCreatePatientRequest.md → SteadyMDCreatePatientRequest.md} +0 -0
  40. /package/docs/models/{SteadymdGetClinicianRequest.md → SteadyMDGetClinicianRequest.md} +0 -0
  41. /package/docs/models/{SteadymdGetConsultAvailabilityRequest.md → SteadyMDGetConsultAvailabilityRequest.md} +0 -0
  42. /package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md} +0 -0
  43. /package/docs/models/{SteadymdGetConsultRequest.md → SteadyMDGetConsultRequest.md} +0 -0
  44. /package/docs/models/{SteadymdGetEpisodeLabRequisitionRequest.md → SteadyMDGetEpisodeLabRequisitionRequest.md} +0 -0
  45. /package/docs/models/{SteadymdGetEpisodeRequest.md → SteadyMDGetEpisodeRequest.md} +0 -0
  46. /package/docs/models/{SteadymdGetEpisodeSignedDocumentsRequest.md → SteadyMDGetEpisodeSignedDocumentsRequest.md} +0 -0
  47. /package/docs/models/{SteadymdGetIntakeRequest.md → SteadyMDGetIntakeRequest.md} +0 -0
  48. /package/docs/models/{SteadymdGetLabOrderPdfRequest.md → SteadyMDGetLabOrderPdfRequest.md} +0 -0
  49. /package/docs/models/{SteadymdGetLabOrderRequest.md → SteadyMDGetLabOrderRequest.md} +0 -0
  50. /package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md} +0 -0
  51. /package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md} +0 -0
  52. /package/docs/models/{SteadymdGetMessageRequest.md → SteadyMDGetMessageRequest.md} +0 -0
  53. /package/docs/models/{SteadymdGetPatientRequest.md → SteadyMDGetPatientRequest.md} +0 -0
  54. /package/docs/models/{SteadymdGetProgramAppointmentsRequest.md → SteadyMDGetProgramAppointmentsRequest.md} +0 -0
  55. /package/docs/models/{SteadymdGetProgramConsultOptionsRequest.md → SteadyMDGetProgramConsultOptionsRequest.md} +0 -0
  56. /package/docs/models/{SteadymdGetProgramLabsRequest.md → SteadyMDGetProgramLabsRequest.md} +0 -0
  57. /package/docs/models/{SteadymdGetProgramRequest.md → SteadyMDGetProgramRequest.md} +0 -0
  58. /package/docs/models/{SteadymdListConsultsRequest.md → SteadyMDListConsultsRequest.md} +0 -0
  59. /package/docs/models/{SteadymdListIntakesRequest.md → SteadyMDListIntakesRequest.md} +0 -0
  60. /package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md} +0 -0
  61. /package/docs/models/{SteadymdListLabOrdersRequest.md → SteadyMDListLabOrdersRequest.md} +0 -0
  62. /package/docs/models/{SteadymdListMessagesRequest.md → SteadyMDListMessagesRequest.md} +0 -0
  63. /package/docs/models/{SteadymdListPharmaciesRequest.md → SteadyMDListPharmaciesRequest.md} +0 -0
  64. /package/docs/models/{SteadymdListProgramCliniciansRequest.md → SteadyMDListProgramCliniciansRequest.md} +0 -0
  65. /package/docs/models/{SteadymdListProgramsRequest.md → SteadyMDListProgramsRequest.md} +0 -0
  66. /package/docs/models/{SteadymdPatchEpisodeRequest.md → SteadyMDPatchEpisodeRequest.md} +0 -0
  67. /package/docs/models/{SteadymdScheduleConsultAppointmentRequest.md → SteadyMDScheduleConsultAppointmentRequest.md} +0 -0
  68. /package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md} +0 -0
  69. /package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md} +0 -0
  70. /package/docs/models/{SteadymdUpdateEpisodeRequest.md → SteadyMDUpdateEpisodeRequest.md} +0 -0
  71. /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
- test_id: string;
800
- patient_id?: string;
801
- type?: string;
802
- status?: string;
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
- test_id: string;
800
- patient_id?: string;
801
- type?: string;
802
- status?: string;
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
 
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:cb192f89c2d0c413f6559934474cc5045faae394aa2bf08ca840508b8ad9fa54",
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
- ForgotPassword flow. Cognito emails a confirmation code directly; the
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
- ForgotPassword flow. Cognito emails a confirmation code directly; the
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
- ForgotPassword flow. Cognito emails a confirmation code directly; the
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
- None.
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
- None.
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
- Initiate Cognito's ForgotPassword flow. Cognito emails a reset code directly to the account; the client submits that code plus the new password to fieldagent.confirmResetPassword — no other server round-trip is needed in between.
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
 
@@ -60,7 +60,9 @@ Request model: [`InitHealthRecordImportRequest`](../models/InitHealthRecordImpor
60
60
 
61
61
  ```json
62
62
  {
63
- "imported": false
63
+ "imported": true,
64
+ "run_id": "string",
65
+ "status": "string"
64
66
  }
65
67
  ```
66
68
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `patient.resetPassword`
4
4
 
5
- Send a Cognito password-reset confirmation code to the patient's email. No authentication is required. Follow up with `patient.confirmResetPassword` once the code is received.
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
- Initiate Cognito's ForgotPassword flow. Cognito emails a reset code directly to the account; the client submits that code plus the new password to person.confirmResetPassword — no other server round-trip is needed in between.
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
- Initiate Cognito's ForgotPassword flow. Cognito emails a reset code directly to the account; the client submits that code plus the new password to provider.confirmResetPassword — no other server round-trip is needed in between.
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.6.1",
3
+ "version": "2.6.2",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",