13 description: 'Returns a single facility.'
18 description: 'The name for the facility.'
25 description: 'The facility_npi for the facility.'
32 description: 'The phone for the facility.'
39 description: 'The fax for the facility.'
46 description: 'The street for the facility.'
53 description: 'The city for the facility.'
60 description: 'The state for the facility.'
67 description: 'The postal_code for the facility.'
74 description: 'The country_code for the facility.'
81 description: 'The federal_ein for the facility.'
88 description: 'The website for the facility.'
95 description: 'The email for the facility.'
100 name: domain_identifier
102 description: 'The domain_identifier for the facility.'
107 name: facility_taxonomy
109 description: 'The facility_taxonomy for the facility.'
116 description: 'The facility_code for the facility.'
121 name: billing_location
123 description: 'The billing_location setting for the facility.'
128 name: accepts_assignment
130 description: 'The accepts_assignment setting for the facility.'
137 description: 'The oid for the facility.'
142 name: service_location
144 description: 'The service_location setting for the facility.'
150 $ref: '#/components/responses/standard'
152 $ref: '#/components/responses/badrequest'
154 $ref: '#/components/responses/unauthorized'
161 description: 'Creates a facility in the system'
172 description: 'The name for the facility.'
175 description: 'The facility_npi for the facility.'
178 description: 'The phone for the facility.'
181 description: 'The fax for the facility.'
184 description: 'The street for the facility.'
187 description: 'The city for the facility.'
190 description: 'The state for the facility.'
193 description: 'The postal_code for the facility.'
196 description: 'The country_code for the facility.'
199 description: 'The federal_ein for the facility.'
202 description: 'The website for the facility.'
205 description: 'The email for the facility.'
208 description: 'The domain_identifier for the facility.'
211 description: 'The facility_taxonomy for the facility.'
214 description: 'The facility_code for the facility.'
217 description: 'The billing_location setting for the facility.'
220 description: 'The accepts_assignment setting for the facility.'
223 description: 'The oid for the facility.'
226 description: 'The service_location setting for the facility.'
231 facility_npi: '123456789123'
234 street: '1337 Bit Shifter Ln'
239 federal_ein: '4343434'
240 website: 'https://example.com'
242 domain_identifier: ''
243 facility_taxonomy: ''
245 billing_location: '1'
246 accepts_assignment: '1'
248 service_location: '1'
251 $ref: '#/components/responses/standard'
253 $ref: '#/components/responses/badrequest'
255 $ref: '#/components/responses/unauthorized'
259 '/api/facility/{fuuid}':
263 description: 'Returns a single facility.'
268 description: 'The uuid for the facility.'
274 $ref: '#/components/responses/standard'
276 $ref: '#/components/responses/badrequest'
278 $ref: '#/components/responses/unauthorized'
285 description: 'Updates a facility in the system'
290 description: 'The uuid for the facility.'
301 description: 'The name for the facility.'
304 description: 'The facility_npi for the facility.'
307 description: 'The phone for the facility.'
310 description: 'The fax for the facility.'
313 description: 'The street for the facility.'
316 description: 'The city for the facility.'
319 description: 'The state for the facility.'
322 description: 'The postal_code for the facility.'
325 description: 'The country_code for the facility.'
328 description: 'The federal_ein for the facility.'
331 description: 'The website for the facility.'
334 description: 'The email for the facility.'
337 description: 'The domain_identifier for the facility.'
340 description: 'The facility_taxonomy for the facility.'
343 description: 'The facility_code for the facility.'
346 description: 'The billing_location setting for the facility.'
349 description: 'The accepts_assignment setting for the facility.'
352 description: 'The oid for the facility.'
355 description: 'The service_location setting for the facility.'
360 facility_npi: '123456789123'
363 street: '1337 Bit Shifter Ln'
368 federal_ein: '4343434'
369 website: 'https://example.com'
371 domain_identifier: ''
372 facility_taxonomy: ''
374 billing_location: '1'
375 accepts_assignment: '1'
377 service_location: '1'
380 $ref: '#/components/responses/standard'
382 $ref: '#/components/responses/badrequest'
384 $ref: '#/components/responses/unauthorized'
392 description: 'Retrieves a list of patients'
395 $ref: '#/components/parameters/_sort'
399 description: 'The first name for the patient.'
406 description: 'The last name for the patient.'
413 description: 'The social security number for the patient.'
420 description: 'The street for the patient.'
427 description: 'The postal code for the patient.'
434 description: 'The city for the patient.'
441 description: 'The state for the patient.'
448 description: 'The home phone for the patient.'
455 description: 'The business phone for the patient.'
462 description: 'The cell phone for the patient.'
469 description: 'The postal_contact for the patient.'
476 description: 'The gender for the patient.'
483 description: 'The country code for the patient.'
490 description: 'The email for the patient.'
497 description: 'The DOB for the patient.'
504 description: 'The date this patient resource was last modified.'
511 description: 'The number of records to offset from this index in the search result.'
518 description: 'The maximum number of resources to return in the result set. 0 means unlimited.'
526 $ref: '#/components/responses/standard'
528 $ref: '#/components/responses/badrequest'
530 $ref: '#/components/responses/unauthorized'
537 description: 'Creates a new patient'
543 $ref: '#/components/schemas/api_patient_request'
546 description: 'Standard response'
551 validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
552 internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
553 data: { description: 'Returned data.', type: array, items: { properties: { pid: { description: 'patient pid', type: integer } }, type: object } }
557 error_description: []
560 $ref: '#/components/responses/unauthorized'
564 '/api/patient/{puuid}':
568 description: 'Retrieves a single patient by their uuid'
573 description: 'The uuid for the patient.'
579 description: 'Standard response'
583 $ref: '#/components/schemas/api_patient_response'
585 $ref: '#/components/responses/unauthorized'
592 description: 'Updates a patient'
597 description: 'The uuid for the patient.'
606 $ref: '#/components/schemas/api_patient_request'
609 description: 'Standard response'
613 $ref: '#/components/schemas/api_patient_response'
615 $ref: '#/components/responses/unauthorized'
619 '/api/patient/{puuid}/encounter':
623 description: 'Retrieves a list of encounters for a single patient'
628 description: 'The uuid for the patient.'
634 $ref: '#/components/responses/standard'
636 $ref: '#/components/responses/badrequest'
638 $ref: '#/components/responses/unauthorized'
645 description: 'Creates a new encounter'
650 description: 'The uuid for the patient.'
659 $ref: '#/components/schemas/api_encounter_request'
662 description: 'Standard response'
667 validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
668 internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
669 data: { description: 'Returned data.', type: array, items: { properties: { encounter: { description: 'encounter id', type: integer }, uuid: { description: 'encounter uuid', type: string } }, type: object } }
673 error_description: []
674 data: { encounter: 1, uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef }
676 $ref: '#/components/responses/unauthorized'
680 '/api/patient/{puuid}/encounter/{euuid}':
684 description: 'Retrieves a single encounter for a patient'
689 description: 'The uuid for the patient.'
696 description: 'The uuid for the encounter.'
702 description: 'Standard response'
706 $ref: '#/components/schemas/api_encounter_response'
708 $ref: '#/components/responses/unauthorized'
715 description: 'Modify a encounter'
720 description: 'The uuid for the patient.'
727 description: 'The uuid for the encounter.'
736 $ref: '#/components/schemas/api_encounter_request'
739 description: 'Standard response'
743 $ref: '#/components/schemas/api_encounter_response'
745 $ref: '#/components/responses/unauthorized'
749 '/api/patient/{pid}/encounter/{eid}/soap_note':
753 description: 'Retrieves soap notes from an encounter for a patient'
758 description: 'The pid for the patient.'
765 description: 'The id for the encounter.'
771 $ref: '#/components/responses/standard'
773 $ref: '#/components/responses/badrequest'
775 $ref: '#/components/responses/unauthorized'
782 description: 'Submits a new soap note'
787 description: 'The id for the patient.'
794 description: 'The id for the encounter.'
803 $ref: '#/components/schemas/api_soap_note_request'
806 $ref: '#/components/responses/standard'
808 $ref: '#/components/responses/badrequest'
810 $ref: '#/components/responses/unauthorized'
814 '/api/patient/{pid}/encounter/{eid}/vital':
818 description: 'Retrieves all vitals from an encounter for a patient'
823 description: 'The pid for the patient.'
830 description: 'The id for the encounter.'
836 $ref: '#/components/responses/standard'
838 $ref: '#/components/responses/badrequest'
840 $ref: '#/components/responses/unauthorized'
847 description: 'Submits a new vitals form'
852 description: 'The id for the patient.'
859 description: 'The id for the encounter.'
868 $ref: '#/components/schemas/api_vital_request'
871 $ref: '#/components/responses/standard'
873 $ref: '#/components/responses/badrequest'
875 $ref: '#/components/responses/unauthorized'
879 '/api/patient/{pid}/encounter/{eid}/vital/{vid}':
883 description: 'Retrieves a vitals form from an encounter for a patient'
888 description: 'The pid for the patient.'
895 description: 'The id for the encounter.'
902 description: 'The id for the vitals form.'
908 $ref: '#/components/responses/standard'
910 $ref: '#/components/responses/badrequest'
912 $ref: '#/components/responses/unauthorized'
919 description: 'Edit a vitals form'
924 description: 'The id for the patient.'
931 description: 'The id for the encounter.'
938 description: 'The id for the vitalss form.'
947 $ref: '#/components/schemas/api_vital_request'
950 $ref: '#/components/responses/standard'
952 $ref: '#/components/responses/badrequest'
954 $ref: '#/components/responses/unauthorized'
958 '/api/patient/{pid}/encounter/{eid}/soap_note/{sid}':
962 description: 'Retrieves a soap note from an encounter for a patient'
967 description: 'The pid for the patient.'
974 description: 'The id for the encounter.'
981 description: 'The id for the soap note.'
987 $ref: '#/components/responses/standard'
989 $ref: '#/components/responses/badrequest'
991 $ref: '#/components/responses/unauthorized'
998 description: 'Edit a soap note'
1003 description: 'The id for the patient.'
1010 description: 'The id for the encounter.'
1017 description: 'The id for the soap noted.'
1026 $ref: '#/components/schemas/api_soap_note_request'
1029 $ref: '#/components/responses/standard'
1031 $ref: '#/components/responses/badrequest'
1033 $ref: '#/components/responses/unauthorized'
1041 description: 'Retrieves a list of practitioners'
1046 description: 'The title for the practitioner.'
1053 description: 'The first name for the practitioner.'
1060 description: 'The last name for the practitioner.'
1067 description: 'The middle name for the practitioner.'
1074 description: 'The federal tax id for the practitioner.'
1081 description: 'The federal drug id for the practitioner.'
1088 description: 'The upin for the practitioner.'
1095 description: 'The facility id for the practitioner.'
1102 description: 'The facility for the practitioner.'
1109 description: 'The npi for the practitioner.'
1116 description: 'The email for the practitioner.'
1123 description: 'The specialty for the practitioner.'
1130 description: 'The billname for the practitioner.'
1137 description: 'The url for the practitioner.'
1144 description: 'The assistant for the practitioner.'
1151 description: 'The organization for the practitioner.'
1158 description: 'The valedictory for the practitioner.'
1165 description: 'The street for the practitioner.'
1172 description: 'The street (line 2) for the practitioner.'
1179 description: 'The city for the practitioner.'
1186 description: 'The state for the practitioner.'
1193 description: 'The zip for the practitioner.'
1200 description: 'The phone for the practitioner.'
1207 description: 'The fax for the practitioner.'
1214 description: 'The phonew1 for the practitioner.'
1221 description: 'The phonecell for the practitioner.'
1228 description: 'The notes for the practitioner.'
1233 name: state_license_number2
1235 description: 'The state license number for the practitioner.'
1242 description: 'The username for the practitioner.'
1248 $ref: '#/components/responses/standard'
1250 $ref: '#/components/responses/badrequest'
1252 $ref: '#/components/responses/unauthorized'
1259 description: 'Submits a new practitioner'
1271 description: 'The title for the practitioner.'
1274 description: 'The first name for the practitioner.'
1277 description: 'The middle name for the practitioner.'
1280 description: 'The last name for the practitioner.'
1283 description: 'The federal tax id for the practitioner.'
1286 description: 'The federal drug id for the practitioner.'
1289 description: 'The upin for the practitioner.'
1292 description: 'The facility_id for the practitioner.'
1295 description: 'The facility name for the practitioner.'
1298 description: 'The npi for the practitioner.'
1301 description: 'The email for the practitioner.'
1304 description: 'The specialty for the practitioner.'
1307 description: 'The billname for the practitioner.'
1310 description: 'The url for the practitioner.'
1313 description: 'The assistant for the practitioner.'
1316 description: 'The valedictory for the practitioner.'
1319 description: 'The street address for the practitioner.'
1322 description: 'The streetb address for the practitioner.'
1325 description: 'The city for the practitioner.'
1328 description: 'The state for the practitioner.'
1331 description: 'The zip for the practitioner.'
1334 description: 'The phone for the practitioner.'
1337 description: 'The fax for the practitioner.'
1340 description: 'The phonew1 for the practitioner.'
1343 description: 'The phonecell for the practitioner.'
1346 description: 'The notes for the practitioner.'
1348 state_license_number:
1349 description: 'The state license number for the practitioner.'
1352 description: 'The username for the practitioner.'
1364 facility: 'Your Clinic Name Here'
1366 email: info@pennfirm.com
1373 street: '789 Third Avenue'
1374 streetb: '123 Cannaut Street'
1378 phone: '(619) 555-9827'
1380 phonew1: '(619) 555-7822'
1381 phonecell: '(619) 555-7821'
1383 state_license_number: '123456'
1384 username: eduardoperez
1387 description: 'Standard response'
1392 validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
1393 internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
1394 data: { description: 'Returned data.', type: array, items: { properties: { id: { description: 'practitioner id', type: integer }, uuid: { description: 'practitioner uuid', type: string } }, type: object } }
1397 validationErrors: []
1398 error_description: []
1399 data: { id: 7, uuid: 90d453fb-0248-4c0d-9575-d99d02b169f5 }
1401 $ref: '#/components/responses/unauthorized'
1405 '/api/practitioner/{pruuid}':
1409 description: 'Retrieves a single practitioner by their uuid'
1414 description: 'The uuid for the practitioner.'
1420 $ref: '#/components/responses/standard'
1422 $ref: '#/components/responses/badrequest'
1424 $ref: '#/components/responses/unauthorized'
1431 description: 'Edit a practitioner'
1436 description: 'The uuid for the practitioner.'
1447 description: 'The title for the practitioner.'
1450 description: 'The first name for the practitioner.'
1453 description: 'The middle name for the practitioner.'
1456 description: 'The last name for the practitioner.'
1459 description: 'The federal tax id for the practitioner.'
1462 description: 'The federal drug id for the practitioner.'
1465 description: 'The upin for the practitioner.'
1468 description: 'The facility_id for the practitioner.'
1471 description: 'The facility name for the practitioner.'
1474 description: 'The npi for the practitioner.'
1477 description: 'The email for the practitioner.'
1480 description: 'The specialty for the practitioner.'
1483 description: 'The billname for the practitioner.'
1486 description: 'The url for the practitioner.'
1489 description: 'The assistant for the practitioner.'
1492 description: 'The valedictory for the practitioner.'
1495 description: 'The street address for the practitioner.'
1498 description: 'The streetb address for the practitioner.'
1501 description: 'The city for the practitioner.'
1504 description: 'The state for the practitioner.'
1507 description: 'The zip for the practitioner.'
1510 description: 'The phone for the practitioner.'
1513 description: 'The fax for the practitioner.'
1516 description: 'The phonew1 for the practitioner.'
1519 description: 'The phonecell for the practitioner.'
1522 description: 'The notes for the practitioner.'
1524 state_license_number:
1525 description: 'The state license number for the practitioner.'
1528 description: 'The username for the practitioner.'
1536 street: '456 Tree Lane'
1543 description: 'Standard response'
1548 validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
1549 internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
1550 data: { description: 'Returned data.', type: array, items: { properties: { id: { description: 'practitioner id', type: string }, uuid: { description: 'practitioner uuid', type: string }, title: { description: 'practitioner title', type: string }, fname: { description: 'practitioner fname', type: string }, lname: { description: 'practitioner lname', type: string }, mname: { description: 'practitioner mname', type: string }, federaltaxid: { description: 'practitioner federaltaxid', type: string }, federaldrugid: { description: 'practitioner federaldrugid', type: string }, upin: { description: 'practitioner upin', type: string }, facility_id: { description: 'practitioner facility_id', type: string }, facility: { description: 'practitioner facility', type: string }, npi: { description: 'practitioner npi', type: string }, email: { description: 'practitioner email', type: string }, active: { description: 'practitioner active setting', type: string }, specialty: { description: 'practitioner specialty', type: string }, billname: { description: 'practitioner billname', type: string }, url: { description: 'practitioner url', type: string }, assistant: { description: 'practitioner assistant', type: string }, organization: { description: 'practitioner organization', type: string }, valedictory: { description: 'practitioner valedictory', type: string }, street: { description: 'practitioner street', type: string }, streetb: { description: 'practitioner streetb', type: string }, city: { description: 'practitioner city', type: string }, state: { description: 'practitioner state', type: string }, zip: { description: 'practitioner zip', type: string }, phone: { description: 'practitioner phone', type: string }, fax: { description: fax, type: string }, phonew1: { description: 'practitioner phonew1', type: string }, phonecell: { description: 'practitioner phonecell', type: string }, notes: { description: 'practitioner notes', type: string }, state_license_number: { description: 'practitioner state license number', type: string }, abook_title: { description: 'practitioner abook title', type: string }, physician_title: { description: 'practitioner physician title', type: string }, physician_code: { description: 'practitioner physician code', type: string } }, type: object } }
1553 validationErrors: []
1554 error_description: []
1555 data: { id: 7, uuid: 90d453fb-0248-4c0d-9575-d99d02b169f5, title: Mr, fname: Baz, lname: Bop, mname: '', federaltaxid: '', federaldrugid: '', upin: '', facility_id: '3', facility: 'Your Clinic Name Here', npi: '0123456789', email: info@pennfirm.com, active: '1', specialty: '', billname: '', url: '', assistant: '', organization: '', valedictory: '', street: '456 Tree Lane', streetb: '123 Cannaut Street', city: FooTown, state: FL, zip: '08642', phone: 123-456-7890, fax: '', phonew1: '(619) 555-7822', phonecell: '(619) 555-7821', notes: '', state_license_number: '123456', abook_title: null, physician_title: null, physician_code: null }
1557 $ref: '#/components/responses/unauthorized'
1561 /api/medical_problem:
1565 description: 'Retrieves a list of medical problems'
1570 description: 'The uuid for the patient.'
1575 name: condition_uuid
1577 description: 'The uuid for the medical problem.'
1584 description: 'The title for the medical problem.'
1591 description: 'The start date for the medical problem.'
1598 description: 'The end date for the medical problem.'
1605 description: 'The diagnosis for the medical problem.'
1611 $ref: '#/components/responses/standard'
1613 $ref: '#/components/responses/badrequest'
1615 $ref: '#/components/responses/unauthorized'
1619 '/api/medical_problem/{muuid}':
1623 description: 'Retrieves a single medical problem by their uuid'
1628 description: 'The uuid for the medical problem.'
1634 $ref: '#/components/responses/standard'
1636 $ref: '#/components/responses/badrequest'
1638 $ref: '#/components/responses/unauthorized'
1642 '/api/patient/{puuid}/medical_problem':
1646 description: 'Retrieves all medical problems for a patient'
1651 description: 'The uuid for the patient.'
1657 $ref: '#/components/responses/standard'
1659 $ref: '#/components/responses/badrequest'
1661 $ref: '#/components/responses/unauthorized'
1668 description: 'Submits a new medical problem'
1673 description: 'The uuid for the patient.'
1682 $ref: '#/components/schemas/api_medical_problem_request'
1685 $ref: '#/components/responses/standard'
1687 $ref: '#/components/responses/badrequest'
1689 $ref: '#/components/responses/unauthorized'
1693 '/api/patient/{puuid}/medical_problem/{muuid}':
1697 description: 'Retrieves a medical problem for a patient'
1702 description: 'The uuid for the patient.'
1709 description: 'The uuid for the medical problem.'
1715 $ref: '#/components/responses/standard'
1717 $ref: '#/components/responses/badrequest'
1719 $ref: '#/components/responses/unauthorized'
1726 description: 'Edit a medical problem'
1731 description: 'The uuid for the patient.'
1738 description: 'The uuid for the medical problem.'
1747 $ref: '#/components/schemas/api_medical_problem_request'
1750 $ref: '#/components/responses/standard'
1752 $ref: '#/components/responses/badrequest'
1754 $ref: '#/components/responses/unauthorized'
1761 description: 'Delete a medical problem'
1766 description: 'The uuid for the patient.'
1773 description: 'The uuid for the medical problem.'
1779 $ref: '#/components/responses/standard'
1781 $ref: '#/components/responses/badrequest'
1783 $ref: '#/components/responses/unauthorized'
1791 description: 'Retrieves a list of allergies'
1796 description: 'The uuid for the patient.'
1803 description: 'The uuid for the allergy.'
1810 description: 'The title for the allergy.'
1817 description: 'The start date for the allergy.'
1824 description: 'The end date for the allergy.'
1831 description: 'The diagnosis for the allergy.'
1837 $ref: '#/components/responses/standard'
1839 $ref: '#/components/responses/badrequest'
1841 $ref: '#/components/responses/unauthorized'
1845 '/api/allergy/{auuid}':
1849 description: 'Retrieves a single allergy by their uuid'
1854 description: 'The uuid for the allergy.'
1860 $ref: '#/components/responses/standard'
1862 $ref: '#/components/responses/badrequest'
1864 $ref: '#/components/responses/unauthorized'
1868 '/api/patient/{puuid}/allergy':
1872 description: 'Retrieves all allergies for a patient'
1877 description: 'The uuid for the patient.'
1883 $ref: '#/components/responses/standard'
1885 $ref: '#/components/responses/badrequest'
1887 $ref: '#/components/responses/unauthorized'
1894 description: 'Submits a new allergy'
1899 description: 'The uuid for the patient.'
1908 $ref: '#/components/schemas/api_allergy_request'
1911 $ref: '#/components/responses/standard'
1913 $ref: '#/components/responses/badrequest'
1915 $ref: '#/components/responses/unauthorized'
1919 '/api/patient/{puuid}/allergy/{auuid}':
1923 description: 'Retrieves a allergy for a patient'
1928 description: 'The uuid for the patient.'
1935 description: 'The uuid for the allergy.'
1941 $ref: '#/components/responses/standard'
1943 $ref: '#/components/responses/badrequest'
1945 $ref: '#/components/responses/unauthorized'
1952 description: 'Edit a allergy'
1957 description: 'The uuid for the patient.'
1964 description: 'The uuid for the allergy.'
1973 $ref: '#/components/schemas/api_allergy_request'
1976 $ref: '#/components/responses/standard'
1978 $ref: '#/components/responses/badrequest'
1980 $ref: '#/components/responses/unauthorized'
1987 description: 'Delete a medical problem'
1992 description: 'The uuid for the patient.'
1999 description: 'The uuid for the allergy.'
2005 $ref: '#/components/responses/standard'
2007 $ref: '#/components/responses/badrequest'
2009 $ref: '#/components/responses/unauthorized'
2013 '/api/patient/{pid}/medication':
2017 description: 'Retrieves all medications for a patient'
2022 description: 'The pid for the patient.'
2028 $ref: '#/components/responses/standard'
2030 $ref: '#/components/responses/badrequest'
2032 $ref: '#/components/responses/unauthorized'
2039 description: 'Submits a new medication'
2044 description: 'The pid for the patient.'
2053 $ref: '#/components/schemas/api_medication_request'
2056 $ref: '#/components/responses/standard'
2058 $ref: '#/components/responses/badrequest'
2060 $ref: '#/components/responses/unauthorized'
2064 '/api/patient/{pid}/medication/{mid}':
2068 description: 'Retrieves a medication for a patient'
2073 description: 'The id for the patient.'
2080 description: 'The id for the medication.'
2086 $ref: '#/components/responses/standard'
2088 $ref: '#/components/responses/badrequest'
2090 $ref: '#/components/responses/unauthorized'
2097 description: 'Edit a medication'
2102 description: 'The pid for the patient.'
2109 description: 'The id for the medication.'
2118 $ref: '#/components/schemas/api_medication_request'
2121 $ref: '#/components/responses/standard'
2123 $ref: '#/components/responses/badrequest'
2125 $ref: '#/components/responses/unauthorized'
2132 description: 'Delete a medication'
2137 description: 'The id for the patient.'
2144 description: 'The id for the medication.'
2150 $ref: '#/components/responses/standard'
2152 $ref: '#/components/responses/badrequest'
2154 $ref: '#/components/responses/unauthorized'
2158 '/api/patient/{pid}/surgery':
2162 description: 'Retrieves all surgeries for a patient'
2167 description: 'The pid for the patient.'
2173 $ref: '#/components/responses/standard'
2175 $ref: '#/components/responses/badrequest'
2177 $ref: '#/components/responses/unauthorized'
2184 description: 'Submits a new surgery'
2189 description: 'The pid for the patient.'
2198 $ref: '#/components/schemas/api_surgery_request'
2201 $ref: '#/components/responses/standard'
2203 $ref: '#/components/responses/badrequest'
2205 $ref: '#/components/responses/unauthorized'
2209 '/api/patient/{pid}/surgery/{sid}':
2213 description: 'Retrieves a surgery for a patient'
2218 description: 'The id for the patient.'
2225 description: 'The id for the surgery.'
2231 $ref: '#/components/responses/standard'
2233 $ref: '#/components/responses/badrequest'
2235 $ref: '#/components/responses/unauthorized'
2242 description: 'Edit a surgery'
2247 description: 'The pid for the patient.'
2254 description: 'The id for the surgery.'
2263 $ref: '#/components/schemas/api_surgery_request'
2266 $ref: '#/components/responses/standard'
2268 $ref: '#/components/responses/badrequest'
2270 $ref: '#/components/responses/unauthorized'
2277 description: 'Delete a surgery'
2282 description: 'The id for the patient.'
2289 description: 'The id for the surgery.'
2295 $ref: '#/components/responses/standard'
2297 $ref: '#/components/responses/badrequest'
2299 $ref: '#/components/responses/unauthorized'
2303 '/api/patient/{pid}/dental_issue':
2307 description: 'Retrieves all dental issues for a patient'
2312 description: 'The pid for the patient.'
2318 $ref: '#/components/responses/standard'
2320 $ref: '#/components/responses/badrequest'
2322 $ref: '#/components/responses/unauthorized'
2329 description: 'Submits a new dental issue'
2334 description: 'The pid for the patient.'
2343 $ref: '#/components/schemas/api_dental_issue_request'
2346 $ref: '#/components/responses/standard'
2348 $ref: '#/components/responses/badrequest'
2350 $ref: '#/components/responses/unauthorized'
2354 '/api/patient/{pid}/dental_issue/{did}':
2358 description: 'Retrieves a dental issue for a patient'
2363 description: 'The id for the patient.'
2370 description: 'The id for the dental issue.'
2376 $ref: '#/components/responses/standard'
2378 $ref: '#/components/responses/badrequest'
2380 $ref: '#/components/responses/unauthorized'
2387 description: 'Edit a dental issue'
2392 description: 'The pid for the patient.'
2399 description: 'The id for the dental issue.'
2408 $ref: '#/components/schemas/api_dental_issue_request'
2411 $ref: '#/components/responses/standard'
2413 $ref: '#/components/responses/badrequest'
2415 $ref: '#/components/responses/unauthorized'
2422 description: 'Delete a dental issue'
2427 description: 'The id for the patient.'
2434 description: 'The id for the dental issue.'
2440 $ref: '#/components/responses/standard'
2442 $ref: '#/components/responses/badrequest'
2444 $ref: '#/components/responses/unauthorized'
2448 '/api/patient/{pid}/appointment':
2452 description: 'Retrieves all appointments for a patient'
2457 description: 'The pid for the patient.'
2463 $ref: '#/components/responses/standard'
2465 $ref: '#/components/responses/badrequest'
2467 $ref: '#/components/responses/unauthorized'
2474 description: 'Submits a new appointment'
2479 description: 'The id for the patient.'
2497 - pc_billing_location
2500 description: 'The category of the appointment.'
2503 description: 'The title of the appointment.'
2506 description: 'The duration of the appointment.'
2509 description: 'Comments for the appointment.'
2512 description: 'use an option from resource=/api/list/apptstat'
2515 description: 'The date of the appointment.'
2518 description: 'The time of the appointment.'
2521 description: 'The facility id of the appointment.'
2523 pc_billing_location:
2524 description: 'The billinag location id of the appointment.'
2527 description: 'The provider id for the appointment.'
2532 pc_title: 'Office Visit'
2536 pc_eventDate: '2018-10-19'
2537 pc_startTime: '09:00'
2539 pc_billing_location: '10'
2543 $ref: '#/components/responses/standard'
2545 $ref: '#/components/responses/badrequest'
2547 $ref: '#/components/responses/unauthorized'
2555 description: 'Retrieves all appointments'
2558 $ref: '#/components/responses/standard'
2560 $ref: '#/components/responses/badrequest'
2562 $ref: '#/components/responses/unauthorized'
2566 '/api/appointment/{eid}':
2570 description: 'Retrieves an appointment'
2575 description: 'The eid for the appointment.'
2581 $ref: '#/components/responses/standard'
2583 $ref: '#/components/responses/badrequest'
2585 $ref: '#/components/responses/unauthorized'
2589 '/api/patient/{pid}/appointment/{eid}':
2593 description: 'Retrieves a appointment for a patient'
2598 description: 'The id for the patient.'
2605 description: 'The eid for the appointment.'
2611 $ref: '#/components/responses/standard'
2613 $ref: '#/components/responses/badrequest'
2615 $ref: '#/components/responses/unauthorized'
2622 description: 'Delete a appointment'
2627 description: 'The id for the patient.'
2634 description: 'The eid for the appointment.'
2640 $ref: '#/components/responses/standard'
2642 $ref: '#/components/responses/badrequest'
2644 $ref: '#/components/responses/unauthorized'
2648 '/api/list/{list_name}':
2652 description: 'Retrieves a list'
2657 description: 'The list_id of the list.'
2663 $ref: '#/components/responses/standard'
2665 $ref: '#/components/responses/badrequest'
2667 $ref: '#/components/responses/unauthorized'
2675 description: 'Retrieves a list of users'
2680 description: 'The id for the user.'
2687 description: 'The title for the user.'
2694 description: 'The first name for the user.'
2701 description: 'The last name for the user.'
2708 description: 'The middle name for the user.'
2715 description: 'The federal tax id for the user.'
2722 description: 'The federal drug id for the user.'
2729 description: 'The upin for the user.'
2736 description: 'The facility id for the user.'
2743 description: 'The facility for the user.'
2750 description: 'The npi for the user.'
2757 description: 'The email for the user.'
2764 description: 'The specialty for the user.'
2771 description: 'The billname for the user.'
2778 description: 'The url for the user.'
2785 description: 'The assistant for the user.'
2792 description: 'The organization for the user.'
2799 description: 'The valedictory for the user.'
2806 description: 'The street for the user.'
2813 description: 'The street (line 2) for the user.'
2820 description: 'The city for the user.'
2827 description: 'The state for the user.'
2834 description: 'The zip for the user.'
2841 description: 'The phone for the user.'
2848 description: 'The fax for the user.'
2855 description: 'The phonew1 for the user.'
2862 description: 'The phonecell for the user.'
2869 description: 'The notes for the user.'
2874 name: state_license_number2
2876 description: 'The state license number for the user.'
2883 description: 'The username for the user.'
2889 $ref: '#/components/responses/standard'
2891 $ref: '#/components/responses/badrequest'
2893 $ref: '#/components/responses/unauthorized'
2901 description: 'Retrieves a single user by their uuid'
2906 description: 'The uuid for the user.'
2912 $ref: '#/components/responses/standard'
2914 $ref: '#/components/responses/badrequest'
2916 $ref: '#/components/responses/unauthorized'
2924 description: 'Retrieves the OpenEMR version information'
2927 $ref: '#/components/responses/standard'
2929 $ref: '#/components/responses/badrequest'
2931 $ref: '#/components/responses/unauthorized'
2939 description: 'Retrieves the OpenEMR product registration information'
2942 $ref: '#/components/responses/standard'
2944 $ref: '#/components/responses/badrequest'
2946 $ref: '#/components/responses/unauthorized'
2950 /api/insurance_company:
2954 description: 'Retrieves all insurance companies'
2957 $ref: '#/components/responses/standard'
2959 $ref: '#/components/responses/badrequest'
2961 $ref: '#/components/responses/unauthorized'
2968 description: 'Submits a new insurance company'
2974 $ref: '#/components/schemas/api_insurance_company_request'
2977 $ref: '#/components/responses/standard'
2979 $ref: '#/components/responses/badrequest'
2981 $ref: '#/components/responses/unauthorized'
2985 '/api/insurance_company/{iid}':
2989 description: 'Retrieves insurance company'
2994 description: 'The id of the insurance company.'
3000 $ref: '#/components/responses/standard'
3002 $ref: '#/components/responses/badrequest'
3004 $ref: '#/components/responses/unauthorized'
3011 description: 'Edit a insurance company'
3016 description: 'The id for the insurance company.'
3025 $ref: '#/components/schemas/api_insurance_company_request'
3028 $ref: '#/components/responses/standard'
3030 $ref: '#/components/responses/badrequest'
3032 $ref: '#/components/responses/unauthorized'
3036 /api/insurance_type:
3040 description: 'Retrieves all insurance types'
3043 $ref: '#/components/responses/standard'
3045 $ref: '#/components/responses/badrequest'
3047 $ref: '#/components/responses/unauthorized'
3051 '/api/patient/{pid}/document':
3055 description: 'Retrieves all file information of documents from a category for a patient'
3060 description: 'The pid for the patient.'
3067 description: 'The category of the documents.'
3073 $ref: '#/components/responses/standard'
3075 $ref: '#/components/responses/badrequest'
3077 $ref: '#/components/responses/unauthorized'
3084 description: 'Submits a new patient document'
3089 description: 'The pid for the patient.'
3096 description: 'The category of the document.'
3103 multipart/form-data:
3107 description: document
3113 $ref: '#/components/responses/standard'
3115 $ref: '#/components/responses/badrequest'
3117 $ref: '#/components/responses/unauthorized'
3121 '/api/patient/{pid}/document/{did}':
3125 description: 'Retrieves a document for a patient'
3130 description: 'The pid for the patient.'
3137 description: 'The id for the patient document.'
3143 $ref: '#/components/responses/standard'
3145 $ref: '#/components/responses/badrequest'
3147 $ref: '#/components/responses/unauthorized'
3151 '/api/patient/{pid}/insurance':
3155 description: 'Retrieves all insurances for a patient'
3160 description: 'The pid for the patient.'
3166 $ref: '#/components/responses/standard'
3168 $ref: '#/components/responses/badrequest'
3170 $ref: '#/components/responses/unauthorized'
3174 '/api/patient/{pid}/insurance/{type}':
3178 description: 'Retrieves a insurance (by type) for a patient'
3183 description: 'The pid for the patient.'
3190 description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
3196 $ref: '#/components/responses/standard'
3198 $ref: '#/components/responses/badrequest'
3200 $ref: '#/components/responses/unauthorized'
3207 description: 'Edit a patient insurance (by type)'
3212 description: 'The pid for the patient.'
3219 description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
3228 $ref: '#/components/schemas/api_insurance_request'
3231 $ref: '#/components/responses/standard'
3233 $ref: '#/components/responses/badrequest'
3235 $ref: '#/components/responses/unauthorized'
3242 description: 'Submits a new patient insurance (with type)'
3247 description: 'The pid for the patient.'
3254 description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
3263 $ref: '#/components/schemas/api_insurance_request'
3266 $ref: '#/components/responses/standard'
3268 $ref: '#/components/responses/badrequest'
3270 $ref: '#/components/responses/unauthorized'
3274 '/api/patient/{pid}/message':
3278 description: 'Submits a pnote message'
3283 description: 'The id for the patient.'
3292 $ref: '#/components/schemas/api_message_request'
3295 $ref: '#/components/responses/standard'
3297 $ref: '#/components/responses/badrequest'
3299 $ref: '#/components/responses/unauthorized'
3303 '/api/patient/{pid}/transaction':
3307 description: 'Get Transactions for a patient'
3312 description: 'The pid for the patient'
3318 $ref: '#/components/responses/standard'
3320 $ref: '#/components/responses/badrequest'
3322 $ref: '#/components/responses/unauthorized'
3329 description: 'Submits a transaction'
3334 description: 'The pid for the patient.'
3343 $ref: '#/components/schemas/api_transaction_request'
3346 $ref: '#/components/responses/standard'
3348 $ref: '#/components/responses/badrequest'
3350 $ref: '#/components/responses/unauthorized'
3354 '/api/transaction/{tid}':
3358 description: 'Updates a transaction'
3363 description: 'The id for the transaction.'
3372 $ref: '#/components/schemas/api_transaction_request'
3375 $ref: '#/components/responses/standard'
3377 $ref: '#/components/responses/badrequest'
3379 $ref: '#/components/responses/unauthorized'
3383 '/api/patient/{pid}/message/{mid}':
3387 description: 'Edit a pnote message'
3392 description: 'The id for the patient.'
3399 description: 'The id for the pnote message.'
3408 $ref: '#/components/schemas/api_message_request'
3411 $ref: '#/components/responses/standard'
3413 $ref: '#/components/responses/badrequest'
3415 $ref: '#/components/responses/unauthorized'
3422 description: 'Delete a pnote message'
3427 description: 'The id for the patient.'
3434 description: 'The id for the pnote message.'
3440 $ref: '#/components/responses/standard'
3442 $ref: '#/components/responses/badrequest'
3444 $ref: '#/components/responses/unauthorized'
3452 description: 'Retrieves a list of immunizations'
3457 description: 'The pid for the patient.'
3464 description: 'The id for the immunization.'
3471 description: 'The uuid for the immunization.'
3476 name: administered_date
3478 description: 'The administered date for the immunization.'
3483 name: immunization_id
3485 description: 'The immunization list_id for the immunization.'
3492 description: 'The cvx code for the immunization.'
3499 description: 'The manufacturer for the immunization.'
3506 description: 'The lot number for the immunization.'
3511 name: administered_by_id
3513 description: 'The administered by id for the immunization.'
3518 name: administered_by
3520 description: 'The administered by for the immunization.'
3525 name: education_date
3527 description: 'The education date for the immunization.'
3534 description: 'The vis date for the immunization.'
3541 description: 'The note for the immunization.'
3548 description: 'The create date for the immunization.'
3555 description: 'The update date for the immunization.'
3562 description: 'The created_by for the immunization.'
3569 description: 'The updated_by for the immunization.'
3574 name: amount_administered
3576 description: 'The amount administered for the immunization.'
3581 name: amount_administered_unit
3583 description: 'The amount administered unit for the immunization.'
3588 name: expiration_date
3590 description: 'The expiration date for the immunization.'
3597 description: 'The route for the immunization.'
3602 name: administration_site
3604 description: 'The administration site for the immunization.'
3609 name: added_erroneously
3611 description: 'The added_erroneously for the immunization.'
3618 description: 'The external_id for the immunization.'
3623 name: completion_status
3625 description: 'The completion status for the immunization.'
3630 name: information_source
3632 description: 'The information source for the immunization.'
3637 name: refusal_reason
3639 description: 'The refusal reason for the immunization.'
3644 name: ordering_provider
3646 description: 'The ordering provider for the immunization.'
3652 $ref: '#/components/responses/standard'
3654 $ref: '#/components/responses/badrequest'
3656 $ref: '#/components/responses/unauthorized'
3660 '/api/immunization/{uuid}':
3664 description: 'Retrieves a immunization'
3669 description: 'The uuid for the immunization.'
3675 $ref: '#/components/responses/standard'
3677 $ref: '#/components/responses/badrequest'
3679 $ref: '#/components/responses/unauthorized'
3687 description: 'Retrieves a list of all procedures'
3690 $ref: '#/components/responses/standard'
3692 $ref: '#/components/responses/badrequest'
3694 $ref: '#/components/responses/unauthorized'
3698 '/api/procedure/{uuid}':
3702 description: 'Retrieves a procedure'
3707 description: 'The uuid for the procedure.'
3713 $ref: '#/components/responses/standard'
3715 $ref: '#/components/responses/badrequest'
3717 $ref: '#/components/responses/unauthorized'
3725 description: 'Retrieves a list of all drugs'
3728 $ref: '#/components/responses/standard'
3730 $ref: '#/components/responses/badrequest'
3732 $ref: '#/components/responses/unauthorized'
3740 description: 'Retrieves a drug'
3745 description: 'The uuid for the drug.'
3751 $ref: '#/components/responses/standard'
3753 $ref: '#/components/responses/badrequest'
3755 $ref: '#/components/responses/unauthorized'
3763 description: 'Retrieves a list of all prescriptions'
3766 $ref: '#/components/responses/standard'
3768 $ref: '#/components/responses/badrequest'
3770 $ref: '#/components/responses/unauthorized'
3774 '/api/prescription/{uuid}':
3778 description: 'Retrieves a prescription'
3783 description: 'The uuid for the prescription.'
3789 $ref: '#/components/responses/standard'
3791 $ref: '#/components/responses/badrequest'
3793 $ref: '#/components/responses/unauthorized'
3797 /fhir/AllergyIntolerance:
3801 description: 'Returns a list of AllergyIntolerance resources.'
3806 description: 'The uuid for the AllergyIntolerance resource.'
3813 description: 'The uuid for the patient.'
3819 description: 'Standard Response'
3824 'json object': { description: 'FHIR Json object.', type: object }
3827 meta: { lastUpdated: '2021-09-14T09:13:51' }
3828 resourceType: Bundle
3831 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3833 $ref: '#/components/responses/badrequest'
3835 $ref: '#/components/responses/unauthorized'
3839 '/fhir/AllergyIntolerance/{uuid}':
3843 description: 'Returns a single AllergyIntolerance resource.'
3848 description: 'The uuid for the AllergyIntolerance resource.'
3854 description: 'Standard Response'
3859 'json object': { description: 'FHIR Json object.', type: object }
3862 id: 94682fe5-f383-4885-9505-64b02e34906f
3863 meta: { versionId: '1', lastUpdated: '2021-09-16T00:27:32+00:00' }
3864 resourceType: AllergyIntolerance
3865 text: { status: additional, div: '<div xmlns=''http://www.w3.org/1999/xhtml''>penicillin</div>' }
3866 clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical', code: active, display: Active }] }
3867 verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification', code: confirmed, display: Confirmed }] }
3868 category: [medication]
3870 code: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
3871 patient: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92 }
3872 reaction: [{ manifestation: [{ coding: [{ system: 'http://snomed.info/sct', code: '422587007', display: Nausea }], text: Nausea }] }]
3874 $ref: '#/components/responses/badrequest'
3876 $ref: '#/components/responses/unauthorized'
3878 $ref: '#/components/responses/uuidnotfound'
3886 description: 'Returns a list of Appointment resources.'
3891 description: 'The uuid for the Appointment resource.'
3898 description: 'The uuid for the patient.'
3904 description: 'Standard Response'
3909 'json object': { description: 'FHIR Json object.', type: object }
3912 meta: { lastUpdated: '2021-09-14T09:13:51' }
3913 resourceType: Bundle
3916 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3918 $ref: '#/components/responses/badrequest'
3920 $ref: '#/components/responses/unauthorized'
3924 '/fhir/Appointment/{uuid}':
3928 description: 'Returns a single Appointment resource.'
3933 description: 'The uuid for the Appointment resource.'
3939 description: 'Standard Response'
3944 'json object': { description: 'FHIR Json object.', type: object }
3948 $ref: '#/components/responses/badrequest'
3950 $ref: '#/components/responses/unauthorized'
3952 $ref: '#/components/responses/uuidnotfound'
3960 description: 'Returns a list of CarePlan resources.'
3965 description: 'The uuid for the CarePlan resource.'
3972 description: 'The uuid for the patient.'
3979 description: 'The category of the CarePlan resource.'
3985 description: 'Standard Response'
3990 'json object': { description: 'FHIR Json object.', type: object }
3993 meta: { lastUpdated: '2021-09-14T09:13:51' }
3994 resourceType: Bundle
3997 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CarePlan' }]
3999 $ref: '#/components/responses/badrequest'
4001 $ref: '#/components/responses/unauthorized'
4005 '/fhir/CarePlan/{uuid}':
4009 description: 'Returns a single CarePlan resource.'
4014 description: 'The uuid for the CarePlan resource.'
4020 description: 'Standard Response'
4025 'json object': { description: 'FHIR Json object.', type: object }
4028 id: 94682f08-8fbc-451e-b1ec-f922d765c38f_1
4029 meta: { versionId: '1', lastUpdated: '2021-09-16T00:54:18+00:00' }
4030 resourceType: CarePlan
4031 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"><p>Treat flu.</p></div>' }
4034 category: [{ coding: [{ system: 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', code: assess-plan }] }]
4035 description: 'Treat flu.'
4036 subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
4038 $ref: '#/components/responses/badrequest'
4040 $ref: '#/components/responses/unauthorized'
4042 $ref: '#/components/responses/uuidnotfound'
4050 description: 'Returns a list of CareTeam resources.'
4055 description: 'The uuid for the CareTeam resource.'
4062 description: 'The uuid for the patient.'
4069 description: 'The status of the CarePlan resource.'
4075 description: 'Standard Response'
4080 'json object': { description: 'FHIR Json object.', type: object }
4083 meta: { lastUpdated: '2021-09-14T09:13:51' }
4084 resourceType: Bundle
4087 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CareTeam' }]
4089 $ref: '#/components/responses/badrequest'
4091 $ref: '#/components/responses/unauthorized'
4095 '/fhir/CareTeam/{uuid}':
4099 description: 'Returns a single CareTeam resource.'
4104 description: 'The uuid for the CareTeam resource.'
4110 description: 'Standard Response'
4115 'json object': { description: 'FHIR Json object.', type: object }
4118 id: 94682f09-69fe-4ada-8ea6-753a52bd1516
4119 meta: { versionId: '1', lastUpdated: '2021-09-16T01:07:22+00:00' }
4120 resourceType: CareTeam
4122 subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
4123 participant: [{ role: [{ coding: [{ system: 'http://nucc.org/provider-taxonomy', code: 102L00000X, display: Psychoanalyst }] }], member: { reference: Practitioner/94682c68-f712-4c39-9158-ff132a08f26b, type: Practitioner }, onBehalfOf: { reference: Organization/94682c62-b801-4498-84a1-13f158bb2a18, type: Organization } }, { role: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }], member: { reference: Organization/94682c62-b801-4498-84a1-13f158bb2a18, type: Organization } }]
4125 $ref: '#/components/responses/badrequest'
4127 $ref: '#/components/responses/unauthorized'
4129 $ref: '#/components/responses/uuidnotfound'
4137 description: 'Returns a list of Condition resources.'
4142 description: 'The uuid for the Condition resource.'
4149 description: 'The uuid for the patient.'
4155 description: 'Standard Response'
4160 'json object': { description: 'FHIR Json object.', type: object }
4163 meta: { lastUpdated: '2021-09-14T09:13:51' }
4164 resourceType: Bundle
4167 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Condition' }]
4169 $ref: '#/components/responses/badrequest'
4171 $ref: '#/components/responses/unauthorized'
4175 '/fhir/Condition/{uuid}':
4179 description: 'Returns a single Condition resource.'
4184 description: 'The uuid for the Condition resource.'
4190 description: 'Standard Response'
4195 'json object': { description: 'FHIR Json object.', type: object }
4198 id: 94682c68-e5bb-4c5c-859a-cebaa5a1e582
4199 meta: { versionId: '1', lastUpdated: '2021-09-16T02:41:53+00:00' }
4200 resourceType: Condition
4201 clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-clinical', code: inactive, display: Inactive }] }
4202 verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-ver-status', code: unconfirmed, display: Unconfirmed }] }
4203 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-category', code: problem-list-item, display: 'Problem List Item' }] }]
4204 code: { coding: [{ system: 'http://snomed.info/sct', code: '444814009', display: '' }] }
4205 subject: { reference: Patient/94682c62-d37e-48b5-8018-c5f6f3566609 }
4207 $ref: '#/components/responses/badrequest'
4209 $ref: '#/components/responses/unauthorized'
4211 $ref: '#/components/responses/uuidnotfound'
4219 description: 'Returns a list of Coverage resources.'
4224 description: 'The uuid for the Coverage resource.'
4231 description: 'The uuid for the patient.'
4238 description: 'The payor of the Coverage resource.'
4244 description: 'Standard Response'
4249 'json object': { description: 'FHIR Json object.', type: object }
4252 meta: { lastUpdated: '2021-09-14T09:13:51' }
4253 resourceType: Bundle
4256 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Coverage' }]
4258 $ref: '#/components/responses/badrequest'
4260 $ref: '#/components/responses/unauthorized'
4264 '/fhir/Coverage/{uuid}':
4268 description: 'Returns a single Coverage resource.'
4273 description: 'The uuid for the Coverage resource.'
4279 description: 'Standard Response'
4284 'json object': { description: 'FHIR Json object.', type: object }
4287 id: 960d5f10-edc6-4c65-a6d4-39a1e1da87a8
4288 meta: { versionId: '1', lastUpdated: '2022-04-14T07:58:45+00:00' }
4289 resourceType: Coverage
4291 beneficiary: { reference: Patient/960d5f08-9fdf-4bdc-9108-84a149e28bac }
4292 relationship: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/subscriber-relationship', code: '' }] }
4294 $ref: '#/components/responses/badrequest'
4296 $ref: '#/components/responses/unauthorized'
4298 $ref: '#/components/responses/uuidnotfound'
4306 description: 'Returns a list of Device resources.'
4311 description: 'The uuid for the Device resource.'
4318 description: 'The uuid for the patient.'
4324 description: 'Standard Response'
4329 'json object': { description: 'FHIR Json object.', type: object }
4332 meta: { lastUpdated: '2021-09-14T09:13:51' }
4333 resourceType: Bundle
4336 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Device' }]
4338 $ref: '#/components/responses/badrequest'
4340 $ref: '#/components/responses/unauthorized'
4344 '/fhir/Device/{uuid}':
4348 description: 'Returns a single Device resource.'
4353 description: 'The uuid for the Device resource.'
4359 description: 'Standard Response'
4364 'json object': { description: 'FHIR Json object.', type: object }
4367 id: 946dce19-c80a-402c-862a-eadf3f2377f0
4368 meta: { versionId: '1', lastUpdated: '2021-09-18T19:28:59+00:00' }
4369 resourceType: Device
4370 udiCarrier: [{ deviceIdentifier: '08717648200274', carrierHRF: '=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123' }]
4371 distinctIdentifier: A99971312345600
4372 manufactureDate: '2013-02-01'
4373 expirationDate: '2014-02-01'
4374 lotNumber: 000000000000XYZ123
4375 serialNumber: '000025'
4376 type: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }
4377 patient: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4379 $ref: '#/components/responses/badrequest'
4381 $ref: '#/components/responses/unauthorized'
4383 $ref: '#/components/responses/uuidnotfound'
4387 /fhir/DiagnosticReport:
4391 description: 'Returns a list of DiagnosticReport resources.'
4396 description: 'The uuid for the DiagnosticReport resource.'
4403 description: 'The uuid for the patient.'
4410 description: 'The code of the DiagnosticReport resource.'
4417 description: 'The category of the DiagnosticReport resource.'
4424 description: 'The datetime of the DiagnosticReport resource.'
4430 description: 'Standard Response'
4435 'json object': { description: 'FHIR Json object.', type: object }
4438 meta: { lastUpdated: '2021-09-14T09:13:51' }
4439 resourceType: Bundle
4442 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DiagnosticReport' }]
4444 $ref: '#/components/responses/badrequest'
4446 $ref: '#/components/responses/unauthorized'
4450 '/fhir/DiagnosticReport/{uuid}':
4454 description: 'Returns a single DiagnosticReport resource.'
4459 description: 'The uuid for the DiagnosticReport resource.'
4465 description: 'Standard Response'
4470 'json object': { description: 'FHIR Json object.', type: object }
4473 id: 93fb2d6a-77ac-48ca-a12d-1a17e40007e3
4474 meta: { versionId: '1', lastUpdated: '2021-09-18T20:52:34+00:00' }
4475 resourceType: DiagnosticReport
4477 category: [{ coding: [{ system: 'http://loinc.org', code: LP7839-6, display: Pathology }] }]
4478 code: { coding: [{ system: 'http://loinc.org', code: 11502-2, display: 'Laboratory report' }] }
4479 subject: { reference: Patient/9353b8f5-0a87-4e2a-afd4-25341fdb0fbc, type: Patient }
4480 encounter: { reference: Encounter/93540818-cb5f-49df-b73b-83901bb793b6, type: Encounter }
4481 effectiveDateTime: '2015-06-22T00:00:00+00:00'
4482 issued: '2015-06-22T00:00:00+00:00'
4483 performer: [{ reference: Organization/935249b5-0ba6-4b5b-8863-a7a27d4c6350, type: Organization }]
4484 presentedForm: [{ contentType: text/plain, data: TXMgQWxpY2UgTmV3bWFuIHdhcyB0ZXN0ZWQgZm9yIHRoZSBVcmluYW5hbHlzaXMgbWFjcm8gcGFuZWwgYW5kIHRoZSByZXN1bHRzIGhhdmUgYmVlbiBmb3VuZCB0byBiZSANCm5vcm1hbC4= }]
4486 $ref: '#/components/responses/badrequest'
4488 $ref: '#/components/responses/unauthorized'
4490 $ref: '#/components/responses/uuidnotfound'
4494 /fhir/DocumentReference:
4498 description: 'Returns a list of DocumentReference resources.'
4503 description: 'The uuid for the DocumentReference resource.'
4510 description: 'The uuid for the patient.'
4517 description: 'The type of the DocumentReference resource.'
4524 description: 'The category of the DocumentReference resource.'
4531 description: 'The datetime of the DocumentReference resource.'
4537 description: 'Standard Response'
4542 'json object': { description: 'FHIR Json object.', type: object }
4545 meta: { lastUpdated: '2021-09-14T09:13:51' }
4546 resourceType: Bundle
4549 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DocumentReference' }]
4551 $ref: '#/components/responses/badrequest'
4553 $ref: '#/components/responses/unauthorized'
4557 /fhir/DocumentReference/$docref:
4561 description: 'The $docref operation is used to request the server generates a document based on the specified parameters. If no additional parameters are specified then a DocumentReference to the patient''s most current Clinical Summary of Care Document (CCD) is returned. The document itself is retrieved using the DocumentReference.content.attachment.url element. See <a href=''http://hl7.org/fhir/us/core/OperationDefinition-docref.html'' target=''_blank'' rel=''noopener''>http://hl7.org/fhir/us/core/OperationDefinition-docref.html</a> for more details.'
4563 description: 'Detailed documentation on this operation'
4564 url: 'https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'
4569 description: 'The uuid for the patient.'
4576 description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no start date is provided then all documents prior to the end date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
4583 description: 'The datetime refers to care dates not record currency dates. All records relating to care provided in a certain date range. If no end date is provided then all documents subsequent to the start date are in scope. If no start and end date are provided, the most recent or current document is in scope.'
4590 description: 'The type refers to the document type. This is a LOINC code from the valueset of <a href=''http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html'' target=''_blank'' rel=''noopener''>http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html</a>. The server currently only supports the LOINC code of 34133-9 (Summary of episode node).'
4596 description: 'A search bundle of DocumentReferences is returned'
4598 $ref: '#/components/responses/badrequest'
4600 $ref: '#/components/responses/unauthorized'
4604 '/fhir/DocumentReference/{uuid}':
4608 description: 'Returns a single DocumentReference resource.'
4613 description: 'The uuid for the DocumentReference resource.'
4619 description: 'Standard Response'
4624 'json object': { description: 'FHIR Json object.', type: object }
4627 id: 946e7553-1aaa-49f8-8f81-ae15ccaa9165
4628 meta: { versionId: '1', lastUpdated: '2021-09-19T03:17:51+00:00' }
4629 resourceType: DocumentReference
4630 identifier: [{ value: 946e7553-1aaa-49f8-8f81-ae15ccaa9165 }]
4632 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: unknown }] }
4633 category: [{ coding: [{ system: 'https://localhost:9300/apis/default/fhir/ValueSet/openemr-document-types', code: openemr-document, display: 'OpenEMR Document' }] }]
4634 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4635 date: '2021-09-19T03:15:56+00:00'
4637 content: [{ attachment: { contentType: image/gif, url: 'https://localhost:9300/apis/default/fhir/Binary/7' }, format: { system: 'http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem', code: 'urn:ihe:iti:xds:2017:mimeTypeSufficient', display: 'mimeType Sufficient' } }]
4639 $ref: '#/components/responses/badrequest'
4641 $ref: '#/components/responses/unauthorized'
4643 $ref: '#/components/responses/uuidnotfound'
4647 '/fhir/Binary/{id}':
4651 description: 'Used for downloading binary documents generated either with BULK FHIR Export or with the $docref CCD export operation. Documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4656 description: 'The id for the Document.'
4662 description: 'The documentation for working with BULK FHIR or $docref document exports can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4664 $ref: '#/components/responses/badrequest'
4666 $ref: '#/components/responses/unauthorized'
4674 description: 'Returns a list of Encounter resources.'
4679 description: 'The uuid for the Encounter resource.'
4686 description: 'The uuid for the patient.'
4693 description: 'The datetime of the Encounter resource.'
4699 description: 'Standard Response'
4704 'json object': { description: 'FHIR Json object.', type: object }
4707 meta: { lastUpdated: '2021-09-14T09:13:51' }
4708 resourceType: Bundle
4711 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Encounter' }]
4713 $ref: '#/components/responses/badrequest'
4715 $ref: '#/components/responses/unauthorized'
4719 '/fhir/Encounter/{uuid}':
4723 description: 'Returns a single Encounter resource.'
4728 description: 'The uuid for the Encounter resource.'
4734 description: 'Standard Response'
4739 'json object': { description: 'FHIR Json object.', type: object }
4742 id: 946da61d-6b95-4f8e-abe5-534a25913b71
4743 meta: { versionId: '1', lastUpdated: '2021-09-19T06:27:41+00:00' }
4744 resourceType: Encounter
4745 identifier: [{ system: 'urn:ietf:rfc:3986', value: 946da61d-6b95-4f8e-abe5-534a25913b71 }]
4747 class: { system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode', code: AMB, display: ambulatory }
4748 type: [{ coding: [{ system: 'http://snomed.info/sct', code: '185349003', display: 'Encounter for check up (procedure)' }] }]
4749 subject: { reference: Patient/946da61b-626b-4f88-81e2-adfb88f4f0fe, type: Patient }
4750 participant: [{ type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v3-ParticipationType', code: PPRF, display: 'Primary Performer' }] }], period: { start: '2012-08-13T00:00:00+00:00' }, individual: { reference: Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b, type: Practitioner } }]
4751 period: { start: '2012-08-13T00:00:00+00:00' }
4753 $ref: '#/components/responses/badrequest'
4755 $ref: '#/components/responses/unauthorized'
4757 $ref: '#/components/responses/uuidnotfound'
4765 description: 'Returns a list of Condition resources.'
4770 description: 'The uuid for the Goal resource.'
4777 description: 'The uuid for the patient.'
4783 description: 'Standard Response'
4788 'json object': { description: 'FHIR Json object.', type: object }
4791 meta: { lastUpdated: '2021-09-14T09:13:51' }
4792 resourceType: Bundle
4795 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Goal' }]
4797 $ref: '#/components/responses/badrequest'
4799 $ref: '#/components/responses/unauthorized'
4803 '/fhir/Goal/{uuid}':
4807 description: 'Returns a single Goal resource.'
4812 description: 'The uuid for the Goal resource.'
4818 description: 'Standard Response'
4823 'json object': { description: 'FHIR Json object.', type: object }
4826 id: 946da61d-6b88-4d54-bdd6-4029e2ad9e3f_1
4827 meta: { versionId: '1', lastUpdated: '2021-09-19T06:45:58+00:00' }
4829 lifecycleStatus: active
4830 description: { text: 'Eating more vegetables.' }
4831 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4832 target: [{ measure: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }, detailString: 'Eating more vegetables.', dueDate: '2021-09-09' }]
4834 $ref: '#/components/responses/badrequest'
4836 $ref: '#/components/responses/unauthorized'
4838 $ref: '#/components/responses/uuidnotfound'
4846 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4851 description: 'The uuid for the Group resource.'
4858 description: 'The uuid for the patient.'
4864 description: 'Standard Response'
4869 'json object': { description: 'FHIR Json object.', type: object }
4872 meta: { lastUpdated: '2021-09-14T09:13:51' }
4873 resourceType: Bundle
4876 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Group' }]
4878 $ref: '#/components/responses/badrequest'
4880 $ref: '#/components/responses/unauthorized'
4884 '/fhir/Group/{uuid}':
4888 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4893 description: 'The uuid for the Group resource.'
4899 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4901 $ref: '#/components/responses/badrequest'
4903 $ref: '#/components/responses/unauthorized'
4905 $ref: '#/components/responses/uuidnotfound'
4909 '/fhir/Group/{id}/$export':
4913 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4918 description: 'The id for the Group resource.'
4924 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
4926 $ref: '#/components/responses/badrequest'
4928 $ref: '#/components/responses/unauthorized'
4936 description: 'Returns a list of Immunization resources.'
4941 description: 'The uuid for the Immunization resource.'
4948 description: 'The uuid for the patient.'
4954 description: 'Standard Response'
4959 'json object': { description: 'FHIR Json object.', type: object }
4962 meta: { lastUpdated: '2021-09-14T09:13:51' }
4963 resourceType: Bundle
4966 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Immunization' }]
4968 $ref: '#/components/responses/badrequest'
4970 $ref: '#/components/responses/unauthorized'
4974 '/fhir/Immunization/{uuid}':
4978 description: 'Returns a single Immunization resource.'
4983 description: 'The uuid for the Immunization resource.'
4989 description: 'Standard Response'
4994 'json object': { description: 'FHIR Json object.', type: object }
4997 id: 95e8d8b7-e3e2-4e03-8eb1-31e1d9097d8f
4998 meta: { versionId: '1', lastUpdated: '2022-03-26T05:42:59+00:00' }
4999 resourceType: Immunization
5001 vaccineCode: { coding: [{ system: 'http://hl7.org/fhir/sid/cvx', code: '207', display: 'SARS-COV-2 (COVID-19) vaccine, mRNA, spike protein, LNP, preservative free, 100 mcg/0.5mL dose' }] }
5002 patient: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf }
5003 occurrenceDateTime: '2022-03-26T05:35:00+00:00'
5004 recorded: '2022-03-26T05:42:26+00:00'
5005 primarySource: false
5007 $ref: '#/components/responses/badrequest'
5009 $ref: '#/components/responses/unauthorized'
5011 $ref: '#/components/responses/uuidnotfound'
5019 description: 'Returns a list of Location resources.'
5024 description: 'The uuid for the Location resource.'
5030 description: 'Standard Response'
5035 'json object': { description: 'FHIR Json object.', type: object }
5038 meta: { lastUpdated: '2021-09-14T09:13:51' }
5039 resourceType: Bundle
5042 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Location' }]
5044 $ref: '#/components/responses/badrequest'
5046 $ref: '#/components/responses/unauthorized'
5050 '/fhir/Location/{uuid}':
5054 description: 'Returns a single Location resource.'
5059 description: 'The uuid for the Location resource.'
5065 description: 'Standard Response'
5070 'json object': { description: 'FHIR Json object.', type: object }
5073 id: 946da61d-c4f2-4f03-a2a7-b571f6a24b65
5074 meta: { versionId: '1', lastUpdated: '2021-09-19T08:14:58+00:00' }
5075 resourceType: Location
5077 name: 'Your Clinic Name Here'
5078 telecom: [{ system: phone, value: 000-000-0000 }, { system: fax, value: 000-000-0000 }]
5080 $ref: '#/components/responses/badrequest'
5082 $ref: '#/components/responses/unauthorized'
5084 $ref: '#/components/responses/uuidnotfound'
5092 description: 'Returns a list of Medication resources.'
5095 description: 'Standard Response'
5100 'json object': { description: 'FHIR Json object.', type: object }
5103 meta: { lastUpdated: '2021-09-14T09:13:51' }
5104 resourceType: Bundle
5107 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Medication' }]
5109 $ref: '#/components/responses/badrequest'
5111 $ref: '#/components/responses/unauthorized'
5115 '/fhir/Medication/{uuid}':
5119 description: 'Returns a single Medication resource.'
5124 description: 'The uuid for the Medication resource.'
5130 description: 'Standard Response'
5135 'json object': { description: 'FHIR Json object.', type: object }
5138 id: 961aa334-9348-4145-8252-de665e3c4afa
5139 meta: { versionId: '1', lastUpdated: '2022-04-19T23:42:14+00:00' }
5140 resourceType: Medication
5141 code: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: 153165 }] }
5143 batch: { lotNumber: '132', expirationDate: '0000-00-00' }
5145 $ref: '#/components/responses/badrequest'
5147 $ref: '#/components/responses/unauthorized'
5149 $ref: '#/components/responses/uuidnotfound'
5153 /fhir/MedicationRequest:
5157 description: 'Returns a list of MedicationRequest resources.'
5162 description: 'The uuid for the MedicationRequest resource.'
5169 description: 'The uuid for the patient.'
5176 description: 'The intent of the MedicationRequest resource.'
5183 description: 'The status of the MedicationRequest resource.'
5189 description: 'Standard Response'
5194 'json object': { description: 'FHIR Json object.', type: object }
5197 meta: { lastUpdated: '2021-09-14T09:13:51' }
5198 resourceType: Bundle
5201 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/MedicationRequest' }]
5203 $ref: '#/components/responses/badrequest'
5205 $ref: '#/components/responses/unauthorized'
5209 '/fhir/MedicationRequest/{uuid}':
5213 description: 'Returns a single MedicationRequest resource.'
5218 description: 'The uuid for the MedicationRequest resource.'
5224 description: 'Standard Response'
5229 'json object': { description: 'FHIR Json object.', type: object }
5232 id: 946da61d-9cff-4416-8d27-805f19f9d7d8
5233 meta: { versionId: '1', lastUpdated: '2021-09-20T04:03:14+00:00' }
5234 resourceType: MedicationRequest
5237 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/medicationrequest-category', code: community, display: Home/Community }] }]
5238 reportedBoolean: false
5239 medicationCodeableConcept: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: '1738139', display: 'Acetaminophen 325 MG Oral Tablet' }] }
5240 subject: { reference: Patient/946da617-1a4a-4b2c-ae66-93b84377cb1e, type: Patient }
5241 authoredOn: '2021-09-18T00:00:00+00:00'
5242 requester: { reference: Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b, type: Practitioner }
5244 $ref: '#/components/responses/badrequest'
5246 $ref: '#/components/responses/unauthorized'
5248 $ref: '#/components/responses/uuidnotfound'
5256 description: 'Returns a list of Observation resources.'
5261 description: 'The uuid for the Observation resource.'
5268 description: 'The uuid for the patient.'
5275 description: 'The code of the Observation resource.'
5282 description: 'The category of the Observation resource.'
5289 description: 'The datetime of the Observation resource.'
5295 description: 'Standard Response'
5300 'json object': { description: 'FHIR Json object.', type: object }
5303 meta: { lastUpdated: '2021-09-14T09:13:51' }
5304 resourceType: Bundle
5307 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Observation' }]
5309 $ref: '#/components/responses/badrequest'
5311 $ref: '#/components/responses/unauthorized'
5315 '/fhir/Observation/{uuid}':
5319 description: 'Returns a single Observation resource.'
5324 description: 'The uuid for the Observation resource.'
5330 description: 'Standard Response'
5335 'json object': { description: 'FHIR Json object.', type: object }
5338 id: 946da61e-0597-485e-9dfd-a87205ea56b3
5339 meta: { versionId: '1', lastUpdated: '2021-09-20T04:12:16+00:00' }
5340 resourceType: Observation
5342 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/observation-category', code: vital-signs }] }]
5343 code: { coding: [{ system: 'http://loinc.org', code: 85354-9, display: 'Blood pressure systolic and diastolic' }] }
5344 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
5345 effectiveDateTime: '2015-08-31T00:00:00+00:00'
5346 component: [{ code: { coding: [{ system: 'http://loinc.org', code: 8480-6, display: 'Systolic blood pressure' }] }, valueQuantity: { value: 122, unit: 'mm[Hg]', system: 'http://unitsofmeasure.org', code: 'mm[Hg]' } }, { code: { coding: [{ system: 'http://loinc.org', code: 8462-4, display: 'Diastolic blood pressure' }] }, valueQuantity: { value: 77, unit: 'mm[Hg]', system: 'http://unitsofmeasure.org', code: 'mm[Hg]' } }]
5348 $ref: '#/components/responses/badrequest'
5350 $ref: '#/components/responses/unauthorized'
5352 $ref: '#/components/responses/uuidnotfound'
5360 description: 'Returns a list of Organization resources.'
5365 description: 'The uuid for the Organization resource.'
5372 description: 'The name of the Organization resource.'
5379 description: 'The email of the Organization resource.'
5386 description: 'The phone of the Organization resource.'
5393 description: 'The telecom of the Organization resource.'
5400 description: 'The address of the Organization resource.'
5407 description: 'The address-city of the Organization resource.'
5412 name: address-postalcode
5414 description: 'The address-postalcode of the Organization resource.'
5421 description: 'The address-state of the Organization resource.'
5427 description: 'Standard Response'
5432 'json object': { description: 'FHIR Json object.', type: object }
5435 meta: { lastUpdated: '2021-09-14T09:13:51' }
5436 resourceType: Bundle
5439 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Organization' }]
5441 $ref: '#/components/responses/badrequest'
5443 $ref: '#/components/responses/unauthorized'
5450 description: 'Adds a Organization resource.'
5456 description: 'The json object for the Organization resource.'
5459 id: 95f0e672-be37-4c73-95c9-649c2d200018
5462 lastUpdated: '2022-03-30T07:43:23+00:00'
5463 resourceType: Organization
5466 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5469 system: 'http://hl7.org/fhir/sid/us-npi'
5474 coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5475 name: 'Your Clinic Name Here Hey'
5489 description: 'Standard Response'
5494 'json object': { description: 'FHIR Json object.', type: object }
5497 id: 95f0e672-be37-4c73-95c9-649c2d200018
5498 meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5499 resourceType: Organization
5500 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5501 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5503 type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5504 name: 'Your Clinic Name Here Now'
5505 telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5508 $ref: '#/components/responses/badrequest'
5510 $ref: '#/components/responses/unauthorized'
5514 '/fhir/Organization/{uuid}':
5518 description: 'Returns a single Organization resource.'
5523 description: 'The uuid for the Organization resource.'
5529 description: 'Standard Response'
5534 'json object': { description: 'FHIR Json object.', type: object }
5537 id: 95f0e672-be37-4c73-95c9-649c2d200018
5538 meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5539 resourceType: Organization
5540 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5541 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5543 type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5544 name: 'Your Clinic Name Here'
5545 telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5548 $ref: '#/components/responses/badrequest'
5550 $ref: '#/components/responses/unauthorized'
5552 $ref: '#/components/responses/uuidnotfound'
5559 description: 'Modifies a Organization resource.'
5564 description: 'The uuid for the organization.'
5573 description: 'The json object for the Organization resource.'
5576 id: 95f0e672-be37-4c73-95c9-649c2d200018
5579 lastUpdated: '2022-03-30T07:43:23+00:00'
5580 resourceType: Organization
5583 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5586 system: 'http://hl7.org/fhir/sid/us-npi'
5591 coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5592 name: 'Your Clinic Name Here'
5606 description: 'Standard Response'
5612 uuid: 95f217c1-258c-44ca-bf11-909dce369574
5614 $ref: '#/components/responses/badrequest'
5616 $ref: '#/components/responses/unauthorized'
5624 description: 'Returns a list of Patient resources.'
5629 description: 'The uuid for the Patient resource.'
5636 description: 'The identifier of the Patient resource.'
5643 description: 'The name of the Patient resource.'
5650 description: 'The birthdate of the Patient resource.'
5657 description: 'The gender of the Patient resource.'
5664 description: 'The address of the Patient resource.'
5671 description: 'The address-city of the Patient resource.'
5676 name: address-postalcode
5678 description: 'The address-postalcode of the Patient resource.'
5685 description: 'The address-state of the Patient resource.'
5692 description: 'The email of the Patient resource.'
5699 description: 'The family name of the Patient resource.'
5706 description: 'The given name of the Patient resource.'
5713 description: 'The phone number of the Patient resource.'
5720 description: 'The fax number of the Patient resource.'
5725 $ref: '#/components/parameters/_lastUpdated'
5728 description: 'Standard Response'
5733 'json object': { description: 'FHIR Json object.', type: object }
5736 meta: { lastUpdated: '2021-09-14T09:13:51' }
5737 resourceType: Bundle
5740 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Patient' }]
5742 $ref: '#/components/responses/badrequest'
5744 $ref: '#/components/responses/unauthorized'
5751 description: 'Adds a Patient resource.'
5757 description: 'The json object for the Patient resource.'
5760 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5763 lastUpdated: '2022-03-31T02:48:28+00:00'
5764 resourceType: Patient
5767 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5771 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5773 extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5774 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5778 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5779 system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5788 birthDate: '2017-03-10'
5791 language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5794 description: 'Standard Response'
5799 'json object': { description: 'FHIR Json object.', type: object }
5802 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5803 meta: { versionId: '1', lastUpdated: '2022-03-31T02:48:28+00:00' }
5804 resourceType: Patient
5805 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>' }
5806 extension: [{ valueCode: F, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex' }, { extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }], url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race' }]
5807 identifier: [{ use: official, type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }, system: 'http://terminology.hl7.org/CodeSystem/v2-0203', value: '1' }]
5809 name: [{ use: official, family: Smith, given: [Brenda] }]
5811 birthDate: '2017-03-10'
5812 communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5814 $ref: '#/components/responses/badrequest'
5816 $ref: '#/components/responses/unauthorized'
5820 '/fhir/Patient/{uuid}':
5824 description: 'Returns a single Patient resource.'
5829 description: 'The uuid for the Patient resource.'
5835 description: 'Standard Response'
5840 'json object': { description: 'FHIR Json object.', type: object }
5843 id: 946da617-1a4a-4b2c-ae66-93b84377cb1e
5844 meta: { versionId: '1', lastUpdated: '2021-09-21T17:08:03+00:00' }
5845 resourceType: Patient
5846 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Aurore252 Von197</p></div>' }
5847 extension: [{ valueCode: F, url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex' }, { extension: [{ valueCoding: { system: 'urn:oid:2.16.840.1.113883.6.238', code: 1006-6, display: Abenaki }, url: ombCategory }, { valueString: Abenaki, url: text }], url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race' }, { extension: [{ valueString: 'Declined To Specify', url: text }], url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity' }]
5848 identifier: [{ use: official, type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }, system: 'http://terminology.hl7.org/CodeSystem/v2-0203', value: '1' }]
5850 name: [{ use: official, family: Von197, given: [Aurore252] }]
5852 birthDate: '1970-07-03'
5853 address: [{ line: ['245 Crona Wall'], city: Boston, state: Massachusetts, postalCode: '02215', period: { start: '2020-09-21T17:08:03.532+00:00' } }]
5854 communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5856 $ref: '#/components/responses/badrequest'
5858 $ref: '#/components/responses/unauthorized'
5860 $ref: '#/components/responses/uuidnotfound'
5867 description: 'Modifies a Patient resource.'
5872 description: 'The uuid for the Patient resource.'
5881 description: 'The json object for the Patient resource.'
5884 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5887 lastUpdated: '2022-03-31T02:48:28+00:00'
5888 resourceType: Patient
5891 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5895 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5897 extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5898 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5902 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5903 system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5912 birthDate: '2017-03-10'
5915 language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5918 description: 'Standard Response'
5924 uuid: 95f2ad04-5834-4243-8838-e396a7faadbf
5926 $ref: '#/components/responses/badrequest'
5928 $ref: '#/components/responses/unauthorized'
5932 /fhir/Patient/$export:
5936 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
5939 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
5941 $ref: '#/components/responses/badrequest'
5943 $ref: '#/components/responses/unauthorized'
5951 description: 'Returns a list of Person resources.'
5956 description: 'The name of the Person resource.'
5963 description: 'The active status of the Person resource.'
5970 description: 'The address of the Person resource.'
5977 description: 'The address-city of the Person resource.'
5982 name: address-postalcode
5984 description: 'The address-postalcode of the Person resource.'
5991 description: 'The address-state of the Person resource.'
5998 description: 'The email of the Person resource.'
6005 description: 'The family name of the Person resource.'
6012 description: 'The given name of the Person resource.'
6019 description: 'The phone number of the Person resource.'
6026 description: 'The fax number of the Person resource.'
6032 description: 'Standard Response'
6037 'json object': { description: 'FHIR Json object.', type: object }
6040 meta: { lastUpdated: '2021-09-14T09:13:51' }
6041 resourceType: Bundle
6044 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Person' }]
6046 $ref: '#/components/responses/badrequest'
6048 $ref: '#/components/responses/unauthorized'
6052 '/fhir/Person/{uuid}':
6056 description: 'Returns a single Person resource.'
6061 description: 'The uuid for the Person resource.'
6067 description: 'Standard Response'
6072 'json object': { description: 'FHIR Json object.', type: object }
6075 id: 960c7cd6-187a-4119-8cd4-85389d80efb9
6076 meta: { versionId: '1', lastUpdated: '2022-04-13T08:57:32+00:00' }
6077 resourceType: Person
6078 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Administrator Administrator</p></div>' }
6079 name: [{ use: official, family: Administrator, given: [Administrator, Larry] }]
6080 telecom: [{ system: phone, value: '1234567890', use: home }, { system: phone, value: '1234567890', use: work }, { system: phone, value: '1234567890', use: mobile }, { system: email, value: hey@hey.com, use: home }]
6081 address: [{ line: ['123 Lane Street'], city: Bellevue, state: WA, period: { start: '2021-04-13T08:57:32.146+00:00' } }]
6084 $ref: '#/components/responses/badrequest'
6086 $ref: '#/components/responses/unauthorized'
6088 $ref: '#/components/responses/uuidnotfound'
6096 description: 'Returns a list of Practitioner resources.'
6101 description: 'The uuid for the Practitioner resource.'
6108 description: 'The name of the Practitioner resource.'
6115 description: 'The active status of the Practitioner resource.'
6122 description: 'The address of the Practitioner resource.'
6129 description: 'The address-city of the Practitioner resource.'
6134 name: address-postalcode
6136 description: 'The address-postalcode of the Practitioner resource.'
6143 description: 'The address-state of the Practitioner resource.'
6150 description: 'The email of the Practitioner resource.'
6157 description: 'The family name of the Practitioner resource.'
6164 description: 'The given name of the Practitioner resource.'
6171 description: 'The phone number of the Practitioner resource.'
6178 description: 'The fax number of the Practitioner resource.'
6184 description: 'Standard Response'
6189 'json object': { description: 'FHIR Json object.', type: object }
6192 meta: { lastUpdated: '2021-09-14T09:13:51' }
6193 resourceType: Bundle
6196 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Practitioner' }]
6198 $ref: '#/components/responses/badrequest'
6200 $ref: '#/components/responses/unauthorized'
6207 description: 'Adds a Practitioner resources.'
6213 description: 'The json object for the Practitioner resource.'
6216 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6219 lastUpdated: '2021-09-21T17:41:57+00:00'
6220 resourceType: Practitioner
6223 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
6226 system: 'http://hl7.org/fhir/sid/us-npi'
6227 value: '11223344554543'
6236 description: 'Standard Response'
6241 'json object': { description: 'FHIR Json object.', type: object }
6244 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6245 meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
6246 resourceType: Practitioner
6247 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
6248 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
6250 name: [{ use: official, family: Smith, given: [Danny] }]
6252 $ref: '#/components/responses/badrequest'
6254 $ref: '#/components/responses/unauthorized'
6258 '/fhir/Practitioner/{uuid}':
6262 description: 'Returns a single Practitioner resource.'
6267 description: 'The uuid for the Practitioner resource.'
6273 description: 'Standard Response'
6278 'json object': { description: 'FHIR Json object.', type: object }
6281 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6282 meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
6283 resourceType: Practitioner
6284 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
6285 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
6287 name: [{ use: official, family: Smith, given: [Billy] }]
6289 $ref: '#/components/responses/badrequest'
6291 $ref: '#/components/responses/unauthorized'
6293 $ref: '#/components/responses/uuidnotfound'
6300 description: 'Modify a Practitioner resource.'
6305 description: 'The uuid for the Practitioner resource.'
6314 description: 'The json object for the Practitioner resource.'
6317 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6320 lastUpdated: '2021-09-21T17:41:57+00:00'
6321 resourceType: Practitioner
6324 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
6327 system: 'http://hl7.org/fhir/sid/us-npi'
6328 value: '11223344554543'
6337 description: 'Standard Response'
6343 uuid: 95f294d7-e14c-441d-81a6-309fe369ee21
6345 $ref: '#/components/responses/badrequest'
6347 $ref: '#/components/responses/unauthorized'
6351 /fhir/PractitionerRole:
6355 description: 'Returns a list of PractitionerRole resources.'
6360 description: 'The specialty of the PractitionerRole resource.'
6367 description: 'The practitioner of the PractitionerRole resource.'
6373 description: 'Standard Response'
6378 'json object': { description: 'FHIR Json object.', type: object }
6381 meta: { lastUpdated: '2021-09-14T09:13:51' }
6382 resourceType: Bundle
6385 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/PractitionerRole' }]
6387 $ref: '#/components/responses/badrequest'
6389 $ref: '#/components/responses/unauthorized'
6393 '/fhir/PractitionerRole/{uuid}':
6397 description: 'Returns a single PractitionerRole resource.'
6402 description: 'The uuid for the PractitionerRole resource.'
6408 description: 'Standard Response'
6413 'json object': { description: 'FHIR Json object.', type: object }
6416 id: 960c806f-9463-482e-b228-67b5be1fed55
6417 meta: { versionId: '1', lastUpdated: '2022-04-13T06:18:17+00:00' }
6418 resourceType: PractitionerRole
6419 practitioner: { reference: Practitioner/960c7cd6-187a-4119-8cd4-85389d80efb9, display: 'Administrator Administrator' }
6420 organization: { reference: Organization/960c7cc6-b4ae-49bc-877b-1a2913271c43, display: 'Your Clinic Name Here' }
6421 code: [{ coding: [102L00000X], text: Psychoanalyst }, { coding: [101Y00000X], text: Counselor }]
6423 $ref: '#/components/responses/badrequest'
6425 $ref: '#/components/responses/unauthorized'
6427 $ref: '#/components/responses/uuidnotfound'
6435 description: 'Returns a list of Procedure resources.'
6440 description: 'The uuid for the Procedure resource.'
6447 description: 'The uuid for the patient.'
6454 description: 'The datetime of the Procedure resource.'
6460 description: 'Standard Response'
6465 'json object': { description: 'FHIR Json object.', type: object }
6468 meta: { lastUpdated: '2021-09-14T09:13:51' }
6469 resourceType: Bundle
6472 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Procedure' }]
6474 $ref: '#/components/responses/badrequest'
6476 $ref: '#/components/responses/unauthorized'
6480 '/fhir/Procedure/{uuid}':
6484 description: 'Returns a single Procedure resource.'
6489 description: 'The uuid for the Procedure resource.'
6495 description: 'Standard Response'
6500 'json object': { description: 'FHIR Json object.', type: object }
6503 id: 95e9d3fb-fe7b-448a-aa60-d40b11b486a5
6504 meta: { versionId: '1', lastUpdated: '2022-03-26T17:20:14+00:00' }
6505 resourceType: Procedure
6507 subject: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf, type: Patient }
6509 $ref: '#/components/responses/badrequest'
6511 $ref: '#/components/responses/unauthorized'
6513 $ref: '#/components/responses/uuidnotfound'
6517 '/fhir/Provenance/{uuid}':
6521 description: 'Returns a single Provenance resource.'
6526 description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6532 description: 'Standard Response'
6537 'json object': { description: 'FHIR Json object.', type: object }
6540 id: 'AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145'
6541 resourceType: Provenance
6542 target: [{ reference: AllergyIntolerance/95ea43f3-1066-4bc7-b224-6c23b985f145, type: AllergyIntolerance }]
6543 recorded: '2022-03-26T22:43:30+00:00'
6544 agent: { '0': { type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/provenance-participant-type', code: author, display: Author }] }, who: { reference: Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7, type: Organization }, onBehalfOf: { reference: Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7, type: Organization } }, '1': { type: { coding: [{ system: 'http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type', code: transmitter, display: Transmitter }] } }, who: { reference: Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7, type: Organization }, onBehalfOf: { reference: Organization/95e8d810-7e55-44aa-bb48-fecd5b0d88c7, type: Organization } }
6546 $ref: '#/components/responses/badrequest'
6548 $ref: '#/components/responses/unauthorized'
6550 $ref: '#/components/responses/uuidnotfound'
6558 description: 'Returns a list of Provenance resources.'
6563 description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6569 description: 'Standard Response'
6574 'json object': { description: 'FHIR Json object.', type: object }
6577 meta: { lastUpdated: '2021-09-14T09:13:51' }
6578 resourceType: Bundle
6581 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Provenance' }]
6583 $ref: '#/components/responses/badrequest'
6585 $ref: '#/components/responses/unauthorized'
6593 description: 'Returns a list of ValueSet resources.'
6598 description: 'The uuid for the ValueSet resource.'
6604 description: 'Standard Response'
6609 'json object': { description: 'FHIR Json object.', type: object }
6612 meta: { lastUpdated: '2021-09-14T09:13:51' }
6613 resourceType: Bundle
6616 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/ValueSet' }]
6618 $ref: '#/components/responses/badrequest'
6620 $ref: '#/components/responses/unauthorized'
6624 '/fhir/ValueSet/{uuid}':
6628 description: 'Returns a single ValueSet resource.'
6633 description: 'The uuid for the ValueSet resource.'
6639 description: 'Standard Response'
6644 'json object': { description: 'FHIR Json object.', type: object }
6647 resourceType: ValueSet
6648 id: appointment-type
6649 compose: { include: [{ concept: [{ code: no_show, display: 'No Show' }, { code: office_visit, display: 'Office Visit' }, { code: established_patient, display: 'Established Patient' }, { code: new_patient, display: 'New Patient' }, { code: health_and_behavioral_assessment, display: 'Health and Behavioral Assessment' }, { code: preventive_care_services, display: 'Preventive Care Services' }, { code: ophthalmological_services, display: 'Ophthalmological Services' }] }] }
6651 $ref: '#/components/responses/badrequest'
6653 $ref: '#/components/responses/unauthorized'
6655 $ref: '#/components/responses/uuidnotfound'
6663 description: 'Returns metadata (ie. CapabilityStatement resource) of the fhir server.'
6666 description: 'Return CapabilityStatement resource of the fhir server'
6667 /fhir/.well-known/smart-configuration:
6671 description: 'Returns smart configuration of the fhir server.'
6674 description: 'Return smart configuration of the fhir server'
6675 /fhir/OperationDefinition:
6679 description: 'Returns a list of the OperationDefinition resources that are specific to this OpenEMR installation'
6682 description: 'Return list of OperationDefinition resources'
6683 '/fhir/OperationDefinition/{operation}':
6687 description: 'Returns a single OperationDefinition resource that is specific to this OpenEMR installation'
6692 description: 'The name of the operation to query. For example $bulkdata-status'
6698 description: 'Standard Response'
6703 'json object': { description: 'FHIR Json object.', type: object }
6706 resourceType: OperationDefinition
6707 name: $bulkdata-status
6710 parameter: [{ name: job, use: in, min: 1, max: 1, type: { system: 'http://hl7.org/fhir/data-types', code: string, display: string }, searchType: { system: 'http://hl7.org/fhir/ValueSet/search-param-type', code: string, display: string } }]
6715 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6718 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6720 $ref: '#/components/responses/badrequest'
6722 $ref: '#/components/responses/unauthorized'
6726 /fhir/$bulkdata-status:
6730 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6733 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6735 $ref: '#/components/responses/badrequest'
6737 $ref: '#/components/responses/unauthorized'
6744 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6747 description: 'The BULK FHIR Exports documentation can be found at <a href=''https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'' target=''_blank'' rel=''noopener''>https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API</a>'
6749 $ref: '#/components/responses/badrequest'
6751 $ref: '#/components/responses/unauthorized'
6759 description: 'Returns the patient.'
6762 description: 'Standard response'
6766 $ref: '#/components/schemas/api_patient_response'
6768 $ref: '#/components/responses/unauthorized'
6772 /portal/patient/encounter:
6776 description: 'Returns encounters for the patient.'
6779 $ref: '#/components/responses/standard'
6781 $ref: '#/components/responses/badrequest'
6783 $ref: '#/components/responses/unauthorized'
6787 '/portal/patient/encounter/{euuid}':
6791 description: 'Returns a selected encounter by its uuid.'
6796 description: 'The uuid for the encounter.'
6802 $ref: '#/components/responses/standard'
6804 $ref: '#/components/responses/badrequest'
6806 $ref: '#/components/responses/unauthorized'
6810 /portal/patient/appointment:
6814 description: 'Retrieves all appointments for a patient'
6817 $ref: '#/components/responses/standard'
6819 $ref: '#/components/responses/badrequest'
6821 $ref: '#/components/responses/unauthorized'
6825 '/portal/patient/appointment/{auuid}':
6829 description: 'Returns a selected appointment by its uuid.'
6834 description: 'The uuid for the appointment.'
6840 $ref: '#/components/responses/standard'
6842 $ref: '#/components/responses/badrequest'
6844 $ref: '#/components/responses/unauthorized'
6850 api_patient_request:
6851 description: 'Schema for the patient request'
6859 description: 'The title of patient.'
6862 description: 'The fname of patient.'
6865 description: 'The mname of patient.'
6868 description: 'The lname of patient.'
6871 description: 'The street address of patient.'
6874 description: 'The postal code of patient.'
6877 description: 'The city of patient.'
6880 description: 'The state of patient.'
6883 description: 'The country code of patient.'
6886 description: 'The phone contact of patient.'
6889 description: 'The DOB of patient.'
6892 description: 'The lname of patient.'
6895 description: 'The race of patient.'
6898 description: 'The ethnicity of patient.'
6906 street: '456 Tree Lane'
6907 postal_code: '08642'
6911 phone_contact: 123-456-7890
6916 api_patient_response:
6917 description: 'Schema for the patient response'
6920 description: 'Validation errors.'
6925 description: 'Internal errors.'
6930 description: 'Returned data.'
6935 description: 'patient id'
6938 description: 'patient pid'
6941 description: 'patient public id'
6944 description: 'patient title'
6947 description: 'patient first name'
6950 description: 'patient middle name'
6953 description: 'patient last name'
6956 description: 'patient social security number'
6959 description: 'patient street address'
6962 description: 'patient postal code'
6965 description: 'patient city'
6968 description: 'patient state'
6971 description: 'patient county'
6974 description: 'patient country code'
6977 description: 'patient drivers license id'
6979 contact_relationship:
6980 description: 'patient contact relationship'
6983 description: 'patient phone contact'
6986 description: 'patient home phone'
6989 description: 'patient work phone'
6992 description: 'patient mobile phone'
6995 description: 'patient email'
6998 description: 'patient DOB'
7001 description: 'patient sex (gender)'
7004 description: 'patient race'
7007 description: 'patient ethnicity'
7010 description: 'patient status'
7015 validationErrors: []
7016 error_description: []
7026 street: '456 Tree Lane'
7027 postal_code: '08642'
7033 contact_relationship: ''
7034 phone_contact: 123-456-7890
7044 api_encounter_request:
7045 description: 'Schema for the encounter request'
7051 description: 'The date of encounter.'
7054 description: 'The onset date of encounter.'
7057 description: 'The reason of encounter.'
7060 description: 'The facility of encounter.'
7063 description: 'The pc_catid of encounter.'
7066 description: 'The facility id of encounter.'
7069 description: 'The billing facility id of encounter.'
7072 description: 'The sensitivity of encounter.'
7075 description: 'The referral source of encounter.'
7078 description: 'The pos_code of encounter.'
7081 description: 'The external id of encounter.'
7084 description: 'The provider id of encounter.'
7087 description: 'The class_code of encounter.'
7093 reason: 'Pregnancy Test'
7094 facility: 'Owerri General Hospital'
7097 billing_facility: '3'
7104 api_encounter_response:
7105 description: 'Schema for the encounter response'
7108 description: 'Validation errors.'
7113 description: 'Internal errors.'
7118 description: 'Returned data.'
7123 description: 'encounter id'
7126 description: 'encounter uuid'
7129 description: 'encounter date'
7132 description: 'encounter reason'
7135 description: 'encounter facility name'
7138 description: 'encounter facility id name'
7141 description: 'encounter for patient pid'
7144 description: 'encounter onset date'
7147 description: 'encounter sensitivity'
7150 description: 'encounter billing note'
7153 description: 'encounter pc_catid'
7156 description: 'encounter last_level_billed'
7159 description: 'encounter last_level_closed'
7162 description: 'encounter last_stmt_date'
7165 description: 'encounter stmt_count'
7168 description: 'provider id'
7171 description: 'encounter supervisor id'
7174 description: 'encounter invoice_refno'
7177 description: 'encounter referral source'
7180 description: 'encounter billing facility id'
7183 description: 'encounter external id'
7186 description: 'encounter pos_code'
7189 description: 'encounter class_code'
7192 description: 'encounter class_title'
7195 description: 'encounter pc_catname'
7197 billing_facility_name:
7198 description: 'encounter billing facility name'
7203 validationErrors: []
7204 error_description: []
7207 uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef
7208 date: '2019-09-14 00:00:00'
7209 reason: 'Pregnancy Test'
7210 facility: 'Owerri General Hospital'
7213 onset_date: '2019-04-20 00:00:00'
7217 last_level_billed: '0'
7218 last_level_closed: '0'
7219 last_stmt_date: null
7225 billing_facility: '3'
7229 class_title: ambulatory
7230 pc_catname: 'Office Visit'
7231 billing_facility_name: 'Owerri General Hospital'
7233 description: 'Schema for the vital request'
7236 description: 'The bps of vitals.'
7239 description: 'The bpd of vitals.'
7242 description: 'The weight of vitals. (unit is lb)'
7245 description: 'The height of vitals. (unit is inches)'
7248 description: 'The temperature of temperature. (unit is F)'
7251 description: 'The temp_method of vitals.'
7254 description: 'The pulse of vitals.'
7257 description: 'The respiration of vitals.'
7260 description: 'The note (ie. comments) of vitals.'
7263 description: 'The waist circumference of vitals. (unit is inches)'
7266 description: 'The head circumference of vitals. (unit is inches)'
7269 description: 'The oxygen_saturation of vitals.'
7281 note: 'Patient with difficulty standing, which made weight measurement difficult.'
7284 oxygen_saturation: '96'
7285 api_soap_note_request:
7286 description: 'Schema for the soap_note request'
7289 description: 'The subjective of soap note.'
7292 description: 'The objective of soap note.'
7295 description: 'The assessment of soap note.'
7298 description: 'The plan of soap note.'
7302 subjective: 'The patient with mechanical fall and cut finger.'
7303 objective: 'The patient with finger laceration on exam.'
7304 assessment: 'The patient with finger laceration requiring sutures.'
7305 plan: 'Sutured finger laceration.'
7306 api_medical_problem_request:
7307 description: 'Schema for the medical_problem request'
7313 description: 'The title of medical problem.'
7316 description: 'The beginning date of medical problem.'
7319 description: 'The end date of medical problem.'
7322 description: 'The diagnosis of medical problem. In format `<codetype>:<code>`'
7326 title: Dermatochalasis
7327 begdate: '2010-10-13'
7329 diagnosis: 'ICD10:H02.839'
7330 api_allergy_request:
7331 description: 'Schema for the allergy request'
7337 description: 'The title of allergy.'
7340 description: 'The beginning date of allergy.'
7343 description: 'The end date of allergy.'
7346 description: 'The diagnosis of allergy. In format `<codetype>:<code>`'
7351 begdate: '2010-10-13'
7353 api_medication_request:
7354 description: 'Schema for the medication request'
7360 description: 'The title of medication.'
7363 description: 'The beginning date of medication.'
7366 description: 'The end date of medication.'
7369 description: 'The diagnosis of medication. In format `<codetype>:<code>`'
7374 begdate: '2013-04-13'
7376 api_surgery_request:
7377 description: 'Schema for the surgery request'
7383 description: 'The title of surgery.'
7386 description: 'The beginning date of surgery.'
7389 description: 'The end date of surgery.'
7392 description: 'The diagnosis of surgery. In format `<codetype>:<code>`'
7396 title: Blepharoplasty
7397 begdate: '2013-10-14'
7399 diagnosis: 'CPT4:15823-50'
7400 api_dental_issue_request:
7401 description: 'Schema for the dental_issue request'
7407 description: 'The title of dental issue.'
7410 description: 'The beginning date of dental issue.'
7413 description: 'The end date of dental issue.'
7416 description: 'The diagnosis of dental issue. In format `<codetype>:<code>`'
7421 begdate: '2015-03-17'
7423 api_insurance_company_request:
7424 description: 'Schema for the insurance_company request'
7429 description: 'The name of insurance company.'
7432 description: 'The attn of insurance company.'
7435 description: 'The cms id of insurance company.'
7438 description: 'The insurance type code of insurance company. The insurance type code can be found by inspecting the route at (/api/insurance_type).'
7441 description: 'The x12 receiver id of insurance company.'
7443 x12_default_partner_id:
7444 description: 'The x12 default partner id of insurance company.'
7447 description: 'The alternate cms id of insurance company.'
7450 description: 'The line1 address of insurance company.'
7453 description: 'The line2 address of insurance company.'
7456 description: 'The city of insurance company.'
7459 description: 'The state of insurance company.'
7462 description: 'The zip of insurance company.'
7465 description: 'The country of insurance company.'
7469 name: 'Cool Insurance Company'
7473 x12_receiver_id: null
7474 x12_default_partner_id: null
7476 line1: '123 Cool Lane'
7482 api_insurance_request:
7483 description: 'Schema for the insurance request'
7491 - subscriber_relationship
7495 - subscriber_postal_code
7498 - subscriber_country
7505 description: 'The insurance company id.'
7508 description: 'The plan name of insurance.'
7511 description: 'The policy number of insurance.'
7514 description: 'The group number of insurance.'
7517 description: 'The subscriber last name of insurance.'
7520 description: 'The subscriber middle name of insurance.'
7523 description: 'The subscriber first name of insurance.'
7525 subscriber_relationship:
7526 description: 'The subscriber relationship of insurance.'
7529 description: 'The subscriber ss number of insurance.'
7532 description: 'The subscriber DOB of insurance.'
7535 description: 'The subscriber street address of insurance.'
7537 subscriber_postal_code:
7538 description: 'The subscriber postal code of insurance.'
7541 description: 'The subscriber city of insurance.'
7544 description: 'The subscriber state of insurance. `state` can be found by querying `resource=/api/list/state`'
7547 description: 'The subscriber country of insurance. `country` can be found by querying `resource=/api/list/country`'
7550 description: 'The subscriber phone of insurance.'
7552 subscriber_employer:
7553 description: 'The subscriber employer of insurance.'
7555 subscriber_employer_street:
7556 description: 'The subscriber employer street of insurance.'
7558 subscriber_employer_postal_code:
7559 description: 'The subscriber employer postal code of insurance.'
7561 subscriber_employer_state:
7562 description: 'The subscriber employer state of insurance.'
7564 subscriber_employer_country:
7565 description: 'The subscriber employer country of insurance.'
7567 subscriber_employer_city:
7568 description: 'The subscriber employer city of insurance.'
7571 description: 'The copay of insurance.'
7574 description: 'The date of insurance.'
7577 description: 'The subscriber sex of insurance.'
7580 description: 'The accept_assignment of insurance.'
7583 description: 'The policy_type of insurance.'
7588 plan_name: 'Some Plan'
7589 policy_number: '12345'
7590 group_number: '252412'
7591 subscriber_lname: Tester
7592 subscriber_mname: Xi
7593 subscriber_fname: Foo
7594 subscriber_relationship: other
7595 subscriber_ss: '234231234'
7596 subscriber_DOB: '2018-10-03'
7597 subscriber_street: '183 Cool St'
7598 subscriber_postal_code: '23418'
7599 subscriber_city: Cooltown
7600 subscriber_state: AZ
7601 subscriber_country: USA
7602 subscriber_phone: 234-598-2123
7603 subscriber_employer: 'Some Employer'
7604 subscriber_employer_street: '123 Heather Lane'
7605 subscriber_employer_postal_code: '23415'
7606 subscriber_employer_state: AZ
7607 subscriber_employer_country: USA
7608 subscriber_employer_city: Cooltown
7611 subscriber_sex: Female
7612 accept_assignment: 'TRUE'
7614 api_message_request:
7615 description: 'Schema for the message request'
7625 description: 'The body of message.'
7628 description: 'The group name (usually is ''Default'').'
7631 description: 'The sender of the message.'
7634 description: 'The recipient of the message.'
7637 description: 'use an option from resource=/api/list/note_type'
7640 description: 'use an option from resource=/api/list/message_status'
7650 api_transaction_request:
7651 description: 'Schema for the transaction request'
7658 description: 'The message of the transaction.'
7661 description: 'The type of transaction. Use an option from resource=/api/transaction_type'
7664 description: 'The group name (usually is ''Default'').'
7667 description: 'NPI of the person creating the referral.'
7670 description: 'NPI of the person getting the referral.'
7673 description: 'The referral diagnosis.'
7676 description: 'The risk level. (Low, Medium, High)'
7679 description: 'Are vitals included (0,1)'
7682 description: 'The date of the referral'
7685 description: 'The authorization for the referral'
7688 description: 'The number of vists for the referral'
7691 description: 'The date the referral is valid from'
7694 description: 'The date the referral is valid through'
7701 referByNpi: '9999999999'
7702 referToNpi: '9999999999'
7703 referDiagnosis: 'Diag 1'
7706 referralDate: '2022-01-01'
7707 authorization: Auth_123
7709 validFrom: '2022-01-02'
7710 validThrough: '2022-01-03'
7714 description: 'Standard Response'
7720 description: 'Validation errors.'
7725 description: 'Internal errors.'
7730 description: 'Returned data.'
7736 validationErrors: []
7737 error_description: []
7740 description: 'Bad Request'
7746 description: 'Validation errors.'
7751 _id: 'The search field argument was invalid, improperly formatted, or could not be parsed. Inner message: UUID columns must be a valid UUID string'
7753 description: Unauthorized
7759 description: 'The error.'
7762 description: 'The description of the error.'
7765 description: 'More specific information on the error.'
7768 description: 'Message regarding the error.'
7772 error: access_denied
7773 error_description: 'The resource owner or authorization server denied the request.'
7774 hint: 'Missing "Authorization" header'
7775 message: 'The resource owner or authorization server denied the request.'
7777 description: 'Not Found'
7791 description: 'The sort criteria specified in comma separated order with Descending order being specified by a dash before the search parameter name. (Example: name,-category)'
7798 description: 'The date the resource was last updated.'
7807 authorizationUrl: /oauth2/default/authorize
7808 tokenUrl: /oauth2/default/token
7809 refreshUrl: /oauth2/default/token
7811 openid: 'Generic mandatory scope'
7812 offline_access: 'Will signal server to provide a refresh token'
7813 launch/patient: 'Will provide a patient selector when logging in as an OpenEMR user (required for testing patient/* scopes in swagger if not logging in as a patient)'
7814 'api:fhir': 'FHIR R4 API'
7815 patient/AllergyIntolerance.read: 'Read allergy intolerance resources for the current patient (api:fhir)'
7816 patient/Appointment.read: 'Read appointment resources for the current patient (api:fhir)'
7817 patient/Binary.read: 'Read binary document resources for the current patient (api:fhir)'
7818 patient/CarePlan.read: 'Read care plan resources for the current patient (api:fhir)'
7819 patient/CareTeam.read: 'Read care team resources for the current patient (api:fhir)'
7820 patient/Condition.read: 'Read condition resources for the current patient (api:fhir)'
7821 patient/Coverage.read: 'Read coverage resources for the current patient (api:fhir)'
7822 patient/Device.read: 'Read device resources for the current patient (api:fhir)'
7823 patient/DiagnosticReport.read: 'Read diagnostic report resources for the current patient (api:fhir)'
7824 patient/DocumentReference.read: 'Read document reference resources for the current patient (api:fhir)'
7825 patient/DocumentReference.$docref: 'Generate a document for the current patient or returns the most current Clinical Summary of Care Document (CCD)'
7826 patient/Encounter.read: 'Read encounter resources for the current patient (api:fhir)'
7827 patient/Goal.read: 'Read goal resources for the current patient (api:fhir)'
7828 patient/Immunization.read: 'Read immunization resources for the current patient (api:fhir)'
7829 patient/Location.read: 'Read location resources for the current patient (api:fhir)'
7830 patient/Medication.read: 'Read medication resources for the current patient (api:fhir)'
7831 patient/MedicationRequest.read: 'Read medication request resources for the current patient (api:fhir)'
7832 patient/Observation.read: 'Read observation resources for the current patient (api:fhir)'
7833 patient/Organization.read: 'Read organization resources for the current patient (api:fhir)'
7834 patient/Patient.read: 'Read patient resource for the current patient (api:fhir)'
7835 patient/Person.read: 'Read person resources for the current patient (api:fhir)'
7836 patient/Practitioner.read: 'Read practitioner resources for the current patient (api:fhir)'
7837 patient/Procedure.read: 'Read procedure resources for the current patient (api:fhir)'
7838 patient/Provenance.read: 'Read provenance resources for the current patient (api:fhir)'
7839 system/AllergyIntolerance.read: 'Read all allergy intolerance resources in the system (api:fhir)'
7840 system/Binary.read: 'Read all binary document resources in the system (api:fhir)'
7841 system/CarePlan.read: 'Read all care plan resources in the system (api:fhir)'
7842 system/CareTeam.read: 'Read all care team resources in the system (api:fhir)'
7843 system/Condition.read: 'Read all condition resources in the system (api:fhir)'
7844 system/Coverage.read: 'Read all coverage resources in the system (api:fhir)'
7845 system/Device.read: 'Read all device resources in the system (api:fhir)'
7846 system/DiagnosticReport.read: 'Read all diagnostic report resources in the system (api:fhir)'
7847 system/DocumentReference.read: 'Read all document reference resources in the system (api:fhir)'
7848 system/DocumentReference.$docref: 'Generate a document for any patient in the system or returns the most current Clinical Summary of Care Document (CCD)'
7849 system/Encounter.read: 'Read all encounter resources in the system (api:fhir)'
7850 system/Goal.read: 'Read all goal resources in the system (api:fhir)'
7851 system/Group.read: 'Read all group resources in the system (api:fhir)'
7852 system/Immunization.read: 'Read all immunization resources in the system (api:fhir)'
7853 system/Location.read: 'Read all location resources in the system (api:fhir)'
7854 system/Medication.read: 'Read all medication resources in the system (api:fhir)'
7855 system/MedicationRequest.read: 'Read all medication request resources in the system (api:fhir)'
7856 system/Observation.read: 'Read all observation resources in the system (api:fhir)'
7857 system/Organization.read: 'Read all organization resources in the system (api:fhir)'
7858 system/Patient.read: 'Read all patient resources in the system (api:fhir)'
7859 system/Person.read: 'Read all person resources in the system (api:fhir)'
7860 system/Practitioner.read: 'Read all practitioner resources in the system (api:fhir)'
7861 system/PractitionerRole.read: 'Read all practitioner role resources in the system (api:fhir)'
7862 system/Procedure.read: 'Read all procedure resources in the system (api:fhir)'
7863 system/Provenance.read: 'Read all provenance resources in the system (api:fhir)'
7864 system/ValueSet.read: 'Read all valueSet resources in the system (api:fhir)'
7865 user/AllergyIntolerance.read: 'Read all allergy intolerance resources the user has access to (api:fhir)'
7866 user/Binary.read: 'Read all binary documents the user has access to (api:fhir)'
7867 user/CarePlan.read: 'Read all care plan resources the user has access to (api:fhir)'
7868 user/CareTeam.read: 'Read all care team resources the user has access to (api:fhir)'
7869 user/Condition.read: 'Read all condition resources the user has access to (api:fhir)'
7870 user/Coverage.read: 'Read all coverage resources the user has access to (api:fhir)'
7871 user/Device.read: 'Read all device resources the user has access to (api:fhir)'
7872 user/DiagnosticReport.read: 'Read all diagnostic report resources the user has access to (api:fhir)'
7873 user/DocumentReference.read: 'Read all document reference resources the user has access to (api:fhir)'
7874 user/DocumentReference.$docref: 'Generate a document for any patient the user has access to or returns the most current Clinical Summary of Care Document (CCD) (api:fhir)'
7875 user/Encounter.read: 'Read all encounter resources the user has access to (api:fhir)'
7876 user/Goal.read: 'Read all goal resources the user has access to (api:fhir)'
7877 user/Immunization.read: 'Read all immunization resources the user has access to (api:fhir)'
7878 user/Location.read: 'Read all location resources the user has access to (api:fhir)'
7879 user/Medication.read: 'Read all medication resources the user has access to (api:fhir)'
7880 user/MedicationRequest.read: 'Read all medication request resources the user has access to (api:fhir)'
7881 user/Observation.read: 'Read all observation resources the user has access to (api:fhir)'
7882 user/Organization.read: 'Read all organization resources the user has access to (api:fhir)'
7883 user/Organization.write: 'Write all organization resources the user has access to (api:fhir)'
7884 user/Patient.read: 'Read all patient resources the user has access to (api:fhir)'
7885 user/Patient.write: 'Write all patient resources the user has access to (api:fhir)'
7886 user/Person.read: 'Read all person resources the user has access to (api:fhir)'
7887 user/Practitioner.read: 'Read all practitioner resources the user has access to (api:fhir)'
7888 user/Practitioner.write: 'Write all practitioner resources the user has access to (api:fhir)'
7889 user/PractitionerRole.read: 'Read all practitioner role resources the user has access to (api:fhir)'
7890 user/Procedure.read: 'Read all procedure resources the user has access to (api:fhir)'
7891 user/Provenance.read: 'Read all provenance resources the user has access to (api:fhir)'
7892 user/ValueSet.read: 'Read all valueSet resources the user has access to (api:fhir)'
7893 'api:oemr': 'Standard OpenEMR API'
7894 user/allergy.read: 'Read allergies the user has access to (api:oemr)'
7895 user/allergy.write: 'Write allergies the user has access to for (api:oemr)'
7896 user/appointment.read: 'Read appointments the user has access to (api:oemr)'
7897 user/appointment.write: 'Write appointments the user has access to for (api:oemr)'
7898 user/dental_issue.read: 'Read dental issues the user has access to (api:oemr)'
7899 user/dental_issue.write: 'Write dental issues the user has access to (api:oemr)'
7900 user/document.read: 'Read documents the user has access to (api:oemr)'
7901 user/document.write: 'Write documents the user has access to (api:oemr)'
7902 user/drug.read: 'Read drugs the user has access to (api:oemr)'
7903 user/encounter.read: 'Read encounters the user has access to (api:oemr)'
7904 user/encounter.write: 'Write encounters the user has access to (api:oemr)'
7905 user/facility.read: 'Read facilities the user has access to (api:oemr)'
7906 user/facility.write: 'Write facilities the user has access to (api:oemr)'
7907 user/immunization.read: 'Read immunizations the user has access to (api:oemr)'
7908 user/insurance.read: 'Read insurances the user has access to (api:oemr)'
7909 user/insurance.write: 'Write insurances the user has access to (api:oemr)'
7910 user/insurance_company.read: 'Read insurance companies the user has access to (api:oemr)'
7911 user/insurance_company.write: 'Write insurance companies the user has access to (api:oemr)'
7912 user/insurance_type.read: 'Read insurance types the user has access to (api:oemr)'
7913 user/list.read: 'Read lists the user has access to (api:oemr)'
7914 user/medical_problem.read: 'Read medical problems the user has access to (api:oemr)'
7915 user/medical_problem.write: 'Write medical problems the user has access to (api:oemr)'
7916 user/medication.read: 'Read medications the user has access to (api:oemr)'
7917 user/medication.write: 'Write medications the user has access to (api:oemr)'
7918 user/message.write: 'Read messages the user has access to (api:oemr)'
7919 user/patient.read: 'Read patients the user has access to (api:oemr)'
7920 user/patient.write: 'Write patients the user has access to (api:oemr)'
7921 user/practitioner.read: 'Read practitioners the user has access to (api:oemr)'
7922 user/practitioner.write: 'Write practitioners the user has access to (api:oemr)'
7923 user/prescription.read: 'Read prescriptions the user has access to (api:oemr)'
7924 user/procedure.read: 'Read procedures the user has access to (api:oemr)'
7925 user/soap_note.read: 'Read soap notes the user has access to (api:oemr)'
7926 user/soap_note.write: 'Write soap notes the user has access to (api:oemr)'
7927 user/surgery.read: 'Read surgeries the user has access to (api:oemr)'
7928 user/surgery.write: 'Write surgeries the user has access to (api:oemr)'
7929 user/transaction.read: 'Read transactions the user has access to (api:oemr)'
7930 user/transaction.write: 'Write transactions the user has access to (api:oemr)'
7931 user/user.read: 'Read users the current user has access to (api:oemr)'
7932 user/vital.read: 'Read vitals the user has access to (api:oemr)'
7933 user/vital.write: 'Write vitals the user has access to (api:oemr)'
7934 'api:port': 'Standard Patient Portal OpenEMR API'
7935 patient/encounter.read: 'Read encounters the patient has access to (api:port)'
7936 patient/patient.read: 'Write encounters the patient has access to (api:port)'
7937 patient/appointment.read: 'Read appointments the patient has access to (api:port)'
7941 description: 'FHIR R4 API'
7944 description: 'Standard OpenEMR API'
7946 name: standard-patient
7947 description: 'Standard Patient Portal OpenEMR API'