Update

Beta

PUT

/api/health-care-code-informations/v1/:encounter_id

PUT

/api/health-care-code-informations/v1/:encounter_id

1 curl -X PUT https://api.joincandidhealth.com/api/health-care-code-informations/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "patient_reasons_for_visit": [
3     {
4       "patient_reason_for_visit": "patient_reason_for_visit",
5       "patient_reason_for_visit_code_qualifier": "PR",
6       "code_list_qualifier": "0",
7       "date_time_period": "date_time_period",
8       "date_time_period_format_qualifier": "CC",
9       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
11       "industry_code_1": "industry_code_1",
12       "industry_code_2": "industry_code_2",
13       "industry_code_3": "industry_code_3",
14       "industry_code_4": "industry_code_4",
15       "monetary_amount": "monetary_amount",
16       "quantity": "quantity"
17     },
18     {
19       "patient_reason_for_visit": "patient_reason_for_visit",
20       "patient_reason_for_visit_code_qualifier": "PR",
21       "code_list_qualifier": "0",
22       "date_time_period": "date_time_period",
23       "date_time_period_format_qualifier": "CC",
24       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
25       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26       "industry_code_1": "industry_code_1",
27       "industry_code_2": "industry_code_2",
28       "industry_code_3": "industry_code_3",
29       "industry_code_4": "industry_code_4",
30       "monetary_amount": "monetary_amount",
31       "quantity": "quantity"
32     }
33   ],
34   "external_causes_of_injury": [
35     {
36       "external_cause_of_injury_code": "external_cause_of_injury_code",
37       "external_cause_of_injury_code_qualifier": "BN",
38       "code_list_qualifier": "0",
39       "date_time_period": "date_time_period",
40       "date_time_period_format_qualifier": "CC",
41       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
42       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
43       "industry_code_1": "industry_code_1",
44       "industry_code_2": "industry_code_2",
45       "industry_code_3": "industry_code_3",
46       "industry_code_4": "industry_code_4",
47       "monetary_amount": "monetary_amount",
48       "present_on_admission_indicator": "Y",
49       "quantity": "quantity"
50     },
51     {
52       "external_cause_of_injury_code": "external_cause_of_injury_code",
53       "external_cause_of_injury_code_qualifier": "BN",
54       "code_list_qualifier": "0",
55       "date_time_period": "date_time_period",
56       "date_time_period_format_qualifier": "CC",
57       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
58       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
59       "industry_code_1": "industry_code_1",
60       "industry_code_2": "industry_code_2",
61       "industry_code_3": "industry_code_3",
62       "industry_code_4": "industry_code_4",
63       "monetary_amount": "monetary_amount",
64       "present_on_admission_indicator": "Y",
65       "quantity": "quantity"
66     }
67   ],
68   "other_diagnosis_information": [
69     {
70       "other_diagnosis": "other_diagnosis",
71       "other_diagnosis_code_qualifier": "BF",
72       "code_list_qualifier": "0",
73       "date_time_period": "date_time_period",
74       "date_time_period_format_qualifier": "CC",
75       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
76       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
77       "industry_code_1": "industry_code_1",
78       "industry_code_2": "industry_code_2",
79       "industry_code_3": "industry_code_3",
80       "industry_code_4": "industry_code_4",
81       "monetary_amount": "monetary_amount",
82       "present_on_admission_indicator": "Y",
83       "quantity": "quantity"
84     },
85     {
86       "other_diagnosis": "other_diagnosis",
87       "other_diagnosis_code_qualifier": "BF",
88       "code_list_qualifier": "0",
89       "date_time_period": "date_time_period",
90       "date_time_period_format_qualifier": "CC",
91       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
92       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
93       "industry_code_1": "industry_code_1",
94       "industry_code_2": "industry_code_2",
95       "industry_code_3": "industry_code_3",
96       "industry_code_4": "industry_code_4",
97       "monetary_amount": "monetary_amount",
98       "present_on_admission_indicator": "Y",
99       "quantity": "quantity"
100     }
101   ],
102   "other_procedure_information": [
103     {
104       "other_procedure_code": "other_procedure_code",
105       "other_procedure_code_qualifier": "BBQ",
106       "other_procedure_date": "2024-01-15T09:30:00Z",
107       "code_list_qualifier": "0",
108       "date_time_period": "date_time_period",
109       "date_time_period_format_qualifier": "CC",
110       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
111       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
112       "industry_code_1": "industry_code_1",
113       "industry_code_2": "industry_code_2",
114       "industry_code_3": "industry_code_3",
115       "industry_code_4": "industry_code_4",
116       "monetary_amount": "monetary_amount",
117       "quantity": "quantity"
118     },
119     {
120       "other_procedure_code": "other_procedure_code",
121       "other_procedure_code_qualifier": "BBQ",
122       "other_procedure_date": "2024-01-15T09:30:00Z",
123       "code_list_qualifier": "0",
124       "date_time_period": "date_time_period",
125       "date_time_period_format_qualifier": "CC",
126       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
127       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
128       "industry_code_1": "industry_code_1",
129       "industry_code_2": "industry_code_2",
130       "industry_code_3": "industry_code_3",
131       "industry_code_4": "industry_code_4",
132       "monetary_amount": "monetary_amount",
133       "quantity": "quantity"
134     }
135   ],
136   "occurrence_span_information": [
137     {
138       "occurrence_span_code": "70",
139       "occurrence_span_code_qualifier": "BI",
140       "occurrence_span_date": {
141         "start": "2024-01-15T09:30:00Z",
142         "end": "2024-01-15T09:30:00Z"
143       },
144       "code_list_qualifier": "0",
145       "date_time_period": "date_time_period",
146       "date_time_period_format_qualifier": "CC",
147       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
148       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
149       "industry_code_1": "industry_code_1",
150       "industry_code_2": "industry_code_2",
151       "industry_code_3": "industry_code_3",
152       "industry_code_4": "industry_code_4",
153       "monetary_amount": "monetary_amount",
154       "quantity": "quantity"
155     },
156     {
157       "occurrence_span_code": "70",
158       "occurrence_span_code_qualifier": "BI",
159       "occurrence_span_date": {
160         "start": "2024-01-15T09:30:00Z",
161         "end": "2024-01-15T09:30:00Z"
162       },
163       "code_list_qualifier": "0",
164       "date_time_period": "date_time_period",
165       "date_time_period_format_qualifier": "CC",
166       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
167       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
168       "industry_code_1": "industry_code_1",
169       "industry_code_2": "industry_code_2",
170       "industry_code_3": "industry_code_3",
171       "industry_code_4": "industry_code_4",
172       "monetary_amount": "monetary_amount",
173       "quantity": "quantity"
174     }
175   ],
176   "occurrence_information": [
177     {
178       "occurrence_code": "01",
179       "occurrence_code_qualifier": "BH",
180       "occurrence_date": "2024-01-15T09:30:00Z",
181       "code_list_qualifier": "0",
182       "date_time_period": "date_time_period",
183       "date_time_period_format_qualifier": "CC",
184       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
185       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
186       "industry_code_1": "industry_code_1",
187       "industry_code_2": "industry_code_2",
188       "industry_code_3": "industry_code_3",
189       "industry_code_4": "industry_code_4",
190       "monetary_amount": "monetary_amount",
191       "quantity": "quantity"
192     },
193     {
194       "occurrence_code": "01",
195       "occurrence_code_qualifier": "BH",
196       "occurrence_date": "2024-01-15T09:30:00Z",
197       "code_list_qualifier": "0",
198       "date_time_period": "date_time_period",
199       "date_time_period_format_qualifier": "CC",
200       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
201       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
202       "industry_code_1": "industry_code_1",
203       "industry_code_2": "industry_code_2",
204       "industry_code_3": "industry_code_3",
205       "industry_code_4": "industry_code_4",
206       "monetary_amount": "monetary_amount",
207       "quantity": "quantity"
208     }
209   ],
210   "treatment_code_information": [
211     {
212       "treatment_code": "treatment_code",
213       "treatment_code_qualifier": "TC",
214       "code_list_qualifier": "0",
215       "date_time_period": "date_time_period",
216       "date_time_period_format_qualifier": "CC",
217       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
218       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
219       "industry_code_1": "industry_code_1",
220       "industry_code_2": "industry_code_2",
221       "industry_code_3": "industry_code_3",
222       "industry_code_4": "industry_code_4",
223       "monetary_amount": "monetary_amount",
224       "quantity": "quantity"
225     },
226     {
227       "treatment_code": "treatment_code",
228       "treatment_code_qualifier": "TC",
229       "code_list_qualifier": "0",
230       "date_time_period": "date_time_period",
231       "date_time_period_format_qualifier": "CC",
232       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
233       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
234       "industry_code_1": "industry_code_1",
235       "industry_code_2": "industry_code_2",
236       "industry_code_3": "industry_code_3",
237       "industry_code_4": "industry_code_4",
238       "monetary_amount": "monetary_amount",
239       "quantity": "quantity"
240     }
241   ],
242   "value_information": [
243     {
244       "value_code": "01",
245       "value_code_amount": "value_code_amount",
246       "value_code_qualifier": "BE",
247       "code_list_qualifier": "0",
248       "date_time_period": "date_time_period",
249       "date_time_period_format_qualifier": "CC",
250       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
251       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
252       "industry_code_1": "industry_code_1",
253       "industry_code_2": "industry_code_2",
254       "industry_code_3": "industry_code_3",
255       "industry_code_4": "industry_code_4",
256       "monetary_amount": "monetary_amount",
257       "quantity": "quantity"
258     },
259     {
260       "value_code": "01",
261       "value_code_amount": "value_code_amount",
262       "value_code_qualifier": "BE",
263       "code_list_qualifier": "0",
264       "date_time_period": "date_time_period",
265       "date_time_period_format_qualifier": "CC",
266       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
267       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
268       "industry_code_1": "industry_code_1",
269       "industry_code_2": "industry_code_2",
270       "industry_code_3": "industry_code_3",
271       "industry_code_4": "industry_code_4",
272       "monetary_amount": "monetary_amount",
273       "quantity": "quantity"
274     }
275   ],
276   "condition_information": [
277     {
278       "condition_code": "01",
279       "condition_code_qualifier": "BG",
280       "code_list_qualifier": "0",
281       "date_time_period": "date_time_period",
282       "date_time_period_format_qualifier": "CC",
283       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
284       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
285       "industry_code_1": "industry_code_1",
286       "industry_code_2": "industry_code_2",
287       "industry_code_3": "industry_code_3",
288       "industry_code_4": "industry_code_4",
289       "monetary_amount": "monetary_amount",
290       "quantity": "quantity"
291     },
292     {
293       "condition_code": "01",
294       "condition_code_qualifier": "BG",
295       "code_list_qualifier": "0",
296       "date_time_period": "date_time_period",
297       "date_time_period_format_qualifier": "CC",
298       "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
299       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
300       "industry_code_1": "industry_code_1",
301       "industry_code_2": "industry_code_2",
302       "industry_code_3": "industry_code_3",
303       "industry_code_4": "industry_code_4",
304       "monetary_amount": "monetary_amount",
305       "quantity": "quantity"
306     }
307   ],
308   "principal_diagnosis": {
309     "primary_diagnosis_code": "primary_diagnosis_code",
310     "principal_diagnosis_code_qualifier": "BK",
311     "code_list_qualifier": "0",
312     "date_time_period": "date_time_period",
313     "date_time_period_format_qualifier": "CC",
314     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
315     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
316     "industry_code_1": "industry_code_1",
317     "industry_code_2": "industry_code_2",
318     "industry_code_3": "industry_code_3",
319     "industry_code_4": "industry_code_4",
320     "monetary_amount": "monetary_amount",
321     "present_on_admission_indicator": "Y",
322     "quantity": "quantity"
323   },
324   "admitting_diagnosis": {
325     "admitting_diagnosis_code": "admitting_diagnosis_code",
326     "admitting_diagnosis_code_qualifier": "BJ",
327     "code_list_qualifier": "0",
328     "date_time_period": "date_time_period",
329     "date_time_period_format_qualifier": "CC",
330     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
331     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
332     "industry_code_1": "industry_code_1",
333     "industry_code_2": "industry_code_2",
334     "industry_code_3": "industry_code_3",
335     "industry_code_4": "industry_code_4",
336     "monetary_amount": "monetary_amount",
337     "quantity": "quantity"
338   },
339   "diagnosis_related_groups": {
340     "diagnosis_related_group_code": "diagnosis_related_group_code",
341     "diagnosis_related_group_code_qualifier": "DR",
342     "code_list_qualifier": "0",
343     "date_time_period": "date_time_period",
344     "date_time_period_format_qualifier": "CC",
345     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
346     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
347     "industry_code_1": "industry_code_1",
348     "industry_code_2": "industry_code_2",
349     "industry_code_3": "industry_code_3",
350     "industry_code_4": "industry_code_4",
351     "monetary_amount": "monetary_amount",
352     "quantity": "quantity"
353   },
354   "principal_procedure": {
355     "principal_procedure_code": "principal_procedure_code",
356     "principal_procedure_code_qualifier": "BBR",
357     "procedure_date": "2024-01-15T09:30:00Z",
358     "code_list_qualifier": "0",
359     "date_time_period": "date_time_period",
360     "date_time_period_format_qualifier": "CC",
361     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
362     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
363     "industry_code_1": "industry_code_1",
364     "industry_code_2": "industry_code_2",
365     "industry_code_3": "industry_code_3",
366     "industry_code_4": "industry_code_4",
367     "monetary_amount": "monetary_amount",
368     "quantity": "quantity"
369   }
370 }

Path parameters

encounter_idUUIDRequired

Request

This endpoint expects an object.

principal_diagnosisobjectOptional

admitting_diagnosisobjectOptional

patient_reasons_for_visitlist of objectsOptional

external_causes_of_injurylist of objectsOptional

diagnosis_related_groupsobjectOptional

other_diagnosis_informationlist of objectsOptional

principal_procedureobjectOptional

other_procedure_informationlist of objectsOptional

occurrence_span_informationlist of objectsOptional

occurrence_informationlist of objectsOptional

treatment_code_informationlist of objectsOptional

value_informationlist of objectsOptional

condition_informationlist of objectsOptional

Response

This endpoint returns an object.

patient_reasons_for_visitlist of objects

external_causes_of_injurylist of objects

other_diagnosis_informationlist of objects

other_procedure_informationlist of objects

occurrence_span_informationlist of objects

occurrence_informationlist of objects

treatment_code_informationlist of objects

value_informationlist of objects

condition_informationlist of objects

principal_diagnosisobject or null

This corresponds to BK or ABK code qualifier values.

admitting_diagnosisobject or null

This corresponds to BJ or ABJ code qualifier values.

diagnosis_related_groupsobject or null

This corresponds to DR code qualifier values.

principal_procedureobject or null

This correspond to BBR, BR, and CAH code qualifier values.

Update

Path parameters

Headers

Request

Response

Errors