@healthcloudai/hc-sdk 3.6.1 → 3.7.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.
@@ -2,7 +2,7 @@
2
2
 
3
3
  - [`buildResponseCreatePayload`](../operations/connectors.openaiBuildResponseCreatePayload.md) — Build a ``/v1/responses`` request body
4
4
  - [`chat`](../operations/connectors.openaiChat.md) — Chat (OpenAI)
5
- - [`chatJson`](../operations/connectors.openaiChatJson.md) — Chat json (OpenAI)
5
+ - [`chatJson`](../operations/connectors.openaiChatJson.md) — Return a JSON object from Chat Completions
6
6
  - [`createAssistant`](../operations/connectors.openaiCreateAssistant.md) — Create a virtual agent profile and return its synthetic id
7
7
  - [`deleteAssistant`](../operations/connectors.openaiDeleteAssistant.md) — Return whether there was a profile id to "delete"
8
8
  - [`embed`](../operations/connectors.openaiEmbed.md) — Embed (OpenAI)
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:aaa665826f96cc59f5727ad4bd0e98cbbac66bff472897354f945836b5c06d1a",
2
+ "docsDataContentDigest": "sha256:4493f6fb92c1eb8be63e575757907abe3b87008445a51ab20d54a2d4706709ec",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -331,7 +331,6 @@
331
331
  "models/AthenaRetrieveAvailableAppointmentSlotsRequest.md",
332
332
  "models/AthenaReviewOfSystems.md",
333
333
  "models/AthenaSearchAllergensRequest.md",
334
- "models/AthenaSearchAllergensResponse.md",
335
334
  "models/AthenaSearchClinicalProvidersRequest.md",
336
335
  "models/AthenaSearchMedicationsRequest.md",
337
336
  "models/AthenaSearchMedicationsResponse.md",
@@ -3084,7 +3083,7 @@
3084
3083
  "operations/vitals.recordVitals.md"
3085
3084
  ],
3086
3085
  "language": "nodejs",
3087
- "modelCount": 2010,
3086
+ "modelCount": 2009,
3088
3087
  "operationCount": 1017,
3089
3088
  "schemaVersion": 1
3090
3089
  }
@@ -535,7 +535,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
535
535
  - [Verify a provider's NPI against the NPI Registry](../operations/connectors.nppesVerifyProvider.md)
536
536
  - [Build a ``/v1/responses`` request body](../operations/connectors.openaiBuildResponseCreatePayload.md)
537
537
  - [Chat (OpenAI)](../operations/connectors.openaiChat.md)
538
- - [Chat json (OpenAI)](../operations/connectors.openaiChatJson.md)
538
+ - [Return a JSON object from Chat Completions](../operations/connectors.openaiChatJson.md)
539
539
  - [Create a virtual agent profile and return its synthetic id](../operations/connectors.openaiCreateAssistant.md)
540
540
  - [Return whether there was a profile id to "delete"](../operations/connectors.openaiDeleteAssistant.md)
541
541
  - [Embed (OpenAI)](../operations/connectors.openaiEmbed.md)
package/docs/index.md CHANGED
@@ -543,7 +543,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
543
543
  - [Verify a provider's NPI against the NPI Registry](operations/connectors.nppesVerifyProvider.md) (`connectors.nppesVerifyProvider`)
544
544
  - [Build a ``/v1/responses`` request body](operations/connectors.openaiBuildResponseCreatePayload.md) (`connectors.openaiBuildResponseCreatePayload`)
545
545
  - [Chat (OpenAI)](operations/connectors.openaiChat.md) (`connectors.openaiChat`)
546
- - [Chat json (OpenAI)](operations/connectors.openaiChatJson.md) (`connectors.openaiChatJson`)
546
+ - [Return a JSON object from Chat Completions](operations/connectors.openaiChatJson.md) (`connectors.openaiChatJson`)
547
547
  - [Create a virtual agent profile and return its synthetic id](operations/connectors.openaiCreateAssistant.md) (`connectors.openaiCreateAssistant`)
548
548
  - [Return whether there was a profile id to "delete"](operations/connectors.openaiDeleteAssistant.md) (`connectors.openaiDeleteAssistant`)
549
549
  - [Embed (OpenAI)](operations/connectors.openaiEmbed.md) (`connectors.openaiEmbed`)
@@ -13,7 +13,7 @@ Type: `object`
13
13
  | `content_type` | `string` | No | | | `"image/jpeg"` | No | MIME type of the scan image. Defaults to image/jpeg. |
14
14
  | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id this scan is associated with, optional. Stored on the pending Observation so the async SAFE CDX result ingestion can mirror the finished result to Athena (when the tenant/patient are Athena-linked) once CVML processing completes. |
15
15
  | `filename` | `string` | No | | | `"scan.jpg"` | No | Filename of the uploaded scan. Defaults to scan.jpg. |
16
- | `gtin` | `string|null` | No | | | | Yes | GTIN of the test kit. Optional for the compatibility upload endpoint; the combined GS1 lookup flow supplies it automatically. |
16
+ | `gtin` | `string` | Yes | | | | No | GTIN of the scanned test kit (8, 12, 13, or 14 digits, normalized to zero-padded GTIN-14). Must resolve to a configured test profile — unrecognized GTINs get a 404, and no product default exists. |
17
17
  | `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation UUID for the diagnostic scan. |
18
18
 
19
19
  ## Example
@@ -17,6 +17,7 @@ Type: `object`
17
17
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
18
18
  | `model` | `string` | No | | | | Yes | |
19
19
  | `organization` | `string` | No | | | | Yes | |
20
+ | `system` | `string` | No | | | | Yes | |
20
21
 
21
22
  ## Example
22
23
 
@@ -282,7 +282,6 @@
282
282
  - [AthenaRetrieveAvailableAppointmentSlotsRequest](AthenaRetrieveAvailableAppointmentSlotsRequest.md)
283
283
  - [AthenaReviewOfSystems](AthenaReviewOfSystems.md)
284
284
  - [AthenaSearchAllergensRequest](AthenaSearchAllergensRequest.md)
285
- - [AthenaSearchAllergensResponse](AthenaSearchAllergensResponse.md)
286
285
  - [AthenaSearchClinicalProvidersRequest](AthenaSearchClinicalProvidersRequest.md)
287
286
  - [AthenaSearchMedicationsRequest](AthenaSearchMedicationsRequest.md)
288
287
  - [AthenaSearchMedicationsResponse](AthenaSearchMedicationsResponse.md)
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `connectors.athenaSearchAllergens`
4
4
 
5
- Search Athena's allergen reference list. Returns a stable connector-facing shape: [{"allergen_id": "...", "allergen_name": "..."}]
5
+ Search Athena's allergen reference list. Returns a stable connector-facing shape: [{"allergen_id": "...", "allergen_name": "..."}] Athena's allergen catalogue search is case-sensitive and does not stem plural forms: ``Peanuts`` and ``peanuts`` match nothing while ``peanut`` does. An empty first pass therefore retries the lowercased phrase and a singular form, mirroring the established intake.py catalogue fallback, so patient-typed plurals still reach the catalogue candidates the AI ranking needs.
6
6
 
7
7
  ## Public method
8
8
 
@@ -59,7 +59,7 @@ Request model: [`AthenaSearchAllergensRequest`](../models/AthenaSearchAllergensR
59
59
 
60
60
  | Status | Shape | Content type | Description |
61
61
  |---|---|---|---|
62
- | `200` | [`AthenaSearchAllergensResponse`](../models/AthenaSearchAllergensResponse.md) | application/json | Successful response |
62
+ | `200` | [`connectors.JsonValue`](../models/connectors.JsonValue.md) | application/json | Successful response |
63
63
 
64
64
  ## Success response examples
65
65
 
@@ -1,8 +1,8 @@
1
- # Chat json (OpenAI)
1
+ # Return a JSON object from Chat Completions
2
2
 
3
3
  Operation ID: `connectors.openaiChatJson`
4
4
 
5
- Chat json via OpenAI. Relays the vendor response unchanged.
5
+ Return a JSON object from Chat Completions. ``system`` is an application-level convenience argument, like it is for :meth:`chat`. Chat Completions accepts system instructions as a message, not as a top-level request property. Keeping it out of ``kwargs`` prevents a 400 response that otherwise looks like an empty AI ranking to intake callers.
6
6
 
7
7
  ## Public method
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `diagnostics.getScanUploadUrl`
4
4
 
5
- Return a presigned URL for uploading a photo/scan of a rapid test result, associated with an existing test_id. Call diagnostics.createRapidTest first to obtain a test_id — this endpoint 404s if test_id does not resolve to an existing test for the patient.
5
+ Return a presigned URL for uploading a photo/scan of a rapid test result, associated with an existing test_id. The scanned kit's gtin is required — it resolves the same admin-managed test profile as diagnostics.lookupGS1, and the pending Observation's LOINC coding and display name come from that profile (no hardcoded product default). Unrecognized GTINs get a 404.
6
6
 
7
7
  ## Public method
8
8
 
@@ -49,10 +49,10 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
49
49
  ```json
50
50
  {
51
51
  "content_type": "image/jpeg",
52
- "encounter_id": "string",
53
- "filename": "scan.jpg",
54
- "gtin": "string",
55
- "test_id": "00000000-0000-0000-0000-000000000000"
52
+ "encounter_id": "encounter-example-001",
53
+ "filename": "test-scan.jpg",
54
+ "gtin": "01234567890123",
55
+ "test_id": "00000000-0000-4000-8000-000000000001"
56
56
  }
57
57
  ```
58
58
 
@@ -79,7 +79,7 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
79
79
 
80
80
  | Status | Shape | Content type | Description |
81
81
  |---|---|---|---|
82
- | `400` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | test_id was missing or not a valid UUID |
82
+ | `400` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | test_id was missing or not a valid UUID, or gtin was missing or not a valid GTIN |
83
83
  | `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
84
84
  | `403` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | A PATIENT-pool caller attempted to access another patient's data |
85
85
  | `404` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | The PATIENT-pool caller's own FHIR Patient record could not be resolved |
@@ -87,6 +87,14 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
87
87
 
88
88
  ## Error examples
89
89
 
90
+ ### 400 — gtin is not 8, 12, 13, or 14 digits
91
+
92
+ ```json
93
+ {
94
+ "error": "GTIN must contain 8, 12, 13, or 14 digits"
95
+ }
96
+ ```
97
+
90
98
  ### 400 — test_id is missing or not a valid UUID
91
99
 
92
100
  ```json
@@ -95,6 +103,14 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
95
103
  }
96
104
  ```
97
105
 
106
+ ### 400 — gtin is missing from the request body
107
+
108
+ ```json
109
+ {
110
+ "error": "gtin is required"
111
+ }
112
+ ```
113
+
98
114
  ### 401 — Missing or invalid access token
99
115
 
100
116
  ```json
@@ -138,10 +154,10 @@ const patientId = "<PATIENT_ID>";
138
154
 
139
155
  const request = {
140
156
  "content_type": "image/jpeg",
141
- "encounter_id": "string",
142
- "filename": "scan.jpg",
143
- "gtin": "string",
144
- "test_id": "00000000-0000-0000-0000-000000000000"
157
+ "encounter_id": "encounter-example-001",
158
+ "filename": "test-scan.jpg",
159
+ "gtin": "01234567890123",
160
+ "test_id": "00000000-0000-4000-8000-000000000001"
145
161
  };
146
162
 
147
163
  const result = await diagnostics.getScanUploadUrl(patientId, request);
@@ -153,7 +169,7 @@ const result = await diagnostics.getScanUploadUrl(patientId, request);
153
169
  curl -X POST \
154
170
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
155
171
  -H 'Content-Type: application/json' \
156
- -d '{"content_type":"image/jpeg","encounter_id":"string","filename":"scan.jpg","gtin":"string","test_id":"00000000-0000-0000-0000-000000000000"}' \
172
+ -d '{"content_type":"image/jpeg","encounter_id":"encounter-example-001","filename":"test-scan.jpg","gtin":"01234567890123","test_id":"00000000-0000-4000-8000-000000000001"}' \
157
173
  'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/scan-upload-url'
158
174
  ```
159
175
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.6.1",
3
+ "version": "3.7.0",
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",
@@ -1,15 +0,0 @@
1
- # AthenaSearchAllergensResponse
2
-
3
- Model ID: `AthenaSearchAllergensResponse`
4
-
5
- No description.
6
-
7
- Type: `array`
8
-
9
- ## Fields
10
-
11
- No fields.
12
-
13
- ## Example
14
-
15
- None declared in canonical OpenAPI.