Get Note

GET

/api/notes/:id

GET

/api/notes/:id

1 curl https://app.usebridge.com/api/notes/id \
2      -H "X-API-Key: <apiKey>"

Try it

200Retrieved

1 {
2   "id": "id",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "serviceId": "serviceId",
5   "data": {
6     "PATIENT_NAME": "PATIENT_NAME",
7     "ICD10": [
8       "ICD10",
9       "ICD10"
10     ],
11     "SUBJECTIVE": "SUBJECTIVE",
12     "OBJECTIVE": "OBJECTIVE",
13     "ASSESSMENT": "ASSESSMENT",
14     "TEXT": "TEXT",
15     "PLAN": "PLAN",
16     "DIAGNOSIS": "DIAGNOSIS",
17     "INTERVENTION": "INTERVENTION",
18     "MONITORING_AND_EVALUATION": "MONITORING_AND_EVALUATION",
19     "TELEHEALTH_DISCLAIMER": "TELEHEALTH_DISCLAIMER",
20     "TOTAL_TIME_SPENT": "TOTAL_TIME_SPENT",
21     "TIME_SPENT_MINUTES": 1,
22     "THERAPY_TIME_SPENT_MINUTES": 1,
23     "PRESCRIPTION_WRITTEN": true,
24     "MEDICATION_MANAGED": true,
25     "DATE_RANGE_START": "DATE_RANGE_START",
26     "DATE_RANGE_END": "DATE_RANGE_END",
27     "MONITORING_DATA": [
28       {
29         "date": "date",
30         "values": [
31           "values",
32           "values"
33         ]
34       },
35       {
36         "date": "date",
37         "values": [
38           "values",
39           "values"
40         ]
41       }
42     ]
43   },
44   "signature": {
45     "timestamp": "2024-01-15T09:30:00Z",
46     "provider": {
47       "id": "id",
48       "name": "name",
49       "type": "MD",
50       "providerEligibilityEnabled": true,
51       "serviceEligibilityEnabled": true,
52       "npi": "npi",
53       "externalId": "externalId"
54     }
55   },
56   "addenda": [
57     {
58       "id": "id",
59       "createdAt": "2024-01-15T09:30:00Z",
60       "data": {
61         "PATIENT_NAME": "PATIENT_NAME",
62         "ICD10": [
63           "ICD10",
64           "ICD10"
65         ],
66         "SUBJECTIVE": "SUBJECTIVE",
67         "OBJECTIVE": "OBJECTIVE",
68         "ASSESSMENT": "ASSESSMENT",
69         "TEXT": "TEXT",
70         "PLAN": "PLAN",
71         "DIAGNOSIS": "DIAGNOSIS",
72         "INTERVENTION": "INTERVENTION",
73         "MONITORING_AND_EVALUATION": "MONITORING_AND_EVALUATION",
74         "TELEHEALTH_DISCLAIMER": "TELEHEALTH_DISCLAIMER",
75         "TOTAL_TIME_SPENT": "TOTAL_TIME_SPENT",
76         "TIME_SPENT_MINUTES": 1,
77         "THERAPY_TIME_SPENT_MINUTES": 1,
78         "PRESCRIPTION_WRITTEN": true,
79         "MEDICATION_MANAGED": true,
80         "DATE_RANGE_START": "DATE_RANGE_START",
81         "DATE_RANGE_END": "DATE_RANGE_END",
82         "MONITORING_DATA": [
83           {
84             "date": "date",
85             "values": [
86               "values",
87               "values"
88             ]
89           },
90           {
91             "date": "date",
92             "values": [
93               "values",
94               "values"
95             ]
96           }
97         ]
98       },
99       "signature": {
100         "timestamp": "2024-01-15T09:30:00Z",
101         "provider": {
102           "id": "id",
103           "name": "name",
104           "type": "MD",
105           "providerEligibilityEnabled": true,
106           "serviceEligibilityEnabled": true,
107           "npi": "npi",
108           "externalId": "externalId"
109         }
110       },
111       "externalId": "externalId"
112     },
113     {
114       "id": "id",
115       "createdAt": "2024-01-15T09:30:00Z",
116       "data": {
117         "PATIENT_NAME": "PATIENT_NAME",
118         "ICD10": [
119           "ICD10",
120           "ICD10"
121         ],
122         "SUBJECTIVE": "SUBJECTIVE",
123         "OBJECTIVE": "OBJECTIVE",
124         "ASSESSMENT": "ASSESSMENT",
125         "TEXT": "TEXT",
126         "PLAN": "PLAN",
127         "DIAGNOSIS": "DIAGNOSIS",
128         "INTERVENTION": "INTERVENTION",
129         "MONITORING_AND_EVALUATION": "MONITORING_AND_EVALUATION",
130         "TELEHEALTH_DISCLAIMER": "TELEHEALTH_DISCLAIMER",
131         "TOTAL_TIME_SPENT": "TOTAL_TIME_SPENT",
132         "TIME_SPENT_MINUTES": 1,
133         "THERAPY_TIME_SPENT_MINUTES": 1,
134         "PRESCRIPTION_WRITTEN": true,
135         "MEDICATION_MANAGED": true,
136         "DATE_RANGE_START": "DATE_RANGE_START",
137         "DATE_RANGE_END": "DATE_RANGE_END",
138         "MONITORING_DATA": [
139           {
140             "date": "date",
141             "values": [
142               "values",
143               "values"
144             ]
145           },
146           {
147             "date": "date",
148             "values": [
149               "values",
150               "values"
151             ]
152           }
153         ]
154       },
155       "signature": {
156         "timestamp": "2024-01-15T09:30:00Z",
157         "provider": {
158           "id": "id",
159           "name": "name",
160           "type": "MD",
161           "providerEligibilityEnabled": true,
162           "serviceEligibilityEnabled": true,
163           "npi": "npi",
164           "externalId": "externalId"
165         }
166       },
167       "externalId": "externalId"
168     }
169   ],
170   "externalId": "externalId"
171 }

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

serviceIdstring

dataobject

signatureobject

addendalist of objects

externalIdstring or null

Path parameters

Headers

Response