@healthcloudai/hc-sdk 3.22.0 → 3.24.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 +77 -0
- package/dist/index.d.cts +1312 -4
- package/dist/index.d.ts +1312 -4
- package/dist/index.js +77 -0
- package/docs/clients/PatientClient.md +1 -0
- package/docs/clients/ProviderClient.md +7 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/CreateProviderPatientRequest.md +22 -0
- package/docs/models/EncounterClinicalState.md +31 -0
- package/docs/models/LabOrder.md +35 -0
- package/docs/models/LabOrderDiagnosis.md +18 -0
- package/docs/models/LabOrderErrorResponse.md +21 -0
- package/docs/models/LabOrderItemRequest.md +17 -0
- package/docs/models/LabOrderProvider.md +20 -0
- package/docs/models/LabOrderRequisitionResponse.md +20 -0
- package/docs/models/LabOrderTest.md +19 -0
- package/docs/models/LabOrderUnsentItem.md +19 -0
- package/docs/models/ListLabOrdersResponse.md +18 -0
- package/docs/models/PlaceLabOrderRequest.md +27 -0
- package/docs/models/PlaceLabOrderResponse.md +20 -0
- package/docs/models/ProviderEncounterStatusCounts.md +21 -0
- package/docs/models/ProviderHomeSummaryResponse.md +19 -0
- package/docs/models/ProviderPatientListResponse.md +19 -0
- package/docs/models/ProviderPatientResponse.md +17 -0
- package/docs/models/index.md +17 -0
- package/docs/operations/patient.getPatientEncounterClinicalState.md +170 -0
- package/docs/operations/provider.createPatient.md +155 -0
- package/docs/operations/provider.getHomeSummary.md +115 -0
- package/docs/operations/provider.getLabOrder.md +179 -0
- package/docs/operations/provider.getLabOrderRequisition.md +148 -0
- package/docs/operations/provider.listLabOrders.md +198 -0
- package/docs/operations/provider.listPatients.md +154 -0
- package/docs/operations/provider.placeLabOrder.md +384 -0
- package/package.json +1 -1
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderEncounterStatusCounts
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderEncounterStatusCounts`
|
|
4
|
+
|
|
5
|
+
Encounters the calling practitioner takes part in, by HealthCloud encounter status.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `arrived` | `integer` | Yes | | | | No | Patients who have arrived. |
|
|
14
|
+
| `finished` | `integer` | Yes | | | | No | Completed encounters. |
|
|
15
|
+
| `in_progress` | `integer` | Yes | | | | No | Encounters in progress. |
|
|
16
|
+
| `planned` | `integer` | Yes | | | | No | Encounters not yet started. |
|
|
17
|
+
| `triaged` | `integer` | Yes | | | | No | Patients triaged and waiting for the provider. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderHomeSummaryResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderHomeSummaryResponse`
|
|
4
|
+
|
|
5
|
+
Counts for the provider's home screen, scoped to the calling practitioner.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `as_of` | `string` | Yes | | | | No | UTC time the counts were read, ISO 8601 with offset (e.g. 2026-11-05T12:00:00+00:00). |
|
|
14
|
+
| `encounters` | [`ProviderEncounterStatusCounts`](./ProviderEncounterStatusCounts.md) | Yes | | | | No | Encounter counts by status. |
|
|
15
|
+
| `patients_total` | `integer` | Yes | | | | No | Patients on the calling practitioner's care team. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderPatientListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientListResponse`
|
|
4
|
+
|
|
5
|
+
One page of the calling practitioner's patients, as demographic summaries.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `next_page_token` | `string|null` | No | | | | Yes | Pass as page_token to read the next page. Absent on the last page. |
|
|
14
|
+
| `patients` | array of [`ProviderPatientSummary`](./ProviderPatientSummary.md) | Yes | | | | No | Patients on this page, in the FHIR store's order. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of patients on this page. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ProviderPatientResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientResponse`
|
|
4
|
+
|
|
5
|
+
One patient, as a demographic summary.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | Yes | | | | No | The patient's demographic summary. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -461,6 +461,7 @@
|
|
|
461
461
|
- [CreateMedicationRequest](CreateMedicationRequest.md)
|
|
462
462
|
- [CreateMedicationResponse](CreateMedicationResponse.md)
|
|
463
463
|
- [CreateTelehealthTokenRequest](CreatePatientTokenRequest.md)
|
|
464
|
+
- [CreateProviderPatientRequest](CreateProviderPatientRequest.md)
|
|
464
465
|
- [CreateTelehealthTokenRequest](CreateProviderTokenRequest.md)
|
|
465
466
|
- [CreateQuestionnaireRequest](CreateQuestionnaireRequest.md)
|
|
466
467
|
- [CreateQuestionnaireResponse](CreateQuestionnaireResponse.md)
|
|
@@ -559,6 +560,7 @@
|
|
|
559
560
|
- [ElevenLabsVoice](ElevenLabsVoice.md)
|
|
560
561
|
- [EmergencyContact](EmergencyContact.md)
|
|
561
562
|
- [EncounterClass](EncounterClass.md)
|
|
563
|
+
- [EncounterClinicalState](EncounterClinicalState.md)
|
|
562
564
|
- [EncounterEffect](EncounterEffect.md)
|
|
563
565
|
- [EncounterOperationError](EncounterOperationError.md)
|
|
564
566
|
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
@@ -1243,6 +1245,14 @@
|
|
|
1243
1245
|
- [KnowledgeCollection](KnowledgeCollection.md)
|
|
1244
1246
|
- [KnowledgeEntrySummary](KnowledgeEntrySummary.md)
|
|
1245
1247
|
- [KnowledgeSearchResult](KnowledgeSearchResult.md)
|
|
1248
|
+
- [LabOrder](LabOrder.md)
|
|
1249
|
+
- [LabOrderDiagnosis](LabOrderDiagnosis.md)
|
|
1250
|
+
- [LabOrderErrorResponse](LabOrderErrorResponse.md)
|
|
1251
|
+
- [LabOrderItemRequest](LabOrderItemRequest.md)
|
|
1252
|
+
- [LabOrderProvider](LabOrderProvider.md)
|
|
1253
|
+
- [LabOrderRequisitionResponse](LabOrderRequisitionResponse.md)
|
|
1254
|
+
- [LabOrderTest](LabOrderTest.md)
|
|
1255
|
+
- [LabOrderUnsentItem](LabOrderUnsentItem.md)
|
|
1246
1256
|
- [LicenseVerification](LicenseVerification.md)
|
|
1247
1257
|
- [ListActionsResponse](ListActionsResponse.md)
|
|
1248
1258
|
- [ListActivityResponse](ListActivityResponse.md)
|
|
@@ -1257,6 +1267,7 @@
|
|
|
1257
1267
|
- [ListImmunizationsResponse](ListImmunizationsResponse.md)
|
|
1258
1268
|
- [ListImpiloDevicesResponse](ListImpiloDevicesResponse.md)
|
|
1259
1269
|
- [ListKnowledgeResponse](ListKnowledgeResponse.md)
|
|
1270
|
+
- [ListLabOrdersResponse](ListLabOrdersResponse.md)
|
|
1260
1271
|
- [ListMedicalConceptsGetResponse](ListMedicalConceptsGetResponse.md)
|
|
1261
1272
|
- [ListNotificationsResponse](ListNotificationsResponse.md)
|
|
1262
1273
|
- [ObservationListResponse](ListObservationsResponse.md)
|
|
@@ -1460,6 +1471,8 @@
|
|
|
1460
1471
|
- [PersonRelationship](PersonRelationship.md)
|
|
1461
1472
|
- [Phone](Phone.md)
|
|
1462
1473
|
- [PhoneType](PhoneType.md)
|
|
1474
|
+
- [PlaceLabOrderRequest](PlaceLabOrderRequest.md)
|
|
1475
|
+
- [PlaceLabOrderResponse](PlaceLabOrderResponse.md)
|
|
1463
1476
|
- [PlaceTestOrderRequest](PlaceTestOrderRequest.md)
|
|
1464
1477
|
- [PlaceTestOrderResponse](PlaceTestOrderResponse.md)
|
|
1465
1478
|
- [PlaidCreateIdentityVerificationRequest](PlaidCreateIdentityVerificationRequest.md)
|
|
@@ -1543,7 +1556,9 @@
|
|
|
1543
1556
|
- [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
|
|
1544
1557
|
- [ProviderEncounterRecord](ProviderEncounterRecord.md)
|
|
1545
1558
|
- [ProviderEncounterResponse](ProviderEncounterResponse.md)
|
|
1559
|
+
- [ProviderEncounterStatusCounts](ProviderEncounterStatusCounts.md)
|
|
1546
1560
|
- [ProviderGender](ProviderGender.md)
|
|
1561
|
+
- [ProviderHomeSummaryResponse](ProviderHomeSummaryResponse.md)
|
|
1547
1562
|
- [ProviderIdentifier](ProviderIdentifier.md)
|
|
1548
1563
|
- [ProviderIdentifierType](ProviderIdentifierType.md)
|
|
1549
1564
|
- [ProviderLanguage](ProviderLanguage.md)
|
|
@@ -1556,9 +1571,11 @@
|
|
|
1556
1571
|
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1557
1572
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1558
1573
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1574
|
+
- [ProviderPatientListResponse](ProviderPatientListResponse.md)
|
|
1559
1575
|
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
1560
1576
|
- [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
|
|
1561
1577
|
- [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
|
|
1578
|
+
- [ProviderPatientResponse](ProviderPatientResponse.md)
|
|
1562
1579
|
- [ProviderPatientSummary](ProviderPatientSummary.md)
|
|
1563
1580
|
- [ProviderPostgraduateTraining](ProviderPostgraduateTraining.md)
|
|
1564
1581
|
- [ProviderProfessionalLiability](ProviderProfessionalLiability.md)
|
|
@@ -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,155 @@
|
|
|
1
|
+
# Create a patient on the calling practitioner's care team
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.createPatient`
|
|
4
|
+
|
|
5
|
+
Creates a FHIR Patient in the provider's own tenant, assigned to the calling practitioner, and returns its demographic summary.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`createPatient`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.createPatient(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ProviderPatientResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /patients`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
|
+
|---|---|---:|---|---|---|---:|---|
|
|
41
|
+
| `body` | [`CreateProviderPatientRequest`](../models/CreateProviderPatientRequest.md) | No | | | | Yes | |
|
|
42
|
+
|
|
43
|
+
Request model: [`CreateProviderPatientRequest`](../models/CreateProviderPatientRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"date_of_birth": "2026-01-01",
|
|
50
|
+
"email": "user@example.com",
|
|
51
|
+
"first_name": "string",
|
|
52
|
+
"gender": "male",
|
|
53
|
+
"last_name": "string"
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Success responses
|
|
58
|
+
|
|
59
|
+
| Status | Shape | Content type | Description |
|
|
60
|
+
|---|---|---|---|
|
|
61
|
+
| `201` | [`ProviderPatientResponse`](../models/ProviderPatientResponse.md) | application/json | Patient created |
|
|
62
|
+
|
|
63
|
+
## Success response examples
|
|
64
|
+
|
|
65
|
+
### 201
|
|
66
|
+
|
|
67
|
+
```json
|
|
68
|
+
{
|
|
69
|
+
"patient": {
|
|
70
|
+
"address": {
|
|
71
|
+
"city": "string",
|
|
72
|
+
"country": "string",
|
|
73
|
+
"state": "string",
|
|
74
|
+
"street1": "string",
|
|
75
|
+
"street2": "string",
|
|
76
|
+
"zip_code": "string"
|
|
77
|
+
},
|
|
78
|
+
"date_of_birth": "string",
|
|
79
|
+
"first_name": "string",
|
|
80
|
+
"gender": "string",
|
|
81
|
+
"last_name": "string",
|
|
82
|
+
"patient_id": "string",
|
|
83
|
+
"phone": {
|
|
84
|
+
"extension": "string",
|
|
85
|
+
"number": "string",
|
|
86
|
+
"type": "string"
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Common errors
|
|
93
|
+
|
|
94
|
+
| Status | Shape | Content type | Description |
|
|
95
|
+
|---|---|---|---|
|
|
96
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid patient details |
|
|
97
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
|
|
98
|
+
|
|
99
|
+
## Error examples
|
|
100
|
+
|
|
101
|
+
### 400
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "string"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### 401
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{
|
|
113
|
+
"error": "string"
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## NodeJS / TypeScript implementation
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
const request = {
|
|
125
|
+
"date_of_birth": "2026-01-01",
|
|
126
|
+
"email": "user@example.com",
|
|
127
|
+
"first_name": "string",
|
|
128
|
+
"gender": "male",
|
|
129
|
+
"last_name": "string"
|
|
130
|
+
};
|
|
131
|
+
|
|
132
|
+
const result = await provider.createPatient(request);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## cURL
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
curl -X POST \
|
|
139
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
140
|
+
-H 'Content-Type: application/json' \
|
|
141
|
+
-d '{"date_of_birth":"2026-01-01","email":"user@example.com","first_name":"string","gender":"male","last_name":"string"}' \
|
|
142
|
+
'https://dev-api-provider.health.cloud/patients'
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Notes
|
|
146
|
+
|
|
147
|
+
None.
|
|
148
|
+
|
|
149
|
+
## Prepared Test Console scenario
|
|
150
|
+
|
|
151
|
+
No canonical scenario is currently associated.
|
|
152
|
+
|
|
153
|
+
## Real response
|
|
154
|
+
|
|
155
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Counts for the provider's home screen
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.getHomeSummary`
|
|
4
|
+
|
|
5
|
+
The calling practitioner's own patients and encounters-by-status (never tenant-wide), counted by the FHIR store.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getHomeSummary`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.getHomeSummary()`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ProviderHomeSummaryResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /dashboard/summary`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
None.
|
|
40
|
+
|
|
41
|
+
Request model: None.
|
|
42
|
+
|
|
43
|
+
## Request example
|
|
44
|
+
|
|
45
|
+
None declared in canonical OpenAPI.
|
|
46
|
+
|
|
47
|
+
## Success responses
|
|
48
|
+
|
|
49
|
+
| Status | Shape | Content type | Description |
|
|
50
|
+
|---|---|---|---|
|
|
51
|
+
| `200` | [`ProviderHomeSummaryResponse`](../models/ProviderHomeSummaryResponse.md) | application/json | Home screen counts |
|
|
52
|
+
|
|
53
|
+
## Success response examples
|
|
54
|
+
|
|
55
|
+
### 200
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"as_of": "string",
|
|
60
|
+
"encounters": {
|
|
61
|
+
"arrived": 0,
|
|
62
|
+
"finished": 0,
|
|
63
|
+
"in_progress": 0,
|
|
64
|
+
"planned": 0,
|
|
65
|
+
"triaged": 0
|
|
66
|
+
},
|
|
67
|
+
"patients_total": 0
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Common errors
|
|
72
|
+
|
|
73
|
+
| Status | Shape | Content type | Description |
|
|
74
|
+
|---|---|---|---|
|
|
75
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
|
|
76
|
+
|
|
77
|
+
## Error examples
|
|
78
|
+
|
|
79
|
+
### 401
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"error": "string"
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## NodeJS / TypeScript implementation
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
const result = await provider.getHomeSummary();
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## cURL
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
curl -X GET \
|
|
101
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
102
|
+
'https://dev-api-provider.health.cloud/dashboard/summary'
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Notes
|
|
106
|
+
|
|
107
|
+
None.
|
|
108
|
+
|
|
109
|
+
## Prepared Test Console scenario
|
|
110
|
+
|
|
111
|
+
No canonical scenario is currently associated.
|
|
112
|
+
|
|
113
|
+
## Real response
|
|
114
|
+
|
|
115
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|