@healthcloudai/hc-sdk 3.20.0 → 3.22.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 +259 -1
- package/dist/index.d.cts +1010 -101
- package/dist/index.d.ts +1010 -101
- package/dist/index.js +259 -1
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/QuestClient.md +1 -1
- package/docs/docs-manifest.json +22 -3
- package/docs/examples/index.md +5 -1
- package/docs/index.md +5 -1
- package/docs/models/CatalogItemKind.md +15 -0
- package/docs/models/CatalogVendor.md +15 -0
- package/docs/models/CollectionModality.md +15 -0
- package/docs/models/EncounterEffect.md +18 -0
- package/docs/models/EncounterOperationError.md +18 -0
- package/docs/models/EncounterOperationResponse.md +22 -0
- package/docs/models/EncounterSections.md +22 -0
- package/docs/models/GetTestOrderResponse.md +1 -0
- package/docs/models/IntakeOperationError.md +18 -0
- package/docs/models/IntakeOperationResponse.md +22 -0
- package/docs/models/ObservedEncounterResponse.md +26 -0
- package/docs/models/ObservedIntakeResponse.md +17 -0
- package/docs/models/OrderItem.md +4 -0
- package/docs/models/PlaceTestOrderResponse.md +1 -0
- package/docs/models/QuestRetrieveCompendiumResponse.md +5 -0
- package/docs/models/SubmitEncounterOperationRequest.md +18 -0
- package/docs/models/SubmitIntakeOperationRequest.md +19 -0
- package/docs/models/TestOrder.md +1 -0
- package/docs/models/UnknownEncounterOperation.md +18 -0
- package/docs/models/UnknownIntakeOperation.md +18 -0
- package/docs/models/index.md +15 -0
- package/docs/operations/connectors.questRetrieveCompendium.md +17 -2
- package/docs/operations/patient.getPatientEncounterOperation.md +151 -0
- package/docs/operations/patient.getPatientIntakeOperation.md +166 -0
- package/docs/operations/patient.getTestOrder.md +1 -0
- package/docs/operations/patient.listOrderItems.md +12 -4
- package/docs/operations/patient.listTestOrders.md +1 -0
- package/docs/operations/patient.placeTestOrder.md +2 -0
- package/docs/operations/patient.submitPatientEncounterOperation.md +161 -0
- package/docs/operations/patient.submitPatientIntakeOperation.md +178 -0
- package/package.json +1 -1
|
@@ -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 | |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# IntakeOperationError
|
|
2
|
+
|
|
3
|
+
Model ID: `IntakeOperationError`
|
|
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` | [`UnknownIntakeOperation`](./UnknownIntakeOperation.md) | No | | | | Yes | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# IntakeOperationResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `IntakeOperationResponse`
|
|
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` | [`ObservedIntakeResponse`](./ObservedIntakeResponse.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,26 @@
|
|
|
1
|
+
# ObservedEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ObservedEncounterResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_encounter` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
|
|
14
|
+
| `athena_insurance` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
|
|
15
|
+
| `clinical_outcome` | `string` | No | | | `"unknown"` | No | |
|
|
16
|
+
| `created` | `boolean|null` | No | | | | Yes | |
|
|
17
|
+
| `encounter_id` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `error_present` | `boolean` | Yes | | | | No | |
|
|
19
|
+
| `notes_athena_sections` | [`EncounterSections`](./EncounterSections.md) | No | | | | Yes | |
|
|
20
|
+
| `notes_fhir` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
|
|
21
|
+
| `openloop_encounter` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
|
|
22
|
+
| `steadymd_encounter` | [`EncounterEffect`](./EncounterEffect.md) | No | | | | Yes | |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ObservedIntakeResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ObservedIntakeResponse`
|
|
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_messages` | `array` | Yes | | | | No | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
package/docs/models/OrderItem.md
CHANGED
|
@@ -10,9 +10,13 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collection_modalities` | array of [`CollectionModality`](./CollectionModality.md) | No | | | | No | For a panel, each distinct collection modality of its tests in CollectionModality order, e.g. home_kit and psc when it needs a kit and a PSC visit; empty for a test |
|
|
14
|
+
| `collection_modality` | [`CollectionModality`](./CollectionModality.md) | Yes | | | | Yes | Where the specimen is collected; null for a panel, whose tests may differ |
|
|
13
15
|
| `id` | `string` | Yes | uuid | | | No | |
|
|
14
16
|
| `image` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `kind` | [`CatalogItemKind`](./CatalogItemKind.md) | Yes | | | | No | test, or panel of several tests |
|
|
15
18
|
| `name` | `string` | Yes | | | | No | |
|
|
19
|
+
| `vendor` | [`CatalogVendor`](./CatalogVendor.md) | Yes | | | | Yes | rapid (in-app kit) or quest; null for a panel |
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -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 | |
|
|
@@ -12,7 +12,12 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `content_b64` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
14
14
|
| `content_type` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
15
|
+
| `delivery` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
16
|
+
| `download_url` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
17
|
+
| `download_url_expires_in` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
15
18
|
| `file_name` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
19
|
+
| `sha256` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
20
|
+
| `size_bytes` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
16
21
|
|
|
17
22
|
## Example
|
|
18
23
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# SubmitEncounterOperationRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `SubmitEncounterOperationRequest`
|
|
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
|
+
| `notes` | `string` | Yes | | | | No | Exact reviewed public-conversation notes; nonempty, at most 65536 raw UTF-8 bytes. No normalization or alternate source. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# SubmitIntakeOperationRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `SubmitIntakeOperationRequest`
|
|
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
|
+
| `section` | `string` | Yes | | allergies, cancer_cases, family_history, gyn_history, perinatal_history, medications, problems, social_history, surgical_history, vaccines | | No | |
|
|
15
|
+
| `summary` | `object|string` | Yes | | | | No | Exact reviewed raw text or matching single-section object. Bounded to 65536 canonical JSON UTF-8 bytes and 16 levels before storage; existing clinical input validation still applies. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
package/docs/models/TestOrder.md
CHANGED
|
@@ -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 | |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UnknownEncounterOperation
|
|
2
|
+
|
|
3
|
+
Model ID: `UnknownEncounterOperation`
|
|
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
|
+
| `status` | `string` | No | | | `"unknown"` | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UnknownIntakeOperation
|
|
2
|
+
|
|
3
|
+
Model ID: `UnknownIntakeOperation`
|
|
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
|
+
| `status` | `string` | No | | | `"unknown"` | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -396,6 +396,8 @@
|
|
|
396
396
|
- [CarequalityRetrieveDocumentsRequest](CarequalityRetrieveDocumentsRequest.md)
|
|
397
397
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
398
398
|
- [CareSession](CareSession.md)
|
|
399
|
+
- [CatalogItemKind](CatalogItemKind.md)
|
|
400
|
+
- [CatalogVendor](CatalogVendor.md)
|
|
399
401
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
400
402
|
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
401
403
|
- [CheckEligibilityResponse](CheckEligibilityResponse.md)
|
|
@@ -408,6 +410,7 @@
|
|
|
408
410
|
- [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
|
|
409
411
|
- [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
|
|
410
412
|
- [CmsSearchHealthPlansResponse](CmsSearchHealthPlansResponse.md)
|
|
413
|
+
- [CollectionModality](CollectionModality.md)
|
|
411
414
|
- [CommGroupRecord](CommGroupRecord.md)
|
|
412
415
|
- [CommunicationsState](CommsGetStateResponse.md)
|
|
413
416
|
- [CommsGetUnreadCountResponse](CommsGetUnreadCountResponse.md)
|
|
@@ -556,6 +559,10 @@
|
|
|
556
559
|
- [ElevenLabsVoice](ElevenLabsVoice.md)
|
|
557
560
|
- [EmergencyContact](EmergencyContact.md)
|
|
558
561
|
- [EncounterClass](EncounterClass.md)
|
|
562
|
+
- [EncounterEffect](EncounterEffect.md)
|
|
563
|
+
- [EncounterOperationError](EncounterOperationError.md)
|
|
564
|
+
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
565
|
+
- [EncounterSections](EncounterSections.md)
|
|
559
566
|
- [EncounterStatus](EncounterStatus.md)
|
|
560
567
|
- [Ethnicity](Ethnicity.md)
|
|
561
568
|
- [ExerciseFrequency](ExerciseFrequency.md)
|
|
@@ -1216,6 +1223,8 @@
|
|
|
1216
1223
|
- [InitHealthRecordImportResponse](InitHealthRecordImportResponse.md)
|
|
1217
1224
|
- [Insurance](Insurance.md)
|
|
1218
1225
|
- [InsurancePriority](InsurancePriority.md)
|
|
1226
|
+
- [IntakeOperationError](IntakeOperationError.md)
|
|
1227
|
+
- [IntakeOperationResponse](IntakeOperationResponse.md)
|
|
1219
1228
|
- [InterpretationCode](InterpretationCode.md)
|
|
1220
1229
|
- [IntoleranceType](IntoleranceType.md)
|
|
1221
1230
|
- [IntraocularPressure](IntraocularPressure.md)
|
|
@@ -1303,6 +1312,8 @@
|
|
|
1303
1312
|
- [NppesVerifyProviderResponse](NppesVerifyProviderResponse.md)
|
|
1304
1313
|
- [ObservationComponent](ObservationComponent.md)
|
|
1305
1314
|
- [ObservationStatus](ObservationStatus.md)
|
|
1315
|
+
- [ObservedEncounterResponse](ObservedEncounterResponse.md)
|
|
1316
|
+
- [ObservedIntakeResponse](ObservedIntakeResponse.md)
|
|
1306
1317
|
- [OnboardEncounterPayload](OnboardEncounterPayload.md)
|
|
1307
1318
|
- [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
|
|
1308
1319
|
- [OnboardingProgressRequest](OnboardingProgressRequest.md)
|
|
@@ -1921,6 +1932,8 @@
|
|
|
1921
1932
|
- [StripeVerifyConnectionResponse](StripeVerifyConnectionResponse.md)
|
|
1922
1933
|
- [SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest](SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md)
|
|
1923
1934
|
- [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
|
|
1935
|
+
- [SubmitEncounterOperationRequest](SubmitEncounterOperationRequest.md)
|
|
1936
|
+
- [SubmitIntakeOperationRequest](SubmitIntakeOperationRequest.md)
|
|
1924
1937
|
- [SubmitSummaryRequest](SubmitSummaryRequest.md)
|
|
1925
1938
|
- [SubscriberRelationship](SubscriberRelationship.md)
|
|
1926
1939
|
- [SubstanceStatus](SubstanceStatus.md)
|
|
@@ -1950,7 +1963,9 @@
|
|
|
1950
1963
|
- [UberGetUndeliveredOrdersResponse](UberGetUndeliveredOrdersResponse.md)
|
|
1951
1964
|
- [UberUpdateDeliveryRequest](UberUpdateDeliveryRequest.md)
|
|
1952
1965
|
- [UberWaypoint](UberWaypoint.md)
|
|
1966
|
+
- [UnknownEncounterOperation](UnknownEncounterOperation.md)
|
|
1953
1967
|
- [UnknownFlagOperation](UnknownFlagOperation.md)
|
|
1968
|
+
- [UnknownIntakeOperation](UnknownIntakeOperation.md)
|
|
1954
1969
|
- [UpdateAddressRequest](UpdateAddressRequest.md)
|
|
1955
1970
|
- [UpdateAddressResponse](UpdateAddressResponse.md)
|
|
1956
1971
|
- [UpdateAgentRequest](UpdateAgentRequest.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Retrieve a compendium zip
|
|
1
|
+
# Retrieve a compendium zip as Base64, or as a short-lived download URL
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.questRetrieveCompendium`
|
|
4
4
|
|
|
5
|
-
Retrieve a compendium zip
|
|
5
|
+
Retrieve a compendium zip as Base64, or as a short-lived download URL. ``content_b64`` is inline unless the gateway staged a ZIP too large for a Lambda response; then ``download_url`` is set instead. ``size_bytes`` and ``sha256`` always describe the original ZIP.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -72,8 +72,23 @@ Request model: [`QuestRetrieveCompendiumRequest`](../models/QuestRetrieveCompend
|
|
|
72
72
|
"content_type": {
|
|
73
73
|
"vendorField": "vendor-defined value"
|
|
74
74
|
},
|
|
75
|
+
"delivery": {
|
|
76
|
+
"vendorField": "vendor-defined value"
|
|
77
|
+
},
|
|
78
|
+
"download_url": {
|
|
79
|
+
"vendorField": "vendor-defined value"
|
|
80
|
+
},
|
|
81
|
+
"download_url_expires_in": {
|
|
82
|
+
"vendorField": "vendor-defined value"
|
|
83
|
+
},
|
|
75
84
|
"file_name": {
|
|
76
85
|
"vendorField": "vendor-defined value"
|
|
86
|
+
},
|
|
87
|
+
"sha256": {
|
|
88
|
+
"vendorField": "vendor-defined value"
|
|
89
|
+
},
|
|
90
|
+
"size_bytes": {
|
|
91
|
+
"vendorField": "vendor-defined value"
|
|
77
92
|
}
|
|
78
93
|
}
|
|
79
94
|
```
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Read the logged-in patient's keyed encounter journal state
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getPatientEncounterOperation`
|
|
4
|
+
|
|
5
|
+
Reads the original scope-bound journal entry without executing encounter. Missing/pending state is not evidence of failure or permission to repeat a write.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientEncounterOperation`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getPatientEncounterOperation(idempotencyKey)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<EncounterOperationResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /patients/encounter/operations/{idempotency_key}`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `idempotency_key` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`EncounterOperationResponse`](../models/EncounterOperationResponse.md) | application/json | Scope/key-bound journal state; recorded HTTP response is not independent clinical success evidence |
|
|
54
|
+
| `202` | [`EncounterOperationResponse`](../models/EncounterOperationResponse.md) | application/json | Scope/key-bound journal state; recorded HTTP response is not independent clinical success evidence |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
None declared in canonical OpenAPI.
|
|
59
|
+
|
|
60
|
+
## Common errors
|
|
61
|
+
|
|
62
|
+
| Status | Shape | Content type | Description |
|
|
63
|
+
|---|---|---|---|
|
|
64
|
+
| `401` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Patient login required |
|
|
65
|
+
| `403` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Verified tenant required |
|
|
66
|
+
| `404` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Patient or operation not found; an in-flight operation may still commit |
|
|
67
|
+
| `409` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Key already bound to different raw terms |
|
|
68
|
+
| `422` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Invalid key or encounter terms |
|
|
69
|
+
| `503` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Coordination or outcome unavailable; look up the original key, never fall back to an unkeyed write |
|
|
70
|
+
|
|
71
|
+
## Error examples
|
|
72
|
+
|
|
73
|
+
### 401
|
|
74
|
+
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"error": "string"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 403
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"error": "string"
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 404
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"error": "string"
|
|
94
|
+
}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### 409
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"error": "string"
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### 422
|
|
106
|
+
|
|
107
|
+
```json
|
|
108
|
+
{
|
|
109
|
+
"error": "string"
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 503
|
|
114
|
+
|
|
115
|
+
```json
|
|
116
|
+
{
|
|
117
|
+
"error": "string"
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## NodeJS / TypeScript implementation
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
```ts
|
|
128
|
+
const idempotencyKey = "<IDEMPOTENCY_KEY>";
|
|
129
|
+
|
|
130
|
+
const result = await patient.getPatientEncounterOperation(idempotencyKey);
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## cURL
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
curl -X GET \
|
|
137
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
138
|
+
'https://dev-api-patient.health.cloud/patients/encounter/operations/%3CIDEMPOTENCY_KEY%3E'
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Notes
|
|
142
|
+
|
|
143
|
+
None.
|
|
144
|
+
|
|
145
|
+
## Prepared Test Console scenario
|
|
146
|
+
|
|
147
|
+
No canonical scenario is currently associated.
|
|
148
|
+
|
|
149
|
+
## Real response
|
|
150
|
+
|
|
151
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Read the logged-in patient's keyed intake journal state
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getPatientIntakeOperation`
|
|
4
|
+
|
|
5
|
+
Reads the original scope-bound journal entry without executing intake. Missing/pending state is not evidence of failure or permission to repeat a write.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientIntakeOperation`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getPatientIntakeOperation(idempotencyKey)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<IntakeOperationResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /patients/intake/operations/{idempotency_key}`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `idempotency_key` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`IntakeOperationResponse`](../models/IntakeOperationResponse.md) | application/json | Scope/key-bound journal state; recorded HTTP response is not independent clinical success evidence |
|
|
54
|
+
| `202` | [`IntakeOperationResponse`](../models/IntakeOperationResponse.md) | application/json | Scope/key-bound journal state; recorded HTTP response is not independent clinical success evidence |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"idempotency_key": "940be5cc-c1fd-4b38-ae7d-13516f9ac098",
|
|
63
|
+
"patient_id": "patient-example-001",
|
|
64
|
+
"request_hash": "a7c3a0a2f1d949380f4312a44f9a4a02b0ab754a47fc57f10c92a6f8fb5cd544",
|
|
65
|
+
"response_body": {
|
|
66
|
+
"error_messages": [
|
|
67
|
+
"Synthetic outcome needs clinical reconciliation"
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
"response_code": 502,
|
|
71
|
+
"status": "recorded"
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Common errors
|
|
76
|
+
|
|
77
|
+
| Status | Shape | Content type | Description |
|
|
78
|
+
|---|---|---|---|
|
|
79
|
+
| `401` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Patient login required |
|
|
80
|
+
| `403` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Verified tenant required |
|
|
81
|
+
| `404` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Patient or operation not found; an in-flight operation may still commit |
|
|
82
|
+
| `409` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Key already bound to different raw terms |
|
|
83
|
+
| `422` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Invalid key or intake terms |
|
|
84
|
+
| `503` | [`IntakeOperationError`](../models/IntakeOperationError.md) | application/json | Coordination or outcome unavailable; look up the original key, never fall back to an unkeyed write |
|
|
85
|
+
|
|
86
|
+
## Error examples
|
|
87
|
+
|
|
88
|
+
### 401
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"error": "string"
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 403
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"error": "string"
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 404
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"error": "string"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 409
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"error": "string"
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### 422
|
|
121
|
+
|
|
122
|
+
```json
|
|
123
|
+
{
|
|
124
|
+
"error": "string"
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### 503
|
|
129
|
+
|
|
130
|
+
```json
|
|
131
|
+
{
|
|
132
|
+
"error": "string"
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## NodeJS / TypeScript implementation
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
const idempotencyKey = "<IDEMPOTENCY_KEY>";
|
|
144
|
+
|
|
145
|
+
const result = await patient.getPatientIntakeOperation(idempotencyKey);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## cURL
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
curl -X GET \
|
|
152
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
|
+
'https://dev-api-patient.health.cloud/patients/intake/operations/%3CIDEMPOTENCY_KEY%3E'
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Notes
|
|
157
|
+
|
|
158
|
+
None.
|
|
159
|
+
|
|
160
|
+
## Prepared Test Console scenario
|
|
161
|
+
|
|
162
|
+
No canonical scenario is currently associated.
|
|
163
|
+
|
|
164
|
+
## Real response
|
|
165
|
+
|
|
166
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|