@healthcloudai/hc-sdk 2.6.1 → 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 +5837 -5797
- package/dist/index.d.ts +5837 -5797
- 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/InitHealthRecordImportResponse.md +2 -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/fieldagent.ResetPasswordRequest.md +1 -1
- package/docs/models/index.md +37 -0
- package/docs/models/person.ResetPasswordRequest.md +1 -1
- package/docs/models/provider.ResetPasswordRequest.md +1 -1
- package/docs/operations/diagnostics.getTestResult.md +1 -1
- package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
- 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/docs/operations/fieldagent.resetPassword.md +1 -1
- package/docs/operations/patient.initHealthRecordImport.md +3 -1
- package/docs/operations/patient.resetPassword.md +1 -1
- package/docs/operations/person.resetPassword.md +1 -1
- package/docs/operations/provider.resetPassword.md +1 -1
- package/package.json +1 -1
- /package/docs/models/{GoogleAiEmbedRequest.md → GoogleAIEmbedRequest.md} +0 -0
- /package/docs/models/{GoogleAiGenerateRequest.md → GoogleAIGenerateRequest.md} +0 -0
- /package/docs/models/{GoogleAiInvokeA1cVisionCaptureRequest.md → GoogleAIInvokeA1cVisionCaptureRequest.md} +0 -0
- /package/docs/models/{OpenaiBuildResponseCreatePayloadRequest.md → OpenAIBuildResponseCreatePayloadRequest.md} +0 -0
- /package/docs/models/{OpenaiChatJsonRequest.md → OpenAIChatJsonRequest.md} +0 -0
- /package/docs/models/{OpenaiChatRequest.md → OpenAIChatRequest.md} +0 -0
- /package/docs/models/{OpenaiCreateAssistantRequest.md → OpenAICreateAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiDeleteAssistantRequest.md → OpenAIDeleteAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiEmbedRequest.md → OpenAIEmbedRequest.md} +0 -0
- /package/docs/models/{OpenaiGetAssistantRequest.md → OpenAIGetAssistantRequest.md} +0 -0
- /package/docs/models/{OpenaiModerateRequest.md → OpenAIModerateRequest.md} +0 -0
- /package/docs/models/{OpenaiUpdateAssistantRequest.md → OpenAIUpdateAssistantRequest.md} +0 -0
- /package/docs/models/{SendgridListTemplatesRequest.md → SendGridListTemplatesRequest.md} +0 -0
- /package/docs/models/{SteadymdAddAllergyIntoleranceRequest.md → SteadyMDAddAllergyIntoleranceRequest.md} +0 -0
- /package/docs/models/{SteadymdClaimIdentityVerificationRequest.md → SteadyMDClaimIdentityVerificationRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultIssueRequest.md → SteadyMDCreateConsultIssueRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateConsultRequest.md → SteadyMDCreateConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeLabRequisitionRequest.md → SteadyMDCreateEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateEpisodeRequest.md → SteadyMDCreateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateIntakeRequest.md → SteadyMDCreateIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderRequest.md → SteadyMDCreateLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateLabOrderResultRequest.md → SteadyMDCreateLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdCreateMessageRequest.md → SteadyMDCreateMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdCreatePatientRequest.md → SteadyMDCreatePatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetClinicianRequest.md → SteadyMDGetClinicianRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultAvailabilityRequest.md → SteadyMDGetConsultAvailabilityRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultPatientUiRequest.md → SteadyMDGetConsultPatientUiRequest.md} +0 -0
- /package/docs/models/{SteadymdGetConsultRequest.md → SteadyMDGetConsultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeLabRequisitionRequest.md → SteadyMDGetEpisodeLabRequisitionRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeRequest.md → SteadyMDGetEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetEpisodeSignedDocumentsRequest.md → SteadyMDGetEpisodeSignedDocumentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetIntakeRequest.md → SteadyMDGetIntakeRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderPdfRequest.md → SteadyMDGetLabOrderPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderRequest.md → SteadyMDGetLabOrderRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabOrderResultRequest.md → SteadyMDGetLabOrderResultRequest.md} +0 -0
- /package/docs/models/{SteadymdGetLabResultPdfRequest.md → SteadyMDGetLabResultPdfRequest.md} +0 -0
- /package/docs/models/{SteadymdGetMessageRequest.md → SteadyMDGetMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdGetPatientRequest.md → SteadyMDGetPatientRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramAppointmentsRequest.md → SteadyMDGetProgramAppointmentsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramConsultOptionsRequest.md → SteadyMDGetProgramConsultOptionsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramLabsRequest.md → SteadyMDGetProgramLabsRequest.md} +0 -0
- /package/docs/models/{SteadymdGetProgramRequest.md → SteadyMDGetProgramRequest.md} +0 -0
- /package/docs/models/{SteadymdListConsultsRequest.md → SteadyMDListConsultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListIntakesRequest.md → SteadyMDListIntakesRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrderResultsRequest.md → SteadyMDListLabOrderResultsRequest.md} +0 -0
- /package/docs/models/{SteadymdListLabOrdersRequest.md → SteadyMDListLabOrdersRequest.md} +0 -0
- /package/docs/models/{SteadymdListMessagesRequest.md → SteadyMDListMessagesRequest.md} +0 -0
- /package/docs/models/{SteadymdListPharmaciesRequest.md → SteadyMDListPharmaciesRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramCliniciansRequest.md → SteadyMDListProgramCliniciansRequest.md} +0 -0
- /package/docs/models/{SteadymdListProgramsRequest.md → SteadyMDListProgramsRequest.md} +0 -0
- /package/docs/models/{SteadymdPatchEpisodeRequest.md → SteadyMDPatchEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdScheduleConsultAppointmentRequest.md → SteadyMDScheduleConsultAppointmentRequest.md} +0 -0
- /package/docs/models/{SteadymdSendConsultMessageRequest.md → SteadyMDSendConsultMessageRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateConsultStatusRequest.md → SteadyMDUpdateConsultStatusRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateEpisodeRequest.md → SteadyMDUpdateEpisodeRequest.md} +0 -0
- /package/docs/models/{SteadymdUpdateIntakeRequest.md → SteadyMDUpdateIntakeRequest.md} +0 -0
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# List a patient's encounters
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listEncounters`
|
|
4
|
+
|
|
5
|
+
List FHIR Encounter resources for a patient, optionally filtered by ?status=.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listEncounters`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listEncounters(patientId, status)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListEncountersResponse>`
|
|
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}/encounters`
|
|
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
|
+
| `status` | `string` | No | | planned, in-progress, finished, cancelled | | No | |
|
|
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.ListEncountersResponse`](../models/ehr.ListEncountersResponse.md) | application/json | Patient encounters |
|
|
56
|
+
|
|
57
|
+
## Success response examples
|
|
58
|
+
|
|
59
|
+
### 200
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"encounters": [
|
|
64
|
+
{
|
|
65
|
+
"appointment_id": "appointment-example-001",
|
|
66
|
+
"created_by": "agent-example-001",
|
|
67
|
+
"created_date": "2026-08-10T08:45:00Z",
|
|
68
|
+
"diagnoses[]": {
|
|
69
|
+
"condition_display": "Mild persistent asthma",
|
|
70
|
+
"condition_id": "condition-example-001",
|
|
71
|
+
"rank": 1,
|
|
72
|
+
"use_code": "CC"
|
|
73
|
+
},
|
|
74
|
+
"encounter_class": "AMB",
|
|
75
|
+
"encounter_id": "00000000-0000-4000-8000-000000000303",
|
|
76
|
+
"fhir_id": "encounter-example-001",
|
|
77
|
+
"hospitalization": {
|
|
78
|
+
"admit_source_code": "emd",
|
|
79
|
+
"destination_id": "location-example-002",
|
|
80
|
+
"discharge_disposition": "home",
|
|
81
|
+
"origin_id": "location-example-001",
|
|
82
|
+
"pre_admission_id": "encounter-example-000",
|
|
83
|
+
"re_admission_code": "R"
|
|
84
|
+
},
|
|
85
|
+
"length_minutes": 30,
|
|
86
|
+
"locations[]": {
|
|
87
|
+
"location_display": "Community Clinic Room 2",
|
|
88
|
+
"location_id": "location-example-001",
|
|
89
|
+
"period_end": "2026-08-10T09:30:00Z",
|
|
90
|
+
"period_start": "2026-08-10T09:00:00Z",
|
|
91
|
+
"status": "completed"
|
|
92
|
+
},
|
|
93
|
+
"participants[]": {
|
|
94
|
+
"participant_type": "PPRF",
|
|
95
|
+
"period_end": "2026-08-10T09:30:00Z",
|
|
96
|
+
"period_start": "2026-08-10T09:00:00Z",
|
|
97
|
+
"practitioner_display": "Dr. Alex Smith",
|
|
98
|
+
"practitioner_id": "provider-example-001"
|
|
99
|
+
},
|
|
100
|
+
"patient_id": "patient-example-001",
|
|
101
|
+
"period_end": "2026-08-10T09:30:00Z",
|
|
102
|
+
"period_start": "2026-08-10T09:00:00Z",
|
|
103
|
+
"priority_code": "R",
|
|
104
|
+
"priority_display": "Routine",
|
|
105
|
+
"reason_code": "185389009",
|
|
106
|
+
"reason_display": "Follow-up visit",
|
|
107
|
+
"service_provider_display": "HealthCloud Community Care",
|
|
108
|
+
"service_provider_id": "organization-example-001",
|
|
109
|
+
"service_type_code": "394802001",
|
|
110
|
+
"service_type_display": "General medicine",
|
|
111
|
+
"status": "finished",
|
|
112
|
+
"type_code": "185389009",
|
|
113
|
+
"type_display": "Follow-up visit"
|
|
114
|
+
}
|
|
115
|
+
],
|
|
116
|
+
"patient_id": "patient-example-001",
|
|
117
|
+
"total": 1
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Common errors
|
|
122
|
+
|
|
123
|
+
| Status | Shape | Content type | Description |
|
|
124
|
+
|---|---|---|---|
|
|
125
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
126
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
127
|
+
|
|
128
|
+
## Error examples
|
|
129
|
+
|
|
130
|
+
### 401 — Missing or invalid access token
|
|
131
|
+
|
|
132
|
+
```json
|
|
133
|
+
{
|
|
134
|
+
"error": "Authorization required"
|
|
135
|
+
}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
139
|
+
|
|
140
|
+
```json
|
|
141
|
+
{
|
|
142
|
+
"error": "Internal server error"
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## NodeJS / TypeScript implementation
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
```ts
|
|
153
|
+
const patientId = "<PATIENT_ID>";
|
|
154
|
+
|
|
155
|
+
const status = "planned";
|
|
156
|
+
|
|
157
|
+
const result = await ehr.listEncounters(patientId, status);
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## cURL
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
curl -X GET \
|
|
164
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
165
|
+
'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/encounters?status=planned'
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Notes
|
|
169
|
+
|
|
170
|
+
None.
|
|
171
|
+
|
|
172
|
+
## Prepared Test Console scenario
|
|
173
|
+
|
|
174
|
+
No canonical scenario is currently associated.
|
|
175
|
+
|
|
176
|
+
## Real response
|
|
177
|
+
|
|
178
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# List a patient's family history
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listFamilyHistory`
|
|
4
|
+
|
|
5
|
+
List FHIR FamilyMemberHistory resources for a patient.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listFamilyHistory`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listFamilyHistory(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListFamilyHistoryResponse>`
|
|
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}/family-history`
|
|
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` | [`ListFamilyHistoryResponse`](../models/ListFamilyHistoryResponse.md) | application/json | Successful Response |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"family_history": [
|
|
62
|
+
{
|
|
63
|
+
"age_at_death": 78,
|
|
64
|
+
"biological": true,
|
|
65
|
+
"born_date": "1945-05-10",
|
|
66
|
+
"cause_of_death": "Cardiovascular disease",
|
|
67
|
+
"conditions": [
|
|
68
|
+
{
|
|
69
|
+
"age_at_death": 78,
|
|
70
|
+
"age_at_onset": 55,
|
|
71
|
+
"condition": "Essential hypertension",
|
|
72
|
+
"icd10_code": "I10",
|
|
73
|
+
"notes": "Diagnosed in midlife"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"deceased": true,
|
|
77
|
+
"entry_id": "00000000-0000-4000-8000-000000000304",
|
|
78
|
+
"fhir_id": "family-history-example-001",
|
|
79
|
+
"member_name": "Jordan Smith",
|
|
80
|
+
"notes": "Synthetic paternal history",
|
|
81
|
+
"recorded_date": "2026-01-15",
|
|
82
|
+
"relationship": "father",
|
|
83
|
+
"sex": "male",
|
|
84
|
+
"status": "completed"
|
|
85
|
+
}
|
|
86
|
+
],
|
|
87
|
+
"patient_id": "patient-example-001",
|
|
88
|
+
"total": 1
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Common errors
|
|
93
|
+
|
|
94
|
+
| Status | Shape | Content type | Description |
|
|
95
|
+
|---|---|---|---|
|
|
96
|
+
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
97
|
+
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
|
|
98
|
+
|
|
99
|
+
## Error examples
|
|
100
|
+
|
|
101
|
+
### 401 — Missing or invalid access token
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "Authorization required"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{
|
|
113
|
+
"error": "Internal server error"
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## NodeJS / TypeScript implementation
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
```ts
|
|
124
|
+
const patientId = "<PATIENT_ID>";
|
|
125
|
+
|
|
126
|
+
const result = await ehr.listFamilyHistory(patientId);
|
|
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/family-history'
|
|
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 functional-status observations
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listFunctionalStatus`
|
|
4
|
+
|
|
5
|
+
List functional-status Observations for a patient (FHIR category survey or functional-status).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listFunctionalStatus`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listFunctionalStatus(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListFunctionalStatusResponse>`
|
|
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}/functional-status`
|
|
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` | [`ListFunctionalStatusResponse`](../models/ListFunctionalStatusResponse.md) | application/json | Patient functional-status observations |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"functional_status": [],
|
|
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.listFunctionalStatus(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/functional-status'
|
|
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.
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# List a patient's immunizations
|
|
2
|
+
|
|
3
|
+
Operation ID: `ehr.listImmunizations`
|
|
4
|
+
|
|
5
|
+
List FHIR Immunization resources for a patient.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listImmunizations`
|
|
10
|
+
|
|
11
|
+
Signature: `ehr.listImmunizations(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListImmunizationsResponse>`
|
|
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}/immunizations`
|
|
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` | [`ListImmunizationsResponse`](../models/ListImmunizationsResponse.md) | application/json | Successful Response |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"immunizations": [],
|
|
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.listImmunizations(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/immunizations'
|
|
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.
|