@healthcloudai/hc-sdk 3.21.0 → 3.23.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 +212 -1
- package/dist/index.d.cts +821 -2
- package/dist/index.d.ts +821 -2
- package/dist/index.js +212 -1
- package/docs/clients/PatientClient.md +3 -0
- package/docs/clients/QuestClient.md +1 -1
- package/docs/docs-manifest.json +17 -3
- package/docs/examples/index.md +4 -1
- package/docs/index.md +4 -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/EncounterClinicalState.md +31 -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/ObservedEncounterResponse.md +26 -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/TestOrder.md +1 -0
- package/docs/models/UnknownEncounterOperation.md +18 -0
- package/docs/models/index.md +11 -0
- package/docs/operations/connectors.questRetrieveCompendium.md +17 -2
- package/docs/operations/patient.getPatientEncounterClinicalState.md +170 -0
- package/docs/operations/patient.getPatientEncounterOperation.md +151 -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 +1 -1
- package/package.json +1 -1
|
@@ -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.
|
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.
|
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.
|
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,11 @@
|
|
|
556
559
|
- [ElevenLabsVoice](ElevenLabsVoice.md)
|
|
557
560
|
- [EmergencyContact](EmergencyContact.md)
|
|
558
561
|
- [EncounterClass](EncounterClass.md)
|
|
562
|
+
- [EncounterClinicalState](EncounterClinicalState.md)
|
|
563
|
+
- [EncounterEffect](EncounterEffect.md)
|
|
564
|
+
- [EncounterOperationError](EncounterOperationError.md)
|
|
565
|
+
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
566
|
+
- [EncounterSections](EncounterSections.md)
|
|
559
567
|
- [EncounterStatus](EncounterStatus.md)
|
|
560
568
|
- [Ethnicity](Ethnicity.md)
|
|
561
569
|
- [ExerciseFrequency](ExerciseFrequency.md)
|
|
@@ -1305,6 +1313,7 @@
|
|
|
1305
1313
|
- [NppesVerifyProviderResponse](NppesVerifyProviderResponse.md)
|
|
1306
1314
|
- [ObservationComponent](ObservationComponent.md)
|
|
1307
1315
|
- [ObservationStatus](ObservationStatus.md)
|
|
1316
|
+
- [ObservedEncounterResponse](ObservedEncounterResponse.md)
|
|
1308
1317
|
- [ObservedIntakeResponse](ObservedIntakeResponse.md)
|
|
1309
1318
|
- [OnboardEncounterPayload](OnboardEncounterPayload.md)
|
|
1310
1319
|
- [OnboardEncounterStepResult](OnboardEncounterStepResult.md)
|
|
@@ -1924,6 +1933,7 @@
|
|
|
1924
1933
|
- [StripeVerifyConnectionResponse](StripeVerifyConnectionResponse.md)
|
|
1925
1934
|
- [SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest](SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md)
|
|
1926
1935
|
- [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
|
|
1936
|
+
- [SubmitEncounterOperationRequest](SubmitEncounterOperationRequest.md)
|
|
1927
1937
|
- [SubmitIntakeOperationRequest](SubmitIntakeOperationRequest.md)
|
|
1928
1938
|
- [SubmitSummaryRequest](SubmitSummaryRequest.md)
|
|
1929
1939
|
- [SubscriberRelationship](SubscriberRelationship.md)
|
|
@@ -1954,6 +1964,7 @@
|
|
|
1954
1964
|
- [UberGetUndeliveredOrdersResponse](UberGetUndeliveredOrdersResponse.md)
|
|
1955
1965
|
- [UberUpdateDeliveryRequest](UberUpdateDeliveryRequest.md)
|
|
1956
1966
|
- [UberWaypoint](UberWaypoint.md)
|
|
1967
|
+
- [UnknownEncounterOperation](UnknownEncounterOperation.md)
|
|
1957
1968
|
- [UnknownFlagOperation](UnknownFlagOperation.md)
|
|
1958
1969
|
- [UnknownIntakeOperation](UnknownIntakeOperation.md)
|
|
1959
1970
|
- [UpdateAddressRequest](UpdateAddressRequest.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,170 @@
|
|
|
1
|
+
# Read current FHIR facts for the authenticated patient's original encounter key
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getPatientEncounterClinicalState`
|
|
4
|
+
|
|
5
|
+
Reads only the recorded original encounter, never searches or writes. Exact reviewed notes are compared by the original hash, with patient ownership and resource version required. Presence/matching notes do not prove causation, vendor completion or permission to retry. All provider effects and overall clinical outcome remain unknown.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientEncounterClinicalState`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getPatientEncounterClinicalState(idempotencyKey)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<EncounterClinicalState>`
|
|
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}/clinical-state`
|
|
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` | [`EncounterClinicalState`](../models/EncounterClinicalState.md) | application/json | Current scoped FHIR facts; overall clinical outcome and retry remain unresolved |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"clinical_outcome": "unknown",
|
|
62
|
+
"ehr": "unknown",
|
|
63
|
+
"ehr_notes": "unknown",
|
|
64
|
+
"encounter_id": "encounter-example-001",
|
|
65
|
+
"fhir_encounter": "present",
|
|
66
|
+
"idempotency_key": "940be5cc-c1fd-4b38-ae7d-13516f9ac098",
|
|
67
|
+
"insurance": "unknown",
|
|
68
|
+
"journal_status": "recorded",
|
|
69
|
+
"notes_fhir": "matches",
|
|
70
|
+
"patient_id": "patient-example-001",
|
|
71
|
+
"reason": "notes_match",
|
|
72
|
+
"request_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
|
|
73
|
+
"resource_version": "1",
|
|
74
|
+
"response_code": 200,
|
|
75
|
+
"retry_allowed": false
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Common errors
|
|
80
|
+
|
|
81
|
+
| Status | Shape | Content type | Description |
|
|
82
|
+
|---|---|---|---|
|
|
83
|
+
| `401` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Patient login required |
|
|
84
|
+
| `403` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Verified tenant required |
|
|
85
|
+
| `404` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Patient or operation not found; an in-flight operation may still commit |
|
|
86
|
+
| `409` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Key already bound to different raw terms |
|
|
87
|
+
| `422` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Invalid key or encounter terms |
|
|
88
|
+
| `503` | [`EncounterOperationError`](../models/EncounterOperationError.md) | application/json | Coordination or outcome unavailable; look up the original key, never fall back to an unkeyed write |
|
|
89
|
+
|
|
90
|
+
## Error examples
|
|
91
|
+
|
|
92
|
+
### 401
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"error": "string"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 403
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"error": "string"
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 404
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"error": "string"
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 409
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"error": "string"
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 422
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"error": "string"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 503
|
|
133
|
+
|
|
134
|
+
```json
|
|
135
|
+
{
|
|
136
|
+
"error": "string"
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## NodeJS / TypeScript implementation
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
```ts
|
|
147
|
+
const idempotencyKey = "<IDEMPOTENCY_KEY>";
|
|
148
|
+
|
|
149
|
+
const result = await patient.getPatientEncounterClinicalState(idempotencyKey);
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## cURL
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
curl -X GET \
|
|
156
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
157
|
+
'https://dev-api-patient.health.cloud/patients/encounter/operations/%3CIDEMPOTENCY_KEY%3E/clinical-state'
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Notes
|
|
161
|
+
|
|
162
|
+
None.
|
|
163
|
+
|
|
164
|
+
## Prepared Test Console scenario
|
|
165
|
+
|
|
166
|
+
No canonical scenario is currently associated.
|
|
167
|
+
|
|
168
|
+
## Real response
|
|
169
|
+
|
|
170
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -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.
|
|
@@ -32,7 +32,9 @@ None.
|
|
|
32
32
|
|
|
33
33
|
## Query parameters
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `include_catalog` | `boolean` | No | | | `false` | No | Also list patient-visible lab tests and panels, which cannot be ordered for delivery |
|
|
36
38
|
|
|
37
39
|
## Body parameters
|
|
38
40
|
|
|
@@ -48,7 +50,7 @@ None declared in canonical OpenAPI.
|
|
|
48
50
|
|
|
49
51
|
| Status | Shape | Content type | Description |
|
|
50
52
|
|---|---|---|---|
|
|
51
|
-
| `200` | [`ListOrderItemsResponse`](../models/ListOrderItemsResponse.md) | application/json | Orderable catalog items: id, name and
|
|
53
|
+
| `200` | [`ListOrderItemsResponse`](../models/ListOrderItemsResponse.md) | application/json | Orderable catalog items: id, name, image, kind, vendor, collection_modality and, for a panel, collection_modalities |
|
|
52
54
|
|
|
53
55
|
## Success response examples
|
|
54
56
|
|
|
@@ -58,9 +60,15 @@ None declared in canonical OpenAPI.
|
|
|
58
60
|
{
|
|
59
61
|
"items": [
|
|
60
62
|
{
|
|
63
|
+
"collection_modalities": [
|
|
64
|
+
"rapid"
|
|
65
|
+
],
|
|
66
|
+
"collection_modality": "rapid",
|
|
61
67
|
"id": "00000000-0000-0000-0000-000000000000",
|
|
62
68
|
"image": "string",
|
|
63
|
-
"
|
|
69
|
+
"kind": "test",
|
|
70
|
+
"name": "string",
|
|
71
|
+
"vendor": "quest"
|
|
64
72
|
}
|
|
65
73
|
],
|
|
66
74
|
"total": 0
|
|
@@ -113,7 +121,7 @@ const result = await patient.listOrderItems();
|
|
|
113
121
|
```bash
|
|
114
122
|
curl -X GET \
|
|
115
123
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
116
|
-
'https://dev-api-patient.health.cloud/patients/order-items'
|
|
124
|
+
'https://dev-api-patient.health.cloud/patients/order-items?include_catalog=false'
|
|
117
125
|
```
|
|
118
126
|
|
|
119
127
|
## Notes
|
|
@@ -106,6 +106,7 @@ Request model: [`PlaceTestOrderRequest`](../models/PlaceTestOrderRequest.md)
|
|
|
106
106
|
"patient_fhir_id": "string",
|
|
107
107
|
"performer_name": "string",
|
|
108
108
|
"priority": "routine",
|
|
109
|
+
"quest_placer_order_number": "string",
|
|
109
110
|
"reason": "string",
|
|
110
111
|
"requester_name": "string",
|
|
111
112
|
"requester_npi": "string",
|
|
@@ -158,6 +159,7 @@ Request model: [`PlaceTestOrderRequest`](../models/PlaceTestOrderRequest.md)
|
|
|
158
159
|
"patient_fhir_id": "string",
|
|
159
160
|
"performer_name": "string",
|
|
160
161
|
"priority": "routine",
|
|
162
|
+
"quest_placer_order_number": "string",
|
|
161
163
|
"reason": "string",
|
|
162
164
|
"requester_name": "string",
|
|
163
165
|
"requester_npi": "string",
|