Get Service Note

GET

/api/services/:id/note

GET

/api/services/:id/note

1 import requests
2 
3 url = "https://app.usebridge.com/api/services/id/note"
4 
5 headers = {"X-API-Key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

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     "INITIATING_VISIT_DATE": "INITIATING_VISIT_DATE"
44   },
45   "signature": {
46     "timestamp": "2024-01-15T09:30:00Z",
47     "provider": {
48       "id": "id",
49       "name": "name",
50       "type": "MD",
51       "npi": "npi",
52       "externalId": "externalId",
53       "providerEligibilityEnabled": true,
54       "serviceEligibilityEnabled": true
55     }
56   },
57   "addenda": [
58     {
59       "id": "id",
60       "createdAt": "2024-01-15T09:30:00Z",
61       "data": {
62         "PATIENT_NAME": "PATIENT_NAME",
63         "ICD10": [
64           "ICD10",
65           "ICD10"
66         ],
67         "SUBJECTIVE": "SUBJECTIVE",
68         "OBJECTIVE": "OBJECTIVE",
69         "ASSESSMENT": "ASSESSMENT",
70         "TEXT": "TEXT",
71         "PLAN": "PLAN",
72         "DIAGNOSIS": "DIAGNOSIS",
73         "INTERVENTION": "INTERVENTION",
74         "MONITORING_AND_EVALUATION": "MONITORING_AND_EVALUATION",
75         "TELEHEALTH_DISCLAIMER": "TELEHEALTH_DISCLAIMER",
76         "TOTAL_TIME_SPENT": "TOTAL_TIME_SPENT",
77         "TIME_SPENT_MINUTES": 1,
78         "THERAPY_TIME_SPENT_MINUTES": 1,
79         "PRESCRIPTION_WRITTEN": true,
80         "MEDICATION_MANAGED": true,
81         "DATE_RANGE_START": "DATE_RANGE_START",
82         "DATE_RANGE_END": "DATE_RANGE_END",
83         "MONITORING_DATA": [
84           {
85             "date": "date",
86             "values": [
87               "values",
88               "values"
89             ]
90           },
91           {
92             "date": "date",
93             "values": [
94               "values",
95               "values"
96             ]
97           }
98         ],
99         "INITIATING_VISIT_DATE": "INITIATING_VISIT_DATE"
100       },
101       "signature": {
102         "timestamp": "2024-01-15T09:30:00Z",
103         "provider": {
104           "id": "id",
105           "name": "name",
106           "type": "MD",
107           "npi": "npi",
108           "externalId": "externalId",
109           "providerEligibilityEnabled": true,
110           "serviceEligibilityEnabled": true
111         }
112       },
113       "externalId": "externalId"
114     },
115     {
116       "id": "id",
117       "createdAt": "2024-01-15T09:30:00Z",
118       "data": {
119         "PATIENT_NAME": "PATIENT_NAME",
120         "ICD10": [
121           "ICD10",
122           "ICD10"
123         ],
124         "SUBJECTIVE": "SUBJECTIVE",
125         "OBJECTIVE": "OBJECTIVE",
126         "ASSESSMENT": "ASSESSMENT",
127         "TEXT": "TEXT",
128         "PLAN": "PLAN",
129         "DIAGNOSIS": "DIAGNOSIS",
130         "INTERVENTION": "INTERVENTION",
131         "MONITORING_AND_EVALUATION": "MONITORING_AND_EVALUATION",
132         "TELEHEALTH_DISCLAIMER": "TELEHEALTH_DISCLAIMER",
133         "TOTAL_TIME_SPENT": "TOTAL_TIME_SPENT",
134         "TIME_SPENT_MINUTES": 1,
135         "THERAPY_TIME_SPENT_MINUTES": 1,
136         "PRESCRIPTION_WRITTEN": true,
137         "MEDICATION_MANAGED": true,
138         "DATE_RANGE_START": "DATE_RANGE_START",
139         "DATE_RANGE_END": "DATE_RANGE_END",
140         "MONITORING_DATA": [
141           {
142             "date": "date",
143             "values": [
144               "values",
145               "values"
146             ]
147           },
148           {
149             "date": "date",
150             "values": [
151               "values",
152               "values"
153             ]
154           }
155         ],
156         "INITIATING_VISIT_DATE": "INITIATING_VISIT_DATE"
157       },
158       "signature": {
159         "timestamp": "2024-01-15T09:30:00Z",
160         "provider": {
161           "id": "id",
162           "name": "name",
163           "type": "MD",
164           "npi": "npi",
165           "externalId": "externalId",
166           "providerEligibilityEnabled": true,
167           "serviceEligibilityEnabled": true
168         }
169       },
170       "externalId": "externalId"
171     }
172   ],
173   "externalId": "externalId"
174 }

Authentication

X-API-Keystring

API Key authentication via header

Path Parameters

idstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

serviceIdstring

dataobject

signatureobject

addendalist of objects

externalIdstring or null