@healthcloudai/hc-sdk 2.6.2 → 2.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.
- package/dist/index.cjs +103 -0
- package/dist/index.d.cts +5805 -5777
- package/dist/index.d.ts +5805 -5777
- package/dist/index.js +103 -0
- package/docs/clients/EhrClient.md +15 -0
- package/docs/docs-manifest.json +55 -3
- package/docs/examples/index.md +15 -0
- package/docs/index.md +15 -0
- package/docs/models/Allergy.md +31 -0
- package/docs/models/AllergyCategory.md +15 -0
- package/docs/models/AllergyCriticality.md +15 -0
- package/docs/models/AllergyReaction.md +21 -0
- package/docs/models/AllergyStatus.md +15 -0
- package/docs/models/AllergyVerificationStatus.md +15 -0
- package/docs/models/CodedConcept.md +19 -0
- package/docs/models/FamilyCondition.md +21 -0
- package/docs/models/FamilyHistoryEntry.md +30 -0
- package/docs/models/FamilyHistoryStatus.md +15 -0
- package/docs/models/FamilyRelationship.md +15 -0
- package/docs/models/GetHealthRecordResponse.md +19 -0
- package/docs/models/IntoleranceType.md +15 -0
- package/docs/models/ListAllergiesResponse.md +19 -0
- package/docs/models/ListConditionsResponse.md +19 -0
- package/docs/models/ListDirectivesResponse.md +19 -0
- package/docs/models/ListFamilyHistoryResponse.md +19 -0
- package/docs/models/ListFunctionalStatusResponse.md +19 -0
- package/docs/models/ListImmunizationsResponse.md +19 -0
- package/docs/models/ListObservationsResponse.md +19 -0
- package/docs/models/ListProceduresResponse.md +19 -0
- package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
- package/docs/models/ListSocialHistoryResponse.md +19 -0
- package/docs/models/ListVitalsResponse.md +19 -0
- package/docs/models/Problem.md +37 -0
- package/docs/models/ProblemCategory.md +15 -0
- package/docs/models/ProblemClinicalStatus.md +15 -0
- package/docs/models/ProblemSeverity.md +15 -0
- package/docs/models/ProblemVerificationStatus.md +15 -0
- package/docs/models/QuestionnaireResponse.md +27 -0
- package/docs/models/QuestionnaireResponseStatus.md +15 -0
- package/docs/models/ReactionSeverity.md +15 -0
- package/docs/models/ResponseAnswer.md +27 -0
- package/docs/models/ResponseItem.md +21 -0
- package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
- package/docs/models/ehr.ListEncountersResponse.md +19 -0
- package/docs/models/ehr.ListMedicationsResponse.md +19 -0
- package/docs/models/index.md +37 -0
- package/docs/operations/ehr.getHealthRecord.md +122 -0
- package/docs/operations/ehr.listAllergies.md +156 -0
- package/docs/operations/ehr.listConditions.md +152 -0
- package/docs/operations/ehr.listDiagnostics.md +147 -0
- package/docs/operations/ehr.listDirectives.md +122 -0
- package/docs/operations/ehr.listEncounters.md +178 -0
- package/docs/operations/ehr.listFamilyHistory.md +147 -0
- package/docs/operations/ehr.listFunctionalStatus.md +122 -0
- package/docs/operations/ehr.listImmunizations.md +122 -0
- package/docs/operations/ehr.listMedications.md +163 -0
- package/docs/operations/ehr.listObservations.md +126 -0
- package/docs/operations/ehr.listProcedures.md +122 -0
- package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
- package/docs/operations/ehr.listSocialHistory.md +122 -0
- package/docs/operations/ehr.listVitals.md +132 -0
- package/package.json +1 -1
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# List a patient's allergies
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listAllergies`
|
|
4
|
+
|
|
5
|
+
List FHIR AllergyIntolerance resources for a patient.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listAllergies`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listAllergies(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListAllergiesResponse>`
|
|
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/{patient_id}/allergies`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `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` | [`ListAllergiesResponse`](../models/ListAllergiesResponse.md) | application/json | Successful Response |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"allergies": [
|
|
62
|
+
{
|
|
63
|
+
"allergen": "Peanut",
|
|
64
|
+
"allergen_code": {
|
|
65
|
+
"code": "91935009",
|
|
66
|
+
"display": "Allergy to peanut",
|
|
67
|
+
"system": "http://snomed.info/sct"
|
|
68
|
+
},
|
|
69
|
+
"allergy_id": "00000000-0000-4000-8000-000000000301",
|
|
70
|
+
"asserted_by": "provider-example-001",
|
|
71
|
+
"asserted_date": "2026-01-15T10:00:00Z",
|
|
72
|
+
"category": "food",
|
|
73
|
+
"criticality": "high",
|
|
74
|
+
"fhir_id": "allergy-example-001",
|
|
75
|
+
"intolerance_type": "allergy",
|
|
76
|
+
"notes": "Synthetic confirmed food allergy",
|
|
77
|
+
"onset_date": "2015-06-01",
|
|
78
|
+
"reactions": [
|
|
79
|
+
{
|
|
80
|
+
"manifestation": "Urticaria",
|
|
81
|
+
"manifestation_code": {
|
|
82
|
+
"code": "126485001",
|
|
83
|
+
"display": "Urticaria",
|
|
84
|
+
"system": "http://snomed.info/sct"
|
|
85
|
+
},
|
|
86
|
+
"notes": "Hives after exposure",
|
|
87
|
+
"onset": "2015-06-01T12:00:00Z",
|
|
88
|
+
"severity": "severe"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"resolved_date": null,
|
|
92
|
+
"status": "active",
|
|
93
|
+
"verification_status": "confirmed"
|
|
94
|
+
}
|
|
95
|
+
],
|
|
96
|
+
"patient_id": "patient-example-001",
|
|
97
|
+
"total": 1
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Common errors
|
|
102
|
+
|
|
103
|
+
| Status | Shape | Content type | Description |
|
|
104
|
+
|---|---|---|---|
|
|
105
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
106
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
107
|
+
|
|
108
|
+
## Error examples
|
|
109
|
+
|
|
110
|
+
### 401 — Missing or invalid access token
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"error": "Authorization required"
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
119
|
+
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"error": "Internal server error"
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## NodeJS / TypeScript implementation
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
```ts
|
|
133
|
+
const patientId = "<PATIENT_ID>";
|
|
134
|
+
|
|
135
|
+
const result = await ehr.listAllergies(patientId);
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## cURL
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
curl -X GET \
|
|
142
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
143
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/allergies'
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Notes
|
|
147
|
+
|
|
148
|
+
None.
|
|
149
|
+
|
|
150
|
+
## Prepared Test Console scenario
|
|
151
|
+
|
|
152
|
+
No canonical scenario is currently associated.
|
|
153
|
+
|
|
154
|
+
## Real response
|
|
155
|
+
|
|
156
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# List a patient's conditions
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listConditions`
|
|
4
|
+
|
|
5
|
+
List FHIR Condition resources for a patient, optionally filtered by ?clinical_status= (e.g. active, resolved).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listConditions`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listConditions(patientId, clinicalStatus)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListConditionsResponse>`
|
|
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/{patient_id}/conditions`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
38
|
+
|---|---|---:|---|---|---|---:|---|
|
|
39
|
+
| `clinical_status` | `string` | No | | | | No | Filter: active, recurrence, relapse, inactive, remission, resolved |
|
|
40
|
+
|
|
41
|
+
## Body parameters
|
|
42
|
+
|
|
43
|
+
None.
|
|
44
|
+
|
|
45
|
+
Request model: None.
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
None declared in canonical OpenAPI.
|
|
50
|
+
|
|
51
|
+
## Success responses
|
|
52
|
+
|
|
53
|
+
| Status | Shape | Content type | Description |
|
|
54
|
+
|---|---|---|---|
|
|
55
|
+
| `200` | [`ListConditionsResponse`](../models/ListConditionsResponse.md) | application/json | Successful Response |
|
|
56
|
+
|
|
57
|
+
## Success response examples
|
|
58
|
+
|
|
59
|
+
### 200
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"conditions": [
|
|
64
|
+
{
|
|
65
|
+
"asserted_date": "2026-01-15T10:00:00Z",
|
|
66
|
+
"asserter_name": "Dr. Alex Smith",
|
|
67
|
+
"asserter_type": "Practitioner",
|
|
68
|
+
"body_site": "Respiratory system",
|
|
69
|
+
"categories": [
|
|
70
|
+
"problem-list-item"
|
|
71
|
+
],
|
|
72
|
+
"clinical_status": "active",
|
|
73
|
+
"description": "Mild persistent asthma",
|
|
74
|
+
"encounter_id": "encounter-example-001",
|
|
75
|
+
"fhir_id": "condition-example-001",
|
|
76
|
+
"icd10_code": "J45.30",
|
|
77
|
+
"laterality": "not_applicable",
|
|
78
|
+
"notes": "Controlled with maintenance therapy",
|
|
79
|
+
"onset_age": 25,
|
|
80
|
+
"onset_date": "2015-01-01",
|
|
81
|
+
"problem_id": "00000000-0000-4000-8000-000000000302",
|
|
82
|
+
"recorded_date": "2026-01-15",
|
|
83
|
+
"recorder_name": "Dr. Alex Smith",
|
|
84
|
+
"resolved_date": null,
|
|
85
|
+
"severity": "mild",
|
|
86
|
+
"snomed_code": "195967001",
|
|
87
|
+
"verification_status": "confirmed"
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"patient_id": "patient-example-001",
|
|
91
|
+
"total": 1
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Common errors
|
|
96
|
+
|
|
97
|
+
| Status | Shape | Content type | Description |
|
|
98
|
+
|---|---|---|---|
|
|
99
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
100
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
101
|
+
|
|
102
|
+
## Error examples
|
|
103
|
+
|
|
104
|
+
### 401 — Missing or invalid access token
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"error": "Authorization required"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"error": "Internal server error"
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## NodeJS / TypeScript implementation
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
```ts
|
|
127
|
+
const patientId = "<PATIENT_ID>";
|
|
128
|
+
|
|
129
|
+
const clinicalStatus = "<CLINICAL_STATUS>";
|
|
130
|
+
|
|
131
|
+
const result = await ehr.listConditions(patientId, clinicalStatus);
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## cURL
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
curl -X GET \
|
|
138
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
139
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/conditions?clinical_status=%3CCLINICAL_STATUS%3E'
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Notes
|
|
143
|
+
|
|
144
|
+
None.
|
|
145
|
+
|
|
146
|
+
## Prepared Test Console scenario
|
|
147
|
+
|
|
148
|
+
No canonical scenario is currently associated.
|
|
149
|
+
|
|
150
|
+
## Real response
|
|
151
|
+
|
|
152
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# List a patient's diagnostic/lab observations
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listDiagnostics`
|
|
4
|
+
|
|
5
|
+
List lab/diagnostic Observations for a patient, optionally filtered by ?code= (LOINC code).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listDiagnostics`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listDiagnostics(patientId, code)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListDiagnosticsResponse>`
|
|
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/{patient_id}/diagnostics`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
38
|
+
|---|---|---:|---|---|---|---:|---|
|
|
39
|
+
| `code` | `string` | No | | | | No | LOINC code or other observation code to filter by |
|
|
40
|
+
|
|
41
|
+
## Body parameters
|
|
42
|
+
|
|
43
|
+
None.
|
|
44
|
+
|
|
45
|
+
Request model: None.
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
None declared in canonical OpenAPI.
|
|
50
|
+
|
|
51
|
+
## Success responses
|
|
52
|
+
|
|
53
|
+
| Status | Shape | Content type | Description |
|
|
54
|
+
|---|---|---|---|
|
|
55
|
+
| `200` | [`ehr.ListDiagnosticsResponse`](../models/ehr.ListDiagnosticsResponse.md) | application/json | Patient diagnostic/lab observations |
|
|
56
|
+
|
|
57
|
+
## Success response examples
|
|
58
|
+
|
|
59
|
+
### 200
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"diagnostics": [
|
|
64
|
+
{
|
|
65
|
+
"display": "Hemoglobin A1c",
|
|
66
|
+
"effective_datetime": "2026-08-10T12:00:00Z",
|
|
67
|
+
"interpretation": "N",
|
|
68
|
+
"loinc_code": "4548-4",
|
|
69
|
+
"notes": "Synthetic laboratory result",
|
|
70
|
+
"observation_id": "observation-example-001",
|
|
71
|
+
"reference_range": {
|
|
72
|
+
"high": 5.7,
|
|
73
|
+
"low": 4,
|
|
74
|
+
"text": "4.0-5.6 percent",
|
|
75
|
+
"unit": "%"
|
|
76
|
+
},
|
|
77
|
+
"status": "final",
|
|
78
|
+
"value_boolean": null,
|
|
79
|
+
"value_coding": {},
|
|
80
|
+
"value_quantity": 5.2,
|
|
81
|
+
"value_string": null,
|
|
82
|
+
"value_unit": "%"
|
|
83
|
+
}
|
|
84
|
+
],
|
|
85
|
+
"patient_id": "patient-example-001",
|
|
86
|
+
"total": 1
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Common errors
|
|
91
|
+
|
|
92
|
+
| Status | Shape | Content type | Description |
|
|
93
|
+
|---|---|---|---|
|
|
94
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
95
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
96
|
+
|
|
97
|
+
## Error examples
|
|
98
|
+
|
|
99
|
+
### 401 — Missing or invalid access token
|
|
100
|
+
|
|
101
|
+
```json
|
|
102
|
+
{
|
|
103
|
+
"error": "Authorization required"
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"error": "Internal server error"
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## NodeJS / TypeScript implementation
|
|
116
|
+
|
|
117
|
+
```ts
|
|
118
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
```ts
|
|
122
|
+
const patientId = "<PATIENT_ID>";
|
|
123
|
+
|
|
124
|
+
const code = "<CODE>";
|
|
125
|
+
|
|
126
|
+
const result = await ehr.listDiagnostics(patientId, code);
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## cURL
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
curl -X GET \
|
|
133
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
134
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics?code=%3CCODE%3E'
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Notes
|
|
138
|
+
|
|
139
|
+
None.
|
|
140
|
+
|
|
141
|
+
## Prepared Test Console scenario
|
|
142
|
+
|
|
143
|
+
No canonical scenario is currently associated.
|
|
144
|
+
|
|
145
|
+
## Real response
|
|
146
|
+
|
|
147
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# List a patient's advance directives
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listDirectives`
|
|
4
|
+
|
|
5
|
+
List FHIR Consent resources representing a patient's advance directives.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listDirectives`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listDirectives(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListDirectivesResponse>`
|
|
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/{patient_id}/directives`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `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` | [`ListDirectivesResponse`](../models/ListDirectivesResponse.md) | application/json | Successful Response |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"directives": [],
|
|
62
|
+
"patient_id": "patient-example-001",
|
|
63
|
+
"total": 0
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common errors
|
|
68
|
+
|
|
69
|
+
| Status | Shape | Content type | Description |
|
|
70
|
+
|---|---|---|---|
|
|
71
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
72
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
73
|
+
|
|
74
|
+
## Error examples
|
|
75
|
+
|
|
76
|
+
### 401 — Missing or invalid access token
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"error": "Authorization required"
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
85
|
+
|
|
86
|
+
```json
|
|
87
|
+
{
|
|
88
|
+
"error": "Internal server error"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## NodeJS / TypeScript implementation
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```ts
|
|
99
|
+
const patientId = "<PATIENT_ID>";
|
|
100
|
+
|
|
101
|
+
const result = await ehr.listDirectives(patientId);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## cURL
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
curl -X GET \
|
|
108
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
109
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/directives'
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Notes
|
|
113
|
+
|
|
114
|
+
None.
|
|
115
|
+
|
|
116
|
+
## Prepared Test Console scenario
|
|
117
|
+
|
|
118
|
+
No canonical scenario is currently associated.
|
|
119
|
+
|
|
120
|
+
## Real response
|
|
121
|
+
|
|
122
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|