@healthcloudai/hc-sdk 2.6.2 → 2.8.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.
Files changed (112) hide show
  1. package/dist/index.cjs +173 -0
  2. package/dist/index.d.cts +5950 -5764
  3. package/dist/index.d.ts +5950 -5764
  4. package/dist/index.js +173 -0
  5. package/docs/clients/EhrClient.md +15 -0
  6. package/docs/clients/PatientClient.md +3 -0
  7. package/docs/docs-manifest.json +62 -5
  8. package/docs/examples/index.md +18 -0
  9. package/docs/index.md +18 -0
  10. package/docs/models/AddInsuranceRequest.md +1 -0
  11. package/docs/models/AddInsuranceResponse.md +2 -0
  12. package/docs/models/Allergy.md +31 -0
  13. package/docs/models/AllergyCategory.md +15 -0
  14. package/docs/models/AllergyCriticality.md +15 -0
  15. package/docs/models/AllergyReaction.md +21 -0
  16. package/docs/models/AllergyStatus.md +15 -0
  17. package/docs/models/AllergyVerificationStatus.md +15 -0
  18. package/docs/models/Appointment.md +1 -0
  19. package/docs/models/AthenaAppointment.md +1 -0
  20. package/docs/models/BookAppointmentRequest.md +1 -0
  21. package/docs/models/CheckEncounterRequest.md +17 -0
  22. package/docs/models/CheckInEncounterRequest.md +17 -0
  23. package/docs/models/CodedConcept.md +19 -0
  24. package/docs/models/FamilyCondition.md +21 -0
  25. package/docs/models/FamilyHistoryEntry.md +30 -0
  26. package/docs/models/FamilyHistoryStatus.md +15 -0
  27. package/docs/models/FamilyRelationship.md +15 -0
  28. package/docs/models/GS1LookupResponse.md +3 -2
  29. package/docs/models/GetEncounterResponse.md +3 -0
  30. package/docs/models/GetHealthRecordResponse.md +19 -0
  31. package/docs/models/GetLatestEncounterResponse.md +17 -0
  32. package/docs/models/GetPatientResponse.md +2 -0
  33. package/docs/models/GetScanUploadUrlRequest.md +3 -2
  34. package/docs/models/GetTestResultResponse.md +20 -0
  35. package/docs/models/IntoleranceType.md +15 -0
  36. package/docs/models/ListAllergiesResponse.md +19 -0
  37. package/docs/models/ListConditionsResponse.md +19 -0
  38. package/docs/models/ListDirectivesResponse.md +19 -0
  39. package/docs/models/ListFamilyHistoryResponse.md +19 -0
  40. package/docs/models/ListFunctionalStatusResponse.md +19 -0
  41. package/docs/models/ListImmunizationsResponse.md +19 -0
  42. package/docs/models/ListObservationsResponse.md +19 -0
  43. package/docs/models/ListProceduresResponse.md +19 -0
  44. package/docs/models/ListQuestionnaireResponsesResponse.md +19 -0
  45. package/docs/models/ListSocialHistoryResponse.md +19 -0
  46. package/docs/models/ListVitalsResponse.md +19 -0
  47. package/docs/models/PatientDemographics.md +2 -0
  48. package/docs/models/Problem.md +37 -0
  49. package/docs/models/ProblemCategory.md +15 -0
  50. package/docs/models/ProblemClinicalStatus.md +15 -0
  51. package/docs/models/ProblemSeverity.md +15 -0
  52. package/docs/models/ProblemVerificationStatus.md +15 -0
  53. package/docs/models/QuestionnaireResponse.md +27 -0
  54. package/docs/models/QuestionnaireResponseStatus.md +15 -0
  55. package/docs/models/ReactionSeverity.md +15 -0
  56. package/docs/models/ResponseAnswer.md +27 -0
  57. package/docs/models/ResponseItem.md +21 -0
  58. package/docs/models/ScanUploadResponse.md +4 -4
  59. package/docs/models/Slot.md +1 -0
  60. package/docs/models/ehr.ListDiagnosticsResponse.md +19 -0
  61. package/docs/models/ehr.ListEncountersResponse.md +19 -0
  62. package/docs/models/ehr.ListMedicationsResponse.md +19 -0
  63. package/docs/models/fieldagent.Encounter.md +3 -0
  64. package/docs/models/index.md +41 -2
  65. package/docs/models/patient.Encounter.md +3 -0
  66. package/docs/operations/appointments.book.md +18 -15
  67. package/docs/operations/appointments.cancel.md +12 -11
  68. package/docs/operations/appointments.createSlot.md +44 -9
  69. package/docs/operations/appointments.listPatientAppointments.md +13 -12
  70. package/docs/operations/appointments.listSlots.md +9 -8
  71. package/docs/operations/appointments.reschedule.md +11 -10
  72. package/docs/operations/connectors.athenaBookAppointment.md +1 -0
  73. package/docs/operations/connectors.athenaCreateInsurancePackage.md +1 -1
  74. package/docs/operations/connectors.athenaGetAppointmentDetails.md +1 -0
  75. package/docs/operations/connectors.athenaGetBookedAppointments.md +1 -0
  76. package/docs/operations/connectors.athenaGetEncounter.md +1 -0
  77. package/docs/operations/connectors.athenaListAppointments.md +1 -0
  78. package/docs/operations/connectors.athenaListPatientAppointments.md +1 -0
  79. package/docs/operations/diagnostics.getScanUploadUrl.md +7 -5
  80. package/docs/operations/diagnostics.getTestResult.md +5 -23
  81. package/docs/operations/diagnostics.lookupTestByGs1.md +12 -6
  82. package/docs/operations/ehr.getHealthRecord.md +122 -0
  83. package/docs/operations/ehr.listAllergies.md +156 -0
  84. package/docs/operations/ehr.listConditions.md +152 -0
  85. package/docs/operations/ehr.listDiagnostics.md +147 -0
  86. package/docs/operations/ehr.listDirectives.md +122 -0
  87. package/docs/operations/ehr.listEncounters.md +178 -0
  88. package/docs/operations/ehr.listFamilyHistory.md +147 -0
  89. package/docs/operations/ehr.listFunctionalStatus.md +122 -0
  90. package/docs/operations/ehr.listImmunizations.md +122 -0
  91. package/docs/operations/ehr.listMedications.md +163 -0
  92. package/docs/operations/ehr.listObservations.md +126 -0
  93. package/docs/operations/ehr.listProcedures.md +122 -0
  94. package/docs/operations/ehr.listQuestionnaireResponses.md +162 -0
  95. package/docs/operations/ehr.listSocialHistory.md +122 -0
  96. package/docs/operations/ehr.listVitals.md +132 -0
  97. package/docs/operations/fieldagent.listEncounters.md +42 -39
  98. package/docs/operations/fieldagent.listPatients.md +60 -95
  99. package/docs/operations/patient.addInsurance.md +14 -10
  100. package/docs/operations/patient.checkEncounter.md +110 -0
  101. package/docs/operations/patient.checkInEncounter.md +173 -0
  102. package/docs/operations/patient.createEncounter.md +40 -37
  103. package/docs/operations/patient.getCheckinCheckin.md +41 -38
  104. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +43 -40
  105. package/docs/operations/patient.getEncounter.md +40 -37
  106. package/docs/operations/patient.getLatestEncounter.md +162 -0
  107. package/docs/operations/patient.getPatient.md +57 -92
  108. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +97 -129
  109. package/docs/operations/patient.listEncounters.md +41 -38
  110. package/package.json +1 -1
  111. package/docs/models/PanelResult.md +0 -24
  112. package/docs/models/SingleTestResultResponse.md +0 -28
@@ -0,0 +1,122 @@
1
+ # List a patient's social history
2
+
3
+ Operation ID: `ehr.listSocialHistory`
4
+
5
+ List social-history Observations for a patient (e.g. smoking status, alcohol use).
6
+
7
+ ## Public method
8
+
9
+ `listSocialHistory`
10
+
11
+ Signature: `ehr.listSocialHistory(patientId)`
12
+
13
+ Return type: `Promise<ListSocialHistoryResponse>`
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}/social-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` | [`ListSocialHistoryResponse`](../models/ListSocialHistoryResponse.md) | application/json | Successful Response |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "patient_id": "patient-example-001",
62
+ "social_history": [],
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.listSocialHistory(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/social-history'
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,132 @@
1
+ # List a patient's vitals
2
+
3
+ Operation ID: `ehr.listVitals`
4
+
5
+ List vital-sign Observations for a patient, optionally filtered by ?type= (LOINC code), ?date_from=, and/or ?date_to=.
6
+
7
+ ## Public method
8
+
9
+ `listVitals`
10
+
11
+ Signature: `ehr.listVitals(patientId, dateFrom, dateTo, type)`
12
+
13
+ Return type: `Promise<ListVitalsResponse>`
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}/vitals`
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
+ | `date_from` | `string` | No | | | | No | ISO date filter start (e.g. 2025-01-01) |
40
+ | `date_to` | `string` | No | | | | No | ISO date filter end (e.g. 2025-12-31) |
41
+ | `type` | `string` | No | | | | No | Filter: blood-pressure, heart-rate, body-temperature, body-weight, oxygen-saturation, etc. |
42
+
43
+ ## Body parameters
44
+
45
+ None.
46
+
47
+ Request model: None.
48
+
49
+ ## Request example
50
+
51
+ None declared in canonical OpenAPI.
52
+
53
+ ## Success responses
54
+
55
+ | Status | Shape | Content type | Description |
56
+ |---|---|---|---|
57
+ | `200` | [`ListVitalsResponse`](../models/ListVitalsResponse.md) | application/json | Successful Response |
58
+
59
+ ## Success response examples
60
+
61
+ ### 200
62
+
63
+ ```json
64
+ {
65
+ "patient_id": "patient-example-001",
66
+ "total": 0,
67
+ "vitals": []
68
+ }
69
+ ```
70
+
71
+ ## Common errors
72
+
73
+ | Status | Shape | Content type | Description |
74
+ |---|---|---|---|
75
+ | `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
76
+ | `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |
77
+
78
+ ## Error examples
79
+
80
+ ### 401 — Missing or invalid access token
81
+
82
+ ```json
83
+ {
84
+ "error": "Authorization required"
85
+ }
86
+ ```
87
+
88
+ ### 500 — Unexpected service failure (sanitized example)
89
+
90
+ ```json
91
+ {
92
+ "error": "Internal server error"
93
+ }
94
+ ```
95
+
96
+ ## NodeJS / TypeScript implementation
97
+
98
+ ```ts
99
+ import { HCSDK } from "@healthcloudai/hc-sdk";
100
+ ```
101
+
102
+ ```ts
103
+ const patientId = "<PATIENT_ID>";
104
+
105
+ const dateFrom = "2026-08-01";
106
+
107
+ const dateTo = "2026-08-31";
108
+
109
+ const type = "<TYPE>";
110
+
111
+ const result = await ehr.listVitals(patientId, dateFrom, dateTo, type);
112
+ ```
113
+
114
+ ## cURL
115
+
116
+ ```bash
117
+ curl -X GET \
118
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
119
+ 'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/vitals?date_from=2026-08-01&date_to=2026-08-31&type=%3CTYPE%3E'
120
+ ```
121
+
122
+ ## Notes
123
+
124
+ None.
125
+
126
+ ## Prepared Test Console scenario
127
+
128
+ No canonical scenario is currently associated.
129
+
130
+ ## Real response
131
+
132
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -61,68 +61,71 @@ None declared in canonical OpenAPI.
61
61
 
62
62
  ```json
63
63
  {
64
- "created_by": "agent-example-001",
64
+ "created_by": "string",
65
65
  "encounters": [
66
66
  {
67
- "appointment_id": "appointment-example-001",
68
- "created_by": "agent-example-001",
69
- "created_date": "2026-08-10T08:45:00Z",
67
+ "appointment_id": "string",
68
+ "athena_appointment_id": "string",
69
+ "athena_encounter_id": "string",
70
+ "created_by": "self",
71
+ "created_date": "2026-01-01T09:00:00Z",
70
72
  "diagnoses": [
71
73
  {
72
- "condition_display": "Essential hypertension",
73
- "condition_id": "condition-example-001",
74
+ "condition_display": "string",
75
+ "condition_id": "string",
74
76
  "rank": 1,
75
77
  "use_code": "CC"
76
78
  }
77
79
  ],
78
80
  "encounter_class": "AMB",
79
- "encounter_id": "00000000-0000-4000-8000-000000000101",
80
- "fhir_id": "encounter-example-001",
81
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
82
+ "fhir_id": "string",
81
83
  "hospitalization": {
82
- "admit_source_code": "emd",
83
- "destination_id": "location-example-002",
84
+ "admit_source_code": "string",
85
+ "destination_id": "string",
84
86
  "discharge_disposition": "home",
85
- "origin_id": "location-example-001",
86
- "pre_admission_id": "encounter-example-000",
87
- "re_admission_code": "R"
87
+ "origin_id": "string",
88
+ "pre_admission_id": "string",
89
+ "re_admission_code": "string"
88
90
  },
89
- "length_minutes": 30,
91
+ "length_minutes": 0,
90
92
  "locations": [
91
93
  {
92
- "location_display": "Community Clinic Room 2",
93
- "location_id": "location-example-001",
94
- "period_end": "2026-08-10T09:30:00Z",
95
- "period_start": "2026-08-10T09:00:00Z",
96
- "status": "completed"
94
+ "location_display": "string",
95
+ "location_id": "string",
96
+ "period_end": "2026-01-01T09:00:00Z",
97
+ "period_start": "2026-01-01T09:00:00Z",
98
+ "status": "active"
97
99
  }
98
100
  ],
101
+ "notes": "string",
99
102
  "participants": [
100
103
  {
101
104
  "participant_type": "PPRF",
102
- "period_end": "2026-08-10T09:30:00Z",
103
- "period_start": "2026-08-10T09:00:00Z",
104
- "practitioner_display": "Dr. Taylor Morgan",
105
- "practitioner_id": "provider-example-001"
105
+ "period_end": "2026-01-01T09:00:00Z",
106
+ "period_start": "2026-01-01T09:00:00Z",
107
+ "practitioner_display": "string",
108
+ "practitioner_id": "string"
106
109
  }
107
110
  ],
108
- "patient_id": "patient-example-001",
109
- "period_end": "2026-08-10T09:30:00Z",
110
- "period_start": "2026-08-10T09:00:00Z",
111
- "priority_code": "R",
112
- "priority_display": "Routine",
113
- "reason_code": "11429006",
114
- "reason_display": "Routine health examination",
115
- "service_provider_display": "HealthCloud Community Care",
116
- "service_provider_id": "organization-example-001",
117
- "service_type_code": "394802001",
118
- "service_type_display": "General medicine",
119
- "status": "finished",
120
- "type_code": "185389009",
121
- "type_display": "Follow-up visit"
111
+ "patient_id": "string",
112
+ "period_end": "2026-01-01T09:00:00Z",
113
+ "period_start": "2026-01-01T09:00:00Z",
114
+ "priority_code": "string",
115
+ "priority_display": "string",
116
+ "reason_code": "string",
117
+ "reason_display": "string",
118
+ "service_provider_display": "string",
119
+ "service_provider_id": "string",
120
+ "service_type_code": "string",
121
+ "service_type_display": "string",
122
+ "status": "planned",
123
+ "type_code": "string",
124
+ "type_display": "string"
122
125
  }
123
126
  ],
124
- "patient_id": "patient-example-001",
125
- "total": 1
127
+ "patient_id": "string",
128
+ "total": 0
126
129
  }
127
130
  ```
128
131
 
@@ -62,134 +62,99 @@ None declared in canonical OpenAPI.
62
62
 
63
63
  ```json
64
64
  {
65
- "created_by": "agent-example-001",
66
- "next_page_token": "next-page-example-001",
65
+ "created_by": "string",
66
+ "next_page_token": "string",
67
67
  "patients": [
68
68
  {
69
69
  "active": true,
70
- "addresses": [
71
- {
72
- "city": "Springfield",
73
- "country": "US",
74
- "is_primary": true,
75
- "state": "IL",
76
- "street1": "100 Health Avenue",
77
- "street2": "Apartment 4B",
78
- "type": "home",
79
- "zip_code": "62701"
80
- }
81
- ],
70
+ "addresses": [],
71
+ "athena_patient_id": "string",
72
+ "athena_practice_id": "string",
82
73
  "attributes": {},
83
74
  "communications": [
84
75
  {
85
- "language": "en-US",
86
- "preferred": true
76
+ "language": "string",
77
+ "preferred": false
87
78
  }
88
79
  ],
89
- "created_by": "agent-example-001",
90
- "created_date": "2026-08-10T08:30:00Z",
91
- "date_of_birth": "1990-01-01",
80
+ "created_by": "self",
81
+ "created_date": "2026-01-01T09:00:00Z",
82
+ "date_of_birth": "2026-01-01",
92
83
  "deceased": false,
93
- "deceased_cause": null,
94
- "deceased_date": null,
95
- "email": "test.patient@example.com",
96
- "emergency_contacts": [
97
- {
98
- "email": "emergency.contact@example.com",
99
- "first_name": "Jamie",
100
- "is_primary": true,
101
- "last_name": "Smith",
102
- "phones": [
103
- {
104
- "extension": "101",
105
- "is_primary": true,
106
- "number": "+15550100003",
107
- "sms_enabled": true,
108
- "type": "mobile"
109
- }
110
- ],
111
- "relationship": "Spouse",
112
- "relationship_v2_code": "SPS"
113
- }
114
- ],
115
- "ethnicity": "not_hispanic_or_latino",
116
- "fhir_id": "patient-example-001",
84
+ "deceased_cause": "string",
85
+ "deceased_date": "2026-01-01",
86
+ "email": "user@example.com",
87
+ "emergency_contacts": [],
88
+ "ethnicity": "hispanic_or_latino",
89
+ "fhir_id": "string",
117
90
  "flags": {},
118
- "gender": "female",
119
- "gender_identity": "woman",
91
+ "gender": "male",
92
+ "gender_identity": "man",
120
93
  "insurance": [
121
94
  {
122
- "copay": 25,
123
- "deductible": 500,
95
+ "copay": 0,
96
+ "deductible": 0,
124
97
  "effective_date": "2026-01-01",
125
- "group_number": "GROUP-1001",
126
- "member_id": "MEMBER-1001",
127
- "payer_id": "PAYER-1001",
128
- "payer_name": "Example Health Plan",
129
- "plan_name": "Example Silver Plan",
130
- "plan_type": "PPO",
98
+ "group_number": "string",
99
+ "member_id": "string",
100
+ "payer_id": "string",
101
+ "payer_name": "string",
102
+ "plan_name": "string",
103
+ "plan_type": "string",
131
104
  "priority": "primary",
132
- "subscriber_date_of_birth": "1990-01-01",
133
- "subscriber_first_name": "Alex",
134
- "subscriber_id": "SUBSCRIBER-1001",
135
- "subscriber_last_name": "Smith",
105
+ "subscriber_date_of_birth": "2026-01-01",
106
+ "subscriber_first_name": "string",
107
+ "subscriber_id": "string",
108
+ "subscriber_last_name": "string",
136
109
  "subscriber_relationship": "self",
137
- "termination_date": "2026-12-31"
110
+ "termination_date": "2026-01-01"
138
111
  }
139
112
  ],
140
113
  "links": [
141
114
  {
142
- "other_patient_fhir_id": "patient-example-002",
115
+ "other_patient_fhir_id": "string",
143
116
  "type": "seealso"
144
117
  }
145
118
  ],
146
- "managing_organization_id": "organization-example-001",
147
- "marital_status": "married",
148
- "mrn": "MRN-100001",
119
+ "managing_organization_id": "string",
120
+ "marital_status": "single",
121
+ "mrn": "string",
149
122
  "name": {
150
- "first_name": "Alex",
151
- "last_name": "Smith",
152
- "middle_name": "Jordan",
153
- "preferred_name": "Alex",
154
- "prefix": "Mx.",
155
- "suffix": "Jr.",
123
+ "first_name": "string",
124
+ "last_name": "string",
125
+ "middle_name": "string",
126
+ "preferred_name": "string",
127
+ "prefix": "string",
128
+ "suffix": "string",
156
129
  "use": "official"
157
130
  },
158
- "nationality": "US",
159
- "patient_id": "00000000-0000-4000-8000-000000000201",
160
- "phones": [
161
- {
162
- "extension": "",
163
- "is_primary": true,
164
- "number": "+15550100000",
165
- "sms_enabled": true,
166
- "type": "mobile"
167
- }
168
- ],
169
- "photo_binary_id": "photo-example-002",
131
+ "nationality": "st",
132
+ "patient_id": "00000000-0000-0000-0000-000000000000",
133
+ "phones": [],
134
+ "photo_binary_id": "string",
170
135
  "preferred_language": "en",
171
136
  "preferred_pharmacy": {
172
- "address_city": "Springfield",
173
- "address_state": "IL",
174
- "address_street1": "200 Pharmacy Lane",
175
- "address_street2": "Suite 1",
176
- "address_zip": "62701",
177
- "fax": "+15550100005",
137
+ "address_city": "string",
138
+ "address_state": "string",
139
+ "address_street1": "string",
140
+ "address_street2": "string",
141
+ "address_zip": "string",
142
+ "fax": "string",
178
143
  "is_mail_order": false,
179
- "name": "Example Community Pharmacy",
180
- "ncpdp_id": "1234567",
181
- "notes": "Preferred for routine prescriptions",
182
- "npi": "1234567893",
183
- "pharmacy_id": "pharmacy-example-001",
184
- "phone": "+15550100004"
144
+ "name": "string",
145
+ "ncpdp_id": "string",
146
+ "notes": "string",
147
+ "npi": "string",
148
+ "pharmacy_id": "string",
149
+ "phone": "string"
185
150
  },
186
151
  "race": [
187
- "white"
152
+ "american_indian_or_alaska_native"
188
153
  ],
189
- "sex_at_birth": "female"
154
+ "sex_at_birth": "male"
190
155
  }
191
156
  ],
192
- "total": 1
157
+ "total": 0
193
158
  }
194
159
  ```
195
160
 
@@ -46,9 +46,10 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
46
46
 
47
47
  ```json
48
48
  {
49
- "member_id": "MEM-example-001",
50
- "payer_id": "60054",
51
- "payer_name": "Example Health Plan",
49
+ "insurance_package_id": "string",
50
+ "member_id": "string",
51
+ "payer_id": "string",
52
+ "payer_name": "string",
52
53
  "priority": "primary",
53
54
  "relationship": "self"
54
55
  }
@@ -66,9 +67,11 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
66
67
 
67
68
  ```json
68
69
  {
69
- "coverages_created": 1,
70
- "fhir_patient_id": "patient-example-001",
71
- "patient_id": "patient-example-001"
70
+ "athena_insurance_error": "string",
71
+ "athena_insurance_status": "string",
72
+ "coverages_created": 0,
73
+ "fhir_patient_id": "string",
74
+ "patient_id": "string"
72
75
  }
73
76
  ```
74
77
 
@@ -115,9 +118,10 @@ import type { CreateInsuranceRequest } from "@healthcloudai/hc-sdk";
115
118
 
116
119
  ```ts
117
120
  const request = {
118
- "member_id": "MEM-example-001",
119
- "payer_id": "60054",
120
- "payer_name": "Example Health Plan",
121
+ "insurance_package_id": "string",
122
+ "member_id": "string",
123
+ "payer_id": "string",
124
+ "payer_name": "string",
121
125
  "priority": "primary",
122
126
  "relationship": "self"
123
127
  };
@@ -131,7 +135,7 @@ const result = await patient.createInsurance(request);
131
135
  curl -X POST \
132
136
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
133
137
  -H 'Content-Type: application/json' \
134
- -d '{"member_id":"MEM-example-001","payer_id":"60054","payer_name":"Example Health Plan","priority":"primary","relationship":"self"}' \
138
+ -d '{"insurance_package_id":"string","member_id":"string","payer_id":"string","payer_name":"string","priority":"primary","relationship":"self"}' \
135
139
  'https://dev-api-patient.health.cloud/patients/insurance'
136
140
  ```
137
141