@healthcloudai/hc-sdk 3.36.0 → 3.37.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 +118 -4
- package/dist/index.d.cts +613 -5
- package/dist/index.d.ts +613 -5
- package/dist/index.js +118 -4
- package/docs/clients/PatientClient.md +2 -1
- package/docs/docs-manifest.json +10 -3
- package/docs/examples/index.md +2 -1
- package/docs/index.md +2 -1
- package/docs/models/AddInsuranceResponse.md +1 -0
- package/docs/models/Appointment.md +1 -0
- package/docs/models/CheckEligibilityResponse.md +1 -0
- package/docs/models/CheckInsuranceNetworkRequest.md +21 -0
- package/docs/models/CheckInsuranceNetworkResponse.md +33 -0
- package/docs/models/CoverageChoice.md +20 -0
- package/docs/models/MedicalConcept.md +29 -4
- package/docs/models/MedicalConceptSearchRequest.md +6 -4
- package/docs/models/NetworkEvidence.md +21 -0
- package/docs/models/NetworkPlan.md +21 -0
- package/docs/models/ProducerReceipt.md +20 -0
- package/docs/models/SearchMedicalConceptsRequest.md +3 -1
- package/docs/models/index.md +6 -0
- package/docs/operations/appointments.book.md +6 -0
- package/docs/operations/appointments.cancel.md +6 -0
- package/docs/operations/appointments.listPatientAppointments.md +6 -0
- package/docs/operations/appointments.reschedule.md +6 -0
- package/docs/operations/graph.getMedicalConcept.md +1 -1
- package/docs/operations/graph.getMedicalConceptRelationships.md +2 -2
- package/docs/operations/graph.getMedicalConceptVocabularies.md +1 -1
- package/docs/operations/graph.listMedicalConceptsGet.md +56 -16
- package/docs/operations/graph.searchMedicalConcepts.md +73 -27
- package/docs/operations/graph.searchMedicalConceptsGet.md +73 -27
- package/docs/operations/patient.addInsurance.md +11 -5
- package/docs/operations/patient.addPatientIntake.md +3 -3
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +11 -5
- package/docs/operations/patient.checkPatientInsuranceNetwork.md +212 -0
- package/docs/operations/patient.setPreferredPharmacy.md +9 -0
- package/docs/operations/patient.updateAddress.md +9 -0
- package/docs/operations/patient.updateDemographics.md +9 -0
- package/docs/operations/patient.updatePatientAttributes.md +9 -0
- package/docs/operations/patient.updatePatientFlags.md +9 -0
- package/docs/operations/patient.updatePhone.md +9 -0
- package/docs/operations/patient.updateRace.md +9 -0
- package/package.json +1 -1
|
@@ -75,6 +75,12 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
|
|
|
75
75
|
"openloop_appointment_id": "string",
|
|
76
76
|
"patient_id": "string",
|
|
77
77
|
"provider_id": "string",
|
|
78
|
+
"reminders": {
|
|
79
|
+
"booking_id": "00000000-0000-0000-0000-000000000000",
|
|
80
|
+
"event_id": "00000000-0000-0000-0000-000000000000",
|
|
81
|
+
"reason": "committed",
|
|
82
|
+
"state": "queued"
|
|
83
|
+
},
|
|
78
84
|
"slot_id": "string",
|
|
79
85
|
"slot_ids": [
|
|
80
86
|
"string"
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `graph.getMedicalConcept`
|
|
4
4
|
|
|
5
|
-
Get one medical concept by id, plus its immediate relationships. concept_id is '{VOCAB}:{code}' (e.g. 'SNOMED:195967001'); legacy SNOMED nodes may still resolve by sctid alone.
|
|
5
|
+
Get one medical concept by id, plus its immediate relationships. concept_id is '{VOCAB}:{code}' (e.g. 'SNOMED:195967001', 'ICD10CM:E11.9', 'ICD10PCS:0DTJ4ZZ', 'HCPCS:J1100'), plain or URL-encoded; legacy SNOMED nodes may still resolve by sctid alone. A bare code can name concepts in more than one vocabulary (ICD-10-CM category B30 and ICD-10-PCS table B30), and then one of them is returned: use the id.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `graph.getMedicalConceptRelationships`
|
|
4
4
|
|
|
5
|
-
Return the flat 1-hop edge table for a medical concept — its direct typed relationships to other concepts, filterable by direction, relationship type, and target vocabulary.
|
|
5
|
+
Return the flat 1-hop edge table for a medical concept — its direct typed relationships to other concepts, filterable by direction, relationship type (any upper-snake-case name, e.g. FINDING_SITE or DIRECT_DEVICE; a malformed one is 400), and target vocabulary.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -39,7 +39,7 @@ None documented.
|
|
|
39
39
|
| `direction` | `string` | No | | outgoing, incoming, both | `"outgoing"` | No | |
|
|
40
40
|
| `limit` | `integer` | No | | | `50` | No | |
|
|
41
41
|
| `offset` | `integer` | No | | | `0` | No | |
|
|
42
|
-
| `target_vocabulary` | `string` | No | | SNOMED, RXNORM, MESH | | No | |
|
|
42
|
+
| `target_vocabulary` | `string` | No | | SNOMED, RXNORM, MESH, ICD10CM, ICD10PCS, HCPCS | | No | |
|
|
43
43
|
| `type` | `string` | No | | | | No | |
|
|
44
44
|
|
|
45
45
|
## Body parameters
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `graph.getMedicalConceptVocabularies`
|
|
4
4
|
|
|
5
|
-
Return concept counts grouped by vocabulary (SNOMED, RXNORM, MESH). Neo4j only.
|
|
5
|
+
Return concept counts grouped by vocabulary (SNOMED, RXNORM, MESH, ICD10CM, ICD10PCS, HCPCS: the ones the graph holds). Neo4j only.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -43,7 +43,7 @@ None.
|
|
|
43
43
|
| `sctid` | `string` | No | | | | No | |
|
|
44
44
|
| `semantic_tag` | `string` | No | | | | No | |
|
|
45
45
|
| `tty` | `string` | No | | | | No | |
|
|
46
|
-
| `vocabulary` | `string` | No | | SNOMED, RXNORM, MESH | | No | |
|
|
46
|
+
| `vocabulary` | `string` | No | | SNOMED, RXNORM, MESH, ICD10CM, ICD10PCS, HCPCS | | No | |
|
|
47
47
|
|
|
48
48
|
## Body parameters
|
|
49
49
|
|
|
@@ -68,22 +68,62 @@ None declared in canonical OpenAPI.
|
|
|
68
68
|
```json
|
|
69
69
|
[
|
|
70
70
|
{
|
|
71
|
+
"action_code": "string",
|
|
72
|
+
"action_effective_date": "string",
|
|
71
73
|
"active": true,
|
|
72
|
-
"
|
|
73
|
-
"
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
"
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
"
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
"
|
|
85
|
-
|
|
86
|
-
|
|
74
|
+
"added_date": "string",
|
|
75
|
+
"axes": [
|
|
76
|
+
"string"
|
|
77
|
+
],
|
|
78
|
+
"betos": "string",
|
|
79
|
+
"billable": true,
|
|
80
|
+
"body_system": "string",
|
|
81
|
+
"chapter": "string",
|
|
82
|
+
"code": "string",
|
|
83
|
+
"code_also": [
|
|
84
|
+
"string"
|
|
85
|
+
],
|
|
86
|
+
"code_first": [
|
|
87
|
+
"string"
|
|
88
|
+
],
|
|
89
|
+
"coverage": "string",
|
|
90
|
+
"coverage_code": "string",
|
|
91
|
+
"definition": "string",
|
|
92
|
+
"definition_status": "string",
|
|
93
|
+
"effective_time": "string",
|
|
94
|
+
"excludes1": [
|
|
95
|
+
"string"
|
|
96
|
+
],
|
|
97
|
+
"excludes2": [
|
|
98
|
+
"string"
|
|
99
|
+
],
|
|
100
|
+
"fsn": "string",
|
|
101
|
+
"id": "string",
|
|
102
|
+
"includes": [
|
|
103
|
+
"string"
|
|
104
|
+
],
|
|
105
|
+
"inclusion_terms": [
|
|
106
|
+
"string"
|
|
107
|
+
],
|
|
108
|
+
"level": "string",
|
|
109
|
+
"module_id": "string",
|
|
110
|
+
"notes": [
|
|
111
|
+
"string"
|
|
112
|
+
],
|
|
113
|
+
"operation": "string",
|
|
114
|
+
"preferred_term": "string",
|
|
115
|
+
"release": "string",
|
|
116
|
+
"score": 0,
|
|
117
|
+
"sctid": "string",
|
|
118
|
+
"section": "string",
|
|
119
|
+
"semantic_tag": "string",
|
|
120
|
+
"short_title": "string",
|
|
121
|
+
"termination_date": "string",
|
|
122
|
+
"tty": "string",
|
|
123
|
+
"use_additional_code": [
|
|
124
|
+
"string"
|
|
125
|
+
],
|
|
126
|
+
"vocabulary": "string"
|
|
87
127
|
}
|
|
88
128
|
]
|
|
89
129
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `graph.searchMedicalConcepts`
|
|
4
4
|
|
|
5
|
-
Search the unified Medical Concepts
|
|
5
|
+
Search the unified Medical Concepts (SNOMED CT, RxNorm, MeSH, ICD-10-CM, ICD-10-PCS, HCPCS Level II) by free-text phrase and vocabulary-aware facets, including billable and level for the code sets. When rag=true in the request body, runs retrieval-augmented generation instead of returning the raw result set. Prefer graph.searchMedicalConceptsGet for query-string-based search — this POST form is kept for legacy callers.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -47,7 +47,9 @@ Request model: [`SearchMedicalConceptsRequest`](../models/SearchMedicalConceptsR
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
49
|
"active": true,
|
|
50
|
+
"billable": true,
|
|
50
51
|
"code": "string",
|
|
52
|
+
"level": "string",
|
|
51
53
|
"limit": 20,
|
|
52
54
|
"module_id": "string",
|
|
53
55
|
"offset": 0,
|
|
@@ -75,39 +77,81 @@ Request model: [`SearchMedicalConceptsRequest`](../models/SearchMedicalConceptsR
|
|
|
75
77
|
{
|
|
76
78
|
"concepts": [
|
|
77
79
|
{
|
|
80
|
+
"action_code": "string",
|
|
81
|
+
"action_effective_date": "string",
|
|
78
82
|
"active": true,
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
"
|
|
84
|
-
"
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
"
|
|
92
|
-
|
|
93
|
-
|
|
83
|
+
"added_date": "string",
|
|
84
|
+
"axes": [
|
|
85
|
+
"string"
|
|
86
|
+
],
|
|
87
|
+
"betos": "string",
|
|
88
|
+
"billable": true,
|
|
89
|
+
"body_system": "string",
|
|
90
|
+
"chapter": "string",
|
|
91
|
+
"code": "string",
|
|
92
|
+
"code_also": [
|
|
93
|
+
"string"
|
|
94
|
+
],
|
|
95
|
+
"code_first": [
|
|
96
|
+
"string"
|
|
97
|
+
],
|
|
98
|
+
"coverage": "string",
|
|
99
|
+
"coverage_code": "string",
|
|
100
|
+
"definition": "string",
|
|
101
|
+
"definition_status": "string",
|
|
102
|
+
"effective_time": "string",
|
|
103
|
+
"excludes1": [
|
|
104
|
+
"string"
|
|
105
|
+
],
|
|
106
|
+
"excludes2": [
|
|
107
|
+
"string"
|
|
108
|
+
],
|
|
109
|
+
"fsn": "string",
|
|
110
|
+
"id": "string",
|
|
111
|
+
"includes": [
|
|
112
|
+
"string"
|
|
113
|
+
],
|
|
114
|
+
"inclusion_terms": [
|
|
115
|
+
"string"
|
|
116
|
+
],
|
|
117
|
+
"level": "string",
|
|
118
|
+
"module_id": "string",
|
|
119
|
+
"notes": [
|
|
120
|
+
"string"
|
|
121
|
+
],
|
|
122
|
+
"operation": "string",
|
|
123
|
+
"preferred_term": "string",
|
|
124
|
+
"release": "string",
|
|
125
|
+
"score": 0,
|
|
126
|
+
"sctid": "string",
|
|
127
|
+
"section": "string",
|
|
128
|
+
"semantic_tag": "string",
|
|
129
|
+
"short_title": "string",
|
|
130
|
+
"termination_date": "string",
|
|
131
|
+
"tty": "string",
|
|
132
|
+
"use_additional_code": [
|
|
133
|
+
"string"
|
|
134
|
+
],
|
|
135
|
+
"vocabulary": "string"
|
|
94
136
|
}
|
|
95
137
|
],
|
|
96
138
|
"request": {
|
|
97
139
|
"active": true,
|
|
98
|
-
"
|
|
99
|
-
"
|
|
100
|
-
"
|
|
140
|
+
"billable": true,
|
|
141
|
+
"code": "string",
|
|
142
|
+
"level": "string",
|
|
143
|
+
"limit": 20,
|
|
144
|
+
"module_id": "string",
|
|
101
145
|
"offset": 0,
|
|
102
|
-
"phrase": "
|
|
146
|
+
"phrase": "string",
|
|
103
147
|
"rag": false,
|
|
104
|
-
"sctid": "
|
|
105
|
-
"semantic_tag": "
|
|
106
|
-
"top_category":
|
|
107
|
-
"tty":
|
|
108
|
-
"vocabulary": "
|
|
148
|
+
"sctid": "string",
|
|
149
|
+
"semantic_tag": "string",
|
|
150
|
+
"top_category": "string",
|
|
151
|
+
"tty": "string",
|
|
152
|
+
"vocabulary": "string"
|
|
109
153
|
},
|
|
110
|
-
"total":
|
|
154
|
+
"total": 0
|
|
111
155
|
}
|
|
112
156
|
```
|
|
113
157
|
|
|
@@ -155,7 +199,9 @@ import type { MedicalConceptSearchRequest } from "@healthcloudai/hc-sdk";
|
|
|
155
199
|
```ts
|
|
156
200
|
const request = {
|
|
157
201
|
"active": true,
|
|
202
|
+
"billable": true,
|
|
158
203
|
"code": "string",
|
|
204
|
+
"level": "string",
|
|
159
205
|
"limit": 20,
|
|
160
206
|
"module_id": "string",
|
|
161
207
|
"offset": 0,
|
|
@@ -177,7 +223,7 @@ const result = await graph.searchMedicalConcepts(request);
|
|
|
177
223
|
curl -X POST \
|
|
178
224
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
179
225
|
-H 'Content-Type: application/json' \
|
|
180
|
-
-d '{"active":true,"code":"string","limit":20,"module_id":"string","offset":0,"phrase":"string","rag":false,"sctid":"string","semantic_tag":"string","top_category":"string","tty":"string","vocabulary":"SNOMED"}' \
|
|
226
|
+
-d '{"active":true,"billable":true,"code":"string","level":"string","limit":20,"module_id":"string","offset":0,"phrase":"string","rag":false,"sctid":"string","semantic_tag":"string","top_category":"string","tty":"string","vocabulary":"SNOMED"}' \
|
|
181
227
|
'https://dev-api-graph.health.cloud/graph/medical-concepts/search'
|
|
182
228
|
```
|
|
183
229
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `graph.searchMedicalConceptsGet`
|
|
4
4
|
|
|
5
|
-
Faceted search over the unified Medical Concepts
|
|
5
|
+
Faceted search over the unified Medical Concepts (SNOMED CT, RxNorm, MeSH, ICD-10-CM, ICD-10-PCS, HCPCS Level II) via query-string parameters; billable and level filter the code sets (billable=true: ICD-10 codes valid on a claim). Backed by Algolia with a Neo4j fallback; where GraphNeo4jSearch lists medical_concepts (DEV), q searches the Neo4j full-text index over every term and synonym instead, exact and leading matches first. The ICD-10 and HCPCS concepts are in the DEV KB graph only; elsewhere those vocabularies answer an empty result.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -35,7 +35,9 @@ None.
|
|
|
35
35
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
36
|
|---|---|---:|---|---|---|---:|---|
|
|
37
37
|
| `active` | `boolean` | No | | | | No | |
|
|
38
|
+
| `billable` | `boolean` | No | | | | No | |
|
|
38
39
|
| `code` | `string` | No | | | | No | |
|
|
40
|
+
| `level` | `string` | No | | | | No | |
|
|
39
41
|
| `limit` | `integer` | No | | | `20` | No | |
|
|
40
42
|
| `module_id` | `string` | No | | | | No | |
|
|
41
43
|
| `offset` | `integer` | No | | | `0` | No | |
|
|
@@ -44,7 +46,7 @@ None.
|
|
|
44
46
|
| `semantic_tag` | `string` | No | | | | No | |
|
|
45
47
|
| `top_category` | `string` | No | | | | No | |
|
|
46
48
|
| `tty` | `string` | No | | | | No | |
|
|
47
|
-
| `vocabulary` | `string` | No | | SNOMED, RXNORM, MESH | | No | |
|
|
49
|
+
| `vocabulary` | `string` | No | | SNOMED, RXNORM, MESH, ICD10CM, ICD10PCS, HCPCS | | No | |
|
|
48
50
|
|
|
49
51
|
## Body parameters
|
|
50
52
|
|
|
@@ -70,39 +72,81 @@ None declared in canonical OpenAPI.
|
|
|
70
72
|
{
|
|
71
73
|
"concepts": [
|
|
72
74
|
{
|
|
75
|
+
"action_code": "string",
|
|
76
|
+
"action_effective_date": "string",
|
|
73
77
|
"active": true,
|
|
74
|
-
"
|
|
75
|
-
"
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
"
|
|
82
|
-
"
|
|
83
|
-
"
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
"
|
|
87
|
-
|
|
88
|
-
|
|
78
|
+
"added_date": "string",
|
|
79
|
+
"axes": [
|
|
80
|
+
"string"
|
|
81
|
+
],
|
|
82
|
+
"betos": "string",
|
|
83
|
+
"billable": true,
|
|
84
|
+
"body_system": "string",
|
|
85
|
+
"chapter": "string",
|
|
86
|
+
"code": "string",
|
|
87
|
+
"code_also": [
|
|
88
|
+
"string"
|
|
89
|
+
],
|
|
90
|
+
"code_first": [
|
|
91
|
+
"string"
|
|
92
|
+
],
|
|
93
|
+
"coverage": "string",
|
|
94
|
+
"coverage_code": "string",
|
|
95
|
+
"definition": "string",
|
|
96
|
+
"definition_status": "string",
|
|
97
|
+
"effective_time": "string",
|
|
98
|
+
"excludes1": [
|
|
99
|
+
"string"
|
|
100
|
+
],
|
|
101
|
+
"excludes2": [
|
|
102
|
+
"string"
|
|
103
|
+
],
|
|
104
|
+
"fsn": "string",
|
|
105
|
+
"id": "string",
|
|
106
|
+
"includes": [
|
|
107
|
+
"string"
|
|
108
|
+
],
|
|
109
|
+
"inclusion_terms": [
|
|
110
|
+
"string"
|
|
111
|
+
],
|
|
112
|
+
"level": "string",
|
|
113
|
+
"module_id": "string",
|
|
114
|
+
"notes": [
|
|
115
|
+
"string"
|
|
116
|
+
],
|
|
117
|
+
"operation": "string",
|
|
118
|
+
"preferred_term": "string",
|
|
119
|
+
"release": "string",
|
|
120
|
+
"score": 0,
|
|
121
|
+
"sctid": "string",
|
|
122
|
+
"section": "string",
|
|
123
|
+
"semantic_tag": "string",
|
|
124
|
+
"short_title": "string",
|
|
125
|
+
"termination_date": "string",
|
|
126
|
+
"tty": "string",
|
|
127
|
+
"use_additional_code": [
|
|
128
|
+
"string"
|
|
129
|
+
],
|
|
130
|
+
"vocabulary": "string"
|
|
89
131
|
}
|
|
90
132
|
],
|
|
91
133
|
"request": {
|
|
92
134
|
"active": true,
|
|
93
|
-
"
|
|
135
|
+
"billable": true,
|
|
136
|
+
"code": "string",
|
|
137
|
+
"level": "string",
|
|
94
138
|
"limit": 20,
|
|
95
|
-
"module_id": "
|
|
139
|
+
"module_id": "string",
|
|
96
140
|
"offset": 0,
|
|
97
|
-
"phrase": "
|
|
141
|
+
"phrase": "string",
|
|
98
142
|
"rag": false,
|
|
99
|
-
"sctid": "
|
|
100
|
-
"semantic_tag": "
|
|
101
|
-
"top_category":
|
|
102
|
-
"tty":
|
|
103
|
-
"vocabulary": "
|
|
143
|
+
"sctid": "string",
|
|
144
|
+
"semantic_tag": "string",
|
|
145
|
+
"top_category": "string",
|
|
146
|
+
"tty": "string",
|
|
147
|
+
"vocabulary": "string"
|
|
104
148
|
},
|
|
105
|
-
"total":
|
|
149
|
+
"total": 0
|
|
106
150
|
}
|
|
107
151
|
```
|
|
108
152
|
|
|
@@ -140,7 +184,9 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
140
184
|
```ts
|
|
141
185
|
const query = {
|
|
142
186
|
"active": true,
|
|
187
|
+
"billable": true,
|
|
143
188
|
"code": "<CODE>",
|
|
189
|
+
"level": "<LEVEL>",
|
|
144
190
|
"limit": 20,
|
|
145
191
|
"module_id": "<MODULE_ID>",
|
|
146
192
|
"offset": 0,
|
|
@@ -160,7 +206,7 @@ const result = await graph.searchMedicalConceptsFaceted(query);
|
|
|
160
206
|
```bash
|
|
161
207
|
curl -X GET \
|
|
162
208
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
163
|
-
'https://dev-api-graph.health.cloud/medical-concepts/search?active=true&code=%3CCODE%3E&limit=20&module_id=%3CMODULE_ID%3E&offset=0&q=%3CQ%3E&sctid=%3CSCTID%3E&semantic_tag=%3CSEMANTIC_TAG%3E&top_category=%3CTOP_CATEGORY%3E&tty=%3CTTY%3E&vocabulary=SNOMED'
|
|
209
|
+
'https://dev-api-graph.health.cloud/medical-concepts/search?active=true&billable=true&code=%3CCODE%3E&level=%3CLEVEL%3E&limit=20&module_id=%3CMODULE_ID%3E&offset=0&q=%3CQ%3E&sctid=%3CSCTID%3E&semantic_tag=%3CSEMANTIC_TAG%3E&top_category=%3CTOP_CATEGORY%3E&tty=%3CTTY%3E&vocabulary=SNOMED'
|
|
164
210
|
```
|
|
165
211
|
|
|
166
212
|
## Notes
|
|
@@ -8,7 +8,7 @@ Create a new FHIR Coverage resource for the authenticated patient. Requires a pa
|
|
|
8
8
|
|
|
9
9
|
`createInsurance`
|
|
10
10
|
|
|
11
|
-
Signature: `patient.createInsurance(request)`
|
|
11
|
+
Signature: `patient.createInsurance(request, options)`
|
|
12
12
|
|
|
13
13
|
Return type: `Promise<CreateInsuranceResponse>`
|
|
14
14
|
|
|
@@ -32,7 +32,9 @@ None.
|
|
|
32
32
|
|
|
33
33
|
## Query parameters
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `insurance_context` | `string|null` | No | | | | Yes | Opt in to same-save Coverage IDs; omission preserves the legacy response. |
|
|
36
38
|
|
|
37
39
|
## Body parameters
|
|
38
40
|
|
|
@@ -60,7 +62,7 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
60
62
|
|
|
61
63
|
| Status | Shape | Content type | Description |
|
|
62
64
|
|---|---|---|---|
|
|
63
|
-
| `201` | [`AddInsuranceResponse`](../models/AddInsuranceResponse.md) | application/json | Coverage saved. coverages_created is the number created; patient_id is the patient identifier and fhir_patient_id is its deprecated alias. Only the vendor that ran has non-null athena_* or openloop_* fields. The corresponding *_insurance_status is linked (synchronized), failed (see *_insurance_error), skipped_no_match (no catalogue match), or skipped_not_linked (integration unavailable/misconfigured). Both vendor statuses are null when no vendor link applies; the internal skipped_no_vendor status is not emitted. *_best_match contains the selected plan or null. These secondary failures still return 201; do not automatically resubmit Coverage. When image is supplied, fhir_document_reference_id identifies the saved card or is null if saving it failed. athena_insurance_card_status is linked, failed, skipped_no_insurance_id, or skipped_insurance_not_linked. With no image both card fields are null. Card failures do not undo the saved Coverage. |
|
|
65
|
+
| `201` | [`AddInsuranceResponse`](../models/AddInsuranceResponse.md) | application/json | Coverage saved. Only with insurance_context=coverage-v1, coverage_ids contains IDs from this same save. Without that explicit query the exact legacy response fields are preserved. coverages_created is the number created; patient_id is the patient identifier and fhir_patient_id is its deprecated alias. Only the vendor that ran has non-null athena_* or openloop_* fields. The corresponding *_insurance_status is linked (synchronized), failed (see *_insurance_error), skipped_no_match (no catalogue match), or skipped_not_linked (integration unavailable/misconfigured). Both vendor statuses are null when no vendor link applies; the internal skipped_no_vendor status is not emitted. *_best_match contains the selected plan or null. These secondary failures still return 201; do not automatically resubmit Coverage. When image is supplied, fhir_document_reference_id identifies the saved card or is null if saving it failed. athena_insurance_card_status is linked, failed, skipped_no_insurance_id, or skipped_insurance_not_linked. With no image both card fields are null. Card failures do not undo the saved Coverage. |
|
|
64
66
|
|
|
65
67
|
## Success response examples
|
|
66
68
|
|
|
@@ -166,7 +168,11 @@ const request = {
|
|
|
166
168
|
"state": "string"
|
|
167
169
|
};
|
|
168
170
|
|
|
169
|
-
const
|
|
171
|
+
const options = {
|
|
172
|
+
"insurance_context": "<INSURANCE_CONTEXT>"
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
const result = await patient.createInsurance(request, options);
|
|
170
176
|
```
|
|
171
177
|
|
|
172
178
|
## cURL
|
|
@@ -176,7 +182,7 @@ curl -X POST \
|
|
|
176
182
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
177
183
|
-H 'Content-Type: application/json' \
|
|
178
184
|
-d '{"image":"string","member_id":"string","payer_id":"string","payer_name":"string","priority":"primary","relationship":"self","state":"string"}' \
|
|
179
|
-
'https://dev-api-patient.health.cloud/patients/insurance'
|
|
185
|
+
'https://dev-api-patient.health.cloud/patients/insurance?insurance_context=%3CINSURANCE_CONTEXT%3E'
|
|
180
186
|
```
|
|
181
187
|
|
|
182
188
|
## Notes
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Add one
|
|
1
|
+
# Add one patient intake section
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.addPatientIntake`
|
|
4
4
|
|
|
5
|
-
Adds
|
|
5
|
+
Adds one agent-collected intake section linked to the patient's existing open FHIR encounter. Plain-text reports are retained and read back as a FHIR QuestionnaireResponse before optional Athena processing. Tenants without Athena integration complete after FHIR storage; integrated tenants also require Athena completion. Returns 409 before writes when no valid open encounter exists.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -56,7 +56,7 @@ Request model: [`AddPatientIntakeRequest`](../models/AddPatientIntakeRequest.md)
|
|
|
56
56
|
|
|
57
57
|
| Status | Shape | Content type | Description |
|
|
58
58
|
|---|---|---|---|
|
|
59
|
-
| `200` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | FHIR
|
|
59
|
+
| `200` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | FHIR storage succeeded, with Athena completion when integrated |
|
|
60
60
|
|
|
61
61
|
## Success response examples
|
|
62
62
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.checkPatientInsuranceEligibility`
|
|
4
4
|
|
|
5
|
-
Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token
|
|
5
|
+
Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token. Default response fields remain unchanged for existing closed consumers. Only insurance_context=coverage-v1 opts in to coverage_id from this same check, without another lookup or vendor call. Name/DOB and exactly one active primary self Coverage come from saved records. Spouse/child/other or secondary-only coverage cannot satisfy this check. The requesting provider NPI is resolved server-side for the verified tenant. Only the NPI is sent; Stedi fills in the provider name from NPPES. Missing or invalid provider configuration returns unavailable / missing_configuration without a vendor call. The provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout and no application retries. HTTP 200 is a normalized result, not proof of active coverage: inspect status and reason. No member, provider or raw payer data is returned. Raw Stedi errors and AAA codes are not exposed; an upstream 2xx response with only recognized subscriber identity errors (71, 72, 73, 75 at SUBSCRIBER) becomes unavailable / subscriber_details_mismatch. Review saved profile name/DOB and insurance member/payer details before explicitly checking again; this does not prove inactive coverage. Other payer errors become unavailable / invalid_response, even with stub active benefits. Unexpected network/proxy failures may have no JSON body.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
9
9
|
`checkInsuranceEligibility`
|
|
10
10
|
|
|
11
|
-
Signature: `patient.checkInsuranceEligibility(request)`
|
|
11
|
+
Signature: `patient.checkInsuranceEligibility(request, options)`
|
|
12
12
|
|
|
13
13
|
Return type: `Promise<CheckEligibilityResponse>`
|
|
14
14
|
|
|
@@ -32,7 +32,9 @@ None.
|
|
|
32
32
|
|
|
33
33
|
## Query parameters
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `insurance_context` | `string|null` | No | | | | Yes | Opt in to the exact Coverage ID used by this same check; omission preserves the legacy response. |
|
|
36
38
|
|
|
37
39
|
## Body parameters
|
|
38
40
|
|
|
@@ -259,7 +261,11 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
259
261
|
```ts
|
|
260
262
|
const request = {};
|
|
261
263
|
|
|
262
|
-
const
|
|
264
|
+
const options = {
|
|
265
|
+
"insurance_context": "<INSURANCE_CONTEXT>"
|
|
266
|
+
};
|
|
267
|
+
|
|
268
|
+
const result = await patient.checkInsuranceEligibility(request, options);
|
|
263
269
|
```
|
|
264
270
|
|
|
265
271
|
## cURL
|
|
@@ -269,7 +275,7 @@ curl -X POST \
|
|
|
269
275
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
270
276
|
-H 'Content-Type: application/json' \
|
|
271
277
|
-d '{}' \
|
|
272
|
-
'https://dev-api-patient.health.cloud/insurance/eligibility'
|
|
278
|
+
'https://dev-api-patient.health.cloud/insurance/eligibility?insurance_context=%3CINSURANCE_CONTEXT%3E'
|
|
273
279
|
```
|
|
274
280
|
|
|
275
281
|
## Notes
|