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/{puuid}/employer':
3155 description: 'Retrieves all the employer data for a patient. Returns an array of the employer data for the patient.'
3160 description: 'The uuid for the patient.'
3166 $ref: '#/components/responses/standard'
3168 $ref: '#/components/responses/badrequest'
3170 $ref: '#/components/responses/unauthorized'
3174 '/api/patient/{puuid}/insurance':
3178 description: 'Retrieves all insurances for a patient'
3183 description: 'The uuid for the patient.'
3189 $ref: '#/components/responses/standard'
3191 $ref: '#/components/responses/badrequest'
3193 $ref: '#/components/responses/unauthorized'
3200 description: 'Submits a new patient insurance.'
3205 description: 'The uuid for the patient.'
3214 $ref: '#/components/schemas/api_insurance_request'
3217 $ref: '#/components/responses/standard'
3219 $ref: '#/components/responses/badrequest'
3221 $ref: '#/components/responses/unauthorized'
3225 '/api/patient/{puuid}/insurance/$swap-insurance':
3229 description: 'Updates the insurance for the passed in uuid to be a policy of type `type` and updates (if one exists) the current or most recent insurance for the passed in `type` for a patient to be the `type` of the insurance for the given `uuid`. Validations on the swap operation are performed to make sure the effective `date` of the src and target policies being swapped can be received in each given policy `type` as a policy `type` and `date` must together be unique per patient.'
3234 description: 'The uuid for the patient.'
3241 description: 'The type or category of OpenEMR insurance policy, ''primary'', ''secondary'', or ''tertiary''.'
3248 description: 'The insurance uuid that will be swapped into the list of insurances for the type query parameter'
3254 $ref: '#/components/responses/standard'
3256 $ref: '#/components/responses/badrequest'
3258 $ref: '#/components/responses/unauthorized'
3262 '/api/patient/{puuid}/insurance/{uuid}':
3266 description: 'Retrieves all insurances for a patient'
3271 description: 'The uuid for the patient.'
3277 $ref: '#/components/responses/standard'
3279 $ref: '#/components/responses/badrequest'
3281 $ref: '#/components/responses/unauthorized'
3285 '/api/patient/{puuid}/insurance/{insuranceUuid}':
3289 description: 'Edit a specific patient insurance policy. Requires the patients/demo/write ACL to call. This method is the preferred method for updating a patient insurance policy. The {insuranceId} can be found by querying /api/patient/{pid}/insurance'
3294 description: 'The uuid for the patient.'
3301 description: 'The insurance policy uuid for the patient.'
3310 $ref: '#/components/schemas/api_insurance_request'
3313 $ref: '#/components/responses/standard'
3315 $ref: '#/components/responses/badrequest'
3317 $ref: '#/components/responses/unauthorized'
3321 '/api/patient/{pid}/message':
3325 description: 'Submits a pnote message'
3330 description: 'The id for the patient.'
3339 $ref: '#/components/schemas/api_message_request'
3342 $ref: '#/components/responses/standard'
3344 $ref: '#/components/responses/badrequest'
3346 $ref: '#/components/responses/unauthorized'
3350 '/api/patient/{pid}/transaction':
3354 description: 'Get Transactions for a patient'
3359 description: 'The pid for the patient'
3365 $ref: '#/components/responses/standard'
3367 $ref: '#/components/responses/badrequest'
3369 $ref: '#/components/responses/unauthorized'
3376 description: 'Submits a transaction'
3381 description: 'The pid for the patient.'
3390 $ref: '#/components/schemas/api_transaction_request'
3393 $ref: '#/components/responses/standard'
3395 $ref: '#/components/responses/badrequest'
3397 $ref: '#/components/responses/unauthorized'
3401 '/api/transaction/{tid}':
3405 description: 'Updates a transaction'
3410 description: 'The id for the transaction.'
3419 $ref: '#/components/schemas/api_transaction_request'
3422 $ref: '#/components/responses/standard'
3424 $ref: '#/components/responses/badrequest'
3426 $ref: '#/components/responses/unauthorized'
3430 '/api/patient/{pid}/message/{mid}':
3434 description: 'Edit a pnote message'
3439 description: 'The id for the patient.'
3446 description: 'The id for the pnote message.'
3455 $ref: '#/components/schemas/api_message_request'
3458 $ref: '#/components/responses/standard'
3460 $ref: '#/components/responses/badrequest'
3462 $ref: '#/components/responses/unauthorized'
3469 description: 'Delete a pnote message'
3474 description: 'The id for the patient.'
3481 description: 'The id for the pnote message.'
3487 $ref: '#/components/responses/standard'
3489 $ref: '#/components/responses/badrequest'
3491 $ref: '#/components/responses/unauthorized'
3499 description: 'Retrieves a list of immunizations'
3504 description: 'The pid for the patient.'
3511 description: 'The id for the immunization.'
3518 description: 'The uuid for the immunization.'
3523 name: administered_date
3525 description: 'The administered date for the immunization.'
3530 name: immunization_id
3532 description: 'The immunization list_id for the immunization.'
3539 description: 'The cvx code for the immunization.'
3546 description: 'The manufacturer for the immunization.'
3553 description: 'The lot number for the immunization.'
3558 name: administered_by_id
3560 description: 'The administered by id for the immunization.'
3565 name: administered_by
3567 description: 'The administered by for the immunization.'
3572 name: education_date
3574 description: 'The education date for the immunization.'
3581 description: 'The vis date for the immunization.'
3588 description: 'The note for the immunization.'
3595 description: 'The create date for the immunization.'
3602 description: 'The update date for the immunization.'
3609 description: 'The created_by for the immunization.'
3616 description: 'The updated_by for the immunization.'
3621 name: amount_administered
3623 description: 'The amount administered for the immunization.'
3628 name: amount_administered_unit
3630 description: 'The amount administered unit for the immunization.'
3635 name: expiration_date
3637 description: 'The expiration date for the immunization.'
3644 description: 'The route for the immunization.'
3649 name: administration_site
3651 description: 'The administration site for the immunization.'
3656 name: added_erroneously
3658 description: 'The added_erroneously for the immunization.'
3665 description: 'The external_id for the immunization.'
3670 name: completion_status
3672 description: 'The completion status for the immunization.'
3677 name: information_source
3679 description: 'The information source for the immunization.'
3684 name: refusal_reason
3686 description: 'The refusal reason for the immunization.'
3691 name: ordering_provider
3693 description: 'The ordering provider for the immunization.'
3699 $ref: '#/components/responses/standard'
3701 $ref: '#/components/responses/badrequest'
3703 $ref: '#/components/responses/unauthorized'
3707 '/api/immunization/{uuid}':
3711 description: 'Retrieves a immunization'
3716 description: 'The uuid for the immunization.'
3722 $ref: '#/components/responses/standard'
3724 $ref: '#/components/responses/badrequest'
3726 $ref: '#/components/responses/unauthorized'
3734 description: 'Retrieves a list of all procedures'
3737 $ref: '#/components/responses/standard'
3739 $ref: '#/components/responses/badrequest'
3741 $ref: '#/components/responses/unauthorized'
3745 '/api/procedure/{uuid}':
3749 description: 'Retrieves a procedure'
3754 description: 'The uuid for the procedure.'
3760 $ref: '#/components/responses/standard'
3762 $ref: '#/components/responses/badrequest'
3764 $ref: '#/components/responses/unauthorized'
3772 description: 'Retrieves a list of all drugs'
3775 $ref: '#/components/responses/standard'
3777 $ref: '#/components/responses/badrequest'
3779 $ref: '#/components/responses/unauthorized'
3787 description: 'Retrieves a drug'
3792 description: 'The uuid for the drug.'
3798 $ref: '#/components/responses/standard'
3800 $ref: '#/components/responses/badrequest'
3802 $ref: '#/components/responses/unauthorized'
3810 description: 'Retrieves a list of all prescriptions'
3813 $ref: '#/components/responses/standard'
3815 $ref: '#/components/responses/badrequest'
3817 $ref: '#/components/responses/unauthorized'
3821 '/api/prescription/{uuid}':
3825 description: 'Retrieves a prescription'
3830 description: 'The uuid for the prescription.'
3836 $ref: '#/components/responses/standard'
3838 $ref: '#/components/responses/badrequest'
3840 $ref: '#/components/responses/unauthorized'
3844 /fhir/AllergyIntolerance:
3848 description: 'Returns a list of AllergyIntolerance resources.'
3853 description: 'The uuid for the AllergyIntolerance resource.'
3860 description: 'The uuid for the patient.'
3866 description: 'Standard Response'
3871 'json object': { description: 'FHIR Json object.', type: object }
3874 meta: { lastUpdated: '2021-09-14T09:13:51' }
3875 resourceType: Bundle
3878 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3880 $ref: '#/components/responses/badrequest'
3882 $ref: '#/components/responses/unauthorized'
3886 '/fhir/AllergyIntolerance/{uuid}':
3890 description: 'Returns a single AllergyIntolerance resource.'
3895 description: 'The uuid for the AllergyIntolerance resource.'
3901 description: 'Standard Response'
3906 'json object': { description: 'FHIR Json object.', type: object }
3909 id: 94682fe5-f383-4885-9505-64b02e34906f
3910 meta: { versionId: '1', lastUpdated: '2021-09-16T00:27:32+00:00' }
3911 resourceType: AllergyIntolerance
3912 text: { status: additional, div: '<div xmlns=''http://www.w3.org/1999/xhtml''>penicillin</div>' }
3913 clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical', code: active, display: Active }] }
3914 verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification', code: confirmed, display: Confirmed }] }
3915 category: [medication]
3917 code: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
3918 patient: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92 }
3919 reaction: [{ manifestation: [{ coding: [{ system: 'http://snomed.info/sct', code: '422587007', display: Nausea }], text: Nausea }] }]
3921 $ref: '#/components/responses/badrequest'
3923 $ref: '#/components/responses/unauthorized'
3925 $ref: '#/components/responses/uuidnotfound'
3933 description: 'Returns a list of Appointment resources.'
3938 description: 'The uuid for the Appointment resource.'
3945 description: 'The uuid for the patient.'
3951 description: 'Standard Response'
3956 'json object': { description: 'FHIR Json object.', type: object }
3959 meta: { lastUpdated: '2021-09-14T09:13:51' }
3960 resourceType: Bundle
3963 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3965 $ref: '#/components/responses/badrequest'
3967 $ref: '#/components/responses/unauthorized'
3971 '/fhir/Appointment/{uuid}':
3975 description: 'Returns a single Appointment resource.'
3980 description: 'The uuid for the Appointment resource.'
3986 description: 'Standard Response'
3991 'json object': { description: 'FHIR Json object.', type: object }
3995 $ref: '#/components/responses/badrequest'
3997 $ref: '#/components/responses/unauthorized'
3999 $ref: '#/components/responses/uuidnotfound'
4007 description: 'Returns a list of CarePlan resources.'
4012 description: 'The uuid for the CarePlan resource.'
4019 description: 'The uuid for the patient.'
4026 description: 'The category of the CarePlan resource.'
4032 description: 'Standard Response'
4037 'json object': { description: 'FHIR Json object.', type: object }
4040 meta: { lastUpdated: '2021-09-14T09:13:51' }
4041 resourceType: Bundle
4044 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CarePlan' }]
4046 $ref: '#/components/responses/badrequest'
4048 $ref: '#/components/responses/unauthorized'
4052 '/fhir/CarePlan/{uuid}':
4056 description: 'Returns a single CarePlan resource.'
4061 description: 'The uuid for the CarePlan resource.'
4067 description: 'Standard Response'
4072 'json object': { description: 'FHIR Json object.', type: object }
4075 id: 94682f08-8fbc-451e-b1ec-f922d765c38f_1
4076 meta: { versionId: '1', lastUpdated: '2021-09-16T00:54:18+00:00' }
4077 resourceType: CarePlan
4078 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"><p>Treat flu.</p></div>' }
4081 category: [{ coding: [{ system: 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', code: assess-plan }] }]
4082 description: 'Treat flu.'
4083 subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
4085 $ref: '#/components/responses/badrequest'
4087 $ref: '#/components/responses/unauthorized'
4089 $ref: '#/components/responses/uuidnotfound'
4097 description: 'Returns a list of CareTeam resources.'
4102 description: 'The uuid for the CareTeam resource.'
4109 description: 'The uuid for the patient.'
4116 description: 'The status of the CarePlan resource.'
4122 description: 'Standard Response'
4127 'json object': { description: 'FHIR Json object.', type: object }
4130 meta: { lastUpdated: '2021-09-14T09:13:51' }
4131 resourceType: Bundle
4134 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CareTeam' }]
4136 $ref: '#/components/responses/badrequest'
4138 $ref: '#/components/responses/unauthorized'
4142 '/fhir/CareTeam/{uuid}':
4146 description: 'Returns a single CareTeam resource.'
4151 description: 'The uuid for the CareTeam resource.'
4157 description: 'Standard Response'
4162 'json object': { description: 'FHIR Json object.', type: object }
4165 id: 94682f09-69fe-4ada-8ea6-753a52bd1516
4166 meta: { versionId: '1', lastUpdated: '2021-09-16T01:07:22+00:00' }
4167 resourceType: CareTeam
4169 subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
4170 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 } }]
4172 $ref: '#/components/responses/badrequest'
4174 $ref: '#/components/responses/unauthorized'
4176 $ref: '#/components/responses/uuidnotfound'
4184 description: 'Returns a list of Condition resources.'
4189 description: 'The uuid for the Condition resource.'
4196 description: 'The uuid for the patient.'
4202 description: 'Standard Response'
4207 'json object': { description: 'FHIR Json object.', type: object }
4210 meta: { lastUpdated: '2021-09-14T09:13:51' }
4211 resourceType: Bundle
4214 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Condition' }]
4216 $ref: '#/components/responses/badrequest'
4218 $ref: '#/components/responses/unauthorized'
4222 '/fhir/Condition/{uuid}':
4226 description: 'Returns a single Condition resource.'
4231 description: 'The uuid for the Condition resource.'
4237 description: 'Standard Response'
4242 'json object': { description: 'FHIR Json object.', type: object }
4245 id: 94682c68-e5bb-4c5c-859a-cebaa5a1e582
4246 meta: { versionId: '1', lastUpdated: '2021-09-16T02:41:53+00:00' }
4247 resourceType: Condition
4248 clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-clinical', code: inactive, display: Inactive }] }
4249 verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-ver-status', code: unconfirmed, display: Unconfirmed }] }
4250 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-category', code: problem-list-item, display: 'Problem List Item' }] }]
4251 code: { coding: [{ system: 'http://snomed.info/sct', code: '444814009', display: '' }] }
4252 subject: { reference: Patient/94682c62-d37e-48b5-8018-c5f6f3566609 }
4254 $ref: '#/components/responses/badrequest'
4256 $ref: '#/components/responses/unauthorized'
4258 $ref: '#/components/responses/uuidnotfound'
4266 description: 'Returns a list of Coverage resources.'
4271 description: 'The uuid for the Coverage resource.'
4278 description: 'The uuid for the patient.'
4285 description: 'The payor of the Coverage resource.'
4291 description: 'Standard Response'
4296 'json object': { description: 'FHIR Json object.', type: object }
4299 meta: { lastUpdated: '2021-09-14T09:13:51' }
4300 resourceType: Bundle
4303 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Coverage' }]
4305 $ref: '#/components/responses/badrequest'
4307 $ref: '#/components/responses/unauthorized'
4311 '/fhir/Coverage/{uuid}':
4315 description: 'Returns a single Coverage resource.'
4320 description: 'The uuid for the Coverage resource.'
4326 description: 'Standard Response'
4331 'json object': { description: 'FHIR Json object.', type: object }
4334 id: 960d5f10-edc6-4c65-a6d4-39a1e1da87a8
4335 meta: { versionId: '1', lastUpdated: '2022-04-14T07:58:45+00:00' }
4336 resourceType: Coverage
4338 beneficiary: { reference: Patient/960d5f08-9fdf-4bdc-9108-84a149e28bac }
4339 relationship: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/subscriber-relationship', code: '' }] }
4341 $ref: '#/components/responses/badrequest'
4343 $ref: '#/components/responses/unauthorized'
4345 $ref: '#/components/responses/uuidnotfound'
4353 description: 'Returns a list of Device resources.'
4358 description: 'The uuid for the Device resource.'
4365 description: 'The uuid for the patient.'
4371 description: 'Standard Response'
4376 'json object': { description: 'FHIR Json object.', type: object }
4379 meta: { lastUpdated: '2021-09-14T09:13:51' }
4380 resourceType: Bundle
4383 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Device' }]
4385 $ref: '#/components/responses/badrequest'
4387 $ref: '#/components/responses/unauthorized'
4391 '/fhir/Device/{uuid}':
4395 description: 'Returns a single Device resource.'
4400 description: 'The uuid for the Device resource.'
4406 description: 'Standard Response'
4411 'json object': { description: 'FHIR Json object.', type: object }
4414 id: 946dce19-c80a-402c-862a-eadf3f2377f0
4415 meta: { versionId: '1', lastUpdated: '2021-09-18T19:28:59+00:00' }
4416 resourceType: Device
4417 udiCarrier: [{ deviceIdentifier: '08717648200274', carrierHRF: '=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123' }]
4418 distinctIdentifier: A99971312345600
4419 manufactureDate: '2013-02-01'
4420 expirationDate: '2014-02-01'
4421 lotNumber: 000000000000XYZ123
4422 serialNumber: '000025'
4423 type: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }
4424 patient: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4426 $ref: '#/components/responses/badrequest'
4428 $ref: '#/components/responses/unauthorized'
4430 $ref: '#/components/responses/uuidnotfound'
4434 /fhir/DiagnosticReport:
4438 description: 'Returns a list of DiagnosticReport resources.'
4443 description: 'The uuid for the DiagnosticReport resource.'
4450 description: 'The uuid for the patient.'
4457 description: 'The code of the DiagnosticReport resource.'
4464 description: 'The category of the DiagnosticReport resource.'
4471 description: 'The datetime of the DiagnosticReport resource.'
4477 description: 'Standard Response'
4482 'json object': { description: 'FHIR Json object.', type: object }
4485 meta: { lastUpdated: '2021-09-14T09:13:51' }
4486 resourceType: Bundle
4489 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DiagnosticReport' }]
4491 $ref: '#/components/responses/badrequest'
4493 $ref: '#/components/responses/unauthorized'
4497 '/fhir/DiagnosticReport/{uuid}':
4501 description: 'Returns a single DiagnosticReport resource.'
4506 description: 'The uuid for the DiagnosticReport resource.'
4512 description: 'Standard Response'
4517 'json object': { description: 'FHIR Json object.', type: object }
4520 id: 93fb2d6a-77ac-48ca-a12d-1a17e40007e3
4521 meta: { versionId: '1', lastUpdated: '2021-09-18T20:52:34+00:00' }
4522 resourceType: DiagnosticReport
4524 category: [{ coding: [{ system: 'http://loinc.org', code: LP7839-6, display: Pathology }] }]
4525 code: { coding: [{ system: 'http://loinc.org', code: 11502-2, display: 'Laboratory report' }] }
4526 subject: { reference: Patient/9353b8f5-0a87-4e2a-afd4-25341fdb0fbc, type: Patient }
4527 encounter: { reference: Encounter/93540818-cb5f-49df-b73b-83901bb793b6, type: Encounter }
4528 effectiveDateTime: '2015-06-22T00:00:00+00:00'
4529 issued: '2015-06-22T00:00:00+00:00'
4530 performer: [{ reference: Organization/935249b5-0ba6-4b5b-8863-a7a27d4c6350, type: Organization }]
4531 presentedForm: [{ contentType: text/plain, data: TXMgQWxpY2UgTmV3bWFuIHdhcyB0ZXN0ZWQgZm9yIHRoZSBVcmluYW5hbHlzaXMgbWFjcm8gcGFuZWwgYW5kIHRoZSByZXN1bHRzIGhhdmUgYmVlbiBmb3VuZCB0byBiZSANCm5vcm1hbC4= }]
4533 $ref: '#/components/responses/badrequest'
4535 $ref: '#/components/responses/unauthorized'
4537 $ref: '#/components/responses/uuidnotfound'
4541 /fhir/DocumentReference:
4545 description: 'Returns a list of DocumentReference resources.'
4550 description: 'The uuid for the DocumentReference resource.'
4557 description: 'The uuid for the patient.'
4564 description: 'The type of the DocumentReference resource.'
4571 description: 'The category of the DocumentReference resource.'
4578 description: 'The datetime of the DocumentReference resource.'
4584 description: 'Standard Response'
4589 'json object': { description: 'FHIR Json object.', type: object }
4592 meta: { lastUpdated: '2021-09-14T09:13:51' }
4593 resourceType: Bundle
4596 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DocumentReference' }]
4598 $ref: '#/components/responses/badrequest'
4600 $ref: '#/components/responses/unauthorized'
4604 /fhir/DocumentReference/$docref:
4608 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.'
4610 description: 'Detailed documentation on this operation'
4611 url: 'https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'
4616 description: 'The uuid for the patient.'
4623 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.'
4630 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.'
4637 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).'
4643 description: 'A search bundle of DocumentReferences is returned'
4645 $ref: '#/components/responses/badrequest'
4647 $ref: '#/components/responses/unauthorized'
4651 '/fhir/DocumentReference/{uuid}':
4655 description: 'Returns a single DocumentReference resource.'
4660 description: 'The uuid for the DocumentReference resource.'
4666 description: 'Standard Response'
4671 'json object': { description: 'FHIR Json object.', type: object }
4674 id: 946e7553-1aaa-49f8-8f81-ae15ccaa9165
4675 meta: { versionId: '1', lastUpdated: '2021-09-19T03:17:51+00:00' }
4676 resourceType: DocumentReference
4677 identifier: [{ value: 946e7553-1aaa-49f8-8f81-ae15ccaa9165 }]
4679 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: unknown }] }
4680 category: [{ coding: [{ system: 'https://localhost:9300/apis/default/fhir/ValueSet/openemr-document-types', code: openemr-document, display: 'OpenEMR Document' }] }]
4681 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4682 date: '2021-09-19T03:15:56+00:00'
4684 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' } }]
4686 $ref: '#/components/responses/badrequest'
4688 $ref: '#/components/responses/unauthorized'
4690 $ref: '#/components/responses/uuidnotfound'
4694 '/fhir/Binary/{id}':
4698 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>'
4703 description: 'The id for the Document.'
4709 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>'
4711 $ref: '#/components/responses/badrequest'
4713 $ref: '#/components/responses/unauthorized'
4721 description: 'Returns a list of Encounter resources.'
4726 description: 'The uuid for the Encounter resource.'
4733 description: 'The uuid for the patient.'
4740 description: 'The datetime of the Encounter resource.'
4746 description: 'Standard Response'
4751 'json object': { description: 'FHIR Json object.', type: object }
4754 meta: { lastUpdated: '2021-09-14T09:13:51' }
4755 resourceType: Bundle
4758 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Encounter' }]
4760 $ref: '#/components/responses/badrequest'
4762 $ref: '#/components/responses/unauthorized'
4766 '/fhir/Encounter/{uuid}':
4770 description: 'Returns a single Encounter resource.'
4775 description: 'The uuid for the Encounter resource.'
4781 description: 'Standard Response'
4786 'json object': { description: 'FHIR Json object.', type: object }
4789 id: 946da61d-6b95-4f8e-abe5-534a25913b71
4790 meta: { versionId: '1', lastUpdated: '2021-09-19T06:27:41+00:00' }
4791 resourceType: Encounter
4792 identifier: [{ system: 'urn:ietf:rfc:3986', value: 946da61d-6b95-4f8e-abe5-534a25913b71 }]
4794 class: { system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode', code: AMB, display: ambulatory }
4795 type: [{ coding: [{ system: 'http://snomed.info/sct', code: '185349003', display: 'Encounter for check up (procedure)' }] }]
4796 subject: { reference: Patient/946da61b-626b-4f88-81e2-adfb88f4f0fe, type: Patient }
4797 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 } }]
4798 period: { start: '2012-08-13T00:00:00+00:00' }
4800 $ref: '#/components/responses/badrequest'
4802 $ref: '#/components/responses/unauthorized'
4804 $ref: '#/components/responses/uuidnotfound'
4812 description: 'Returns a list of Condition resources.'
4817 description: 'The uuid for the Goal resource.'
4824 description: 'The uuid for the patient.'
4830 description: 'Standard Response'
4835 'json object': { description: 'FHIR Json object.', type: object }
4838 meta: { lastUpdated: '2021-09-14T09:13:51' }
4839 resourceType: Bundle
4842 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Goal' }]
4844 $ref: '#/components/responses/badrequest'
4846 $ref: '#/components/responses/unauthorized'
4850 '/fhir/Goal/{uuid}':
4854 description: 'Returns a single Goal resource.'
4859 description: 'The uuid for the Goal resource.'
4865 description: 'Standard Response'
4870 'json object': { description: 'FHIR Json object.', type: object }
4873 id: 946da61d-6b88-4d54-bdd6-4029e2ad9e3f_1
4874 meta: { versionId: '1', lastUpdated: '2021-09-19T06:45:58+00:00' }
4876 lifecycleStatus: active
4877 description: { text: 'Eating more vegetables.' }
4878 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4879 target: [{ measure: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }, detailString: 'Eating more vegetables.', dueDate: '2021-09-09' }]
4881 $ref: '#/components/responses/badrequest'
4883 $ref: '#/components/responses/unauthorized'
4885 $ref: '#/components/responses/uuidnotfound'
4893 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>'
4898 description: 'The uuid for the Group resource.'
4905 description: 'The uuid for the patient.'
4911 description: 'Standard Response'
4916 'json object': { description: 'FHIR Json object.', type: object }
4919 meta: { lastUpdated: '2021-09-14T09:13:51' }
4920 resourceType: Bundle
4923 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Group' }]
4925 $ref: '#/components/responses/badrequest'
4927 $ref: '#/components/responses/unauthorized'
4931 '/fhir/Group/{uuid}':
4935 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>'
4940 description: 'The uuid for the Group resource.'
4946 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>'
4948 $ref: '#/components/responses/badrequest'
4950 $ref: '#/components/responses/unauthorized'
4952 $ref: '#/components/responses/uuidnotfound'
4956 '/fhir/Group/{id}/$export':
4960 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>'
4965 description: 'The id for the Group resource.'
4971 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>'
4973 $ref: '#/components/responses/badrequest'
4975 $ref: '#/components/responses/unauthorized'
4983 description: 'Returns a list of Immunization resources.'
4988 description: 'The uuid for the Immunization resource.'
4995 description: 'The uuid for the patient.'
5001 description: 'Standard Response'
5006 'json object': { description: 'FHIR Json object.', type: object }
5009 meta: { lastUpdated: '2021-09-14T09:13:51' }
5010 resourceType: Bundle
5013 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Immunization' }]
5015 $ref: '#/components/responses/badrequest'
5017 $ref: '#/components/responses/unauthorized'
5021 '/fhir/Immunization/{uuid}':
5025 description: 'Returns a single Immunization resource.'
5030 description: 'The uuid for the Immunization resource.'
5036 description: 'Standard Response'
5041 'json object': { description: 'FHIR Json object.', type: object }
5044 id: 95e8d8b7-e3e2-4e03-8eb1-31e1d9097d8f
5045 meta: { versionId: '1', lastUpdated: '2022-03-26T05:42:59+00:00' }
5046 resourceType: Immunization
5048 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' }] }
5049 patient: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf }
5050 occurrenceDateTime: '2022-03-26T05:35:00+00:00'
5051 recorded: '2022-03-26T05:42:26+00:00'
5052 primarySource: false
5054 $ref: '#/components/responses/badrequest'
5056 $ref: '#/components/responses/unauthorized'
5058 $ref: '#/components/responses/uuidnotfound'
5066 description: 'Returns a list of Location resources.'
5071 description: 'The uuid for the Location resource.'
5077 description: 'Standard Response'
5082 'json object': { description: 'FHIR Json object.', type: object }
5085 meta: { lastUpdated: '2021-09-14T09:13:51' }
5086 resourceType: Bundle
5089 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Location' }]
5091 $ref: '#/components/responses/badrequest'
5093 $ref: '#/components/responses/unauthorized'
5097 '/fhir/Location/{uuid}':
5101 description: 'Returns a single Location resource.'
5106 description: 'The uuid for the Location resource.'
5112 description: 'Standard Response'
5117 'json object': { description: 'FHIR Json object.', type: object }
5120 id: 946da61d-c4f2-4f03-a2a7-b571f6a24b65
5121 meta: { versionId: '1', lastUpdated: '2021-09-19T08:14:58+00:00' }
5122 resourceType: Location
5124 name: 'Your Clinic Name Here'
5125 telecom: [{ system: phone, value: 000-000-0000 }, { system: fax, value: 000-000-0000 }]
5127 $ref: '#/components/responses/badrequest'
5129 $ref: '#/components/responses/unauthorized'
5131 $ref: '#/components/responses/uuidnotfound'
5139 description: 'Returns a list of Medication resources.'
5142 description: 'Standard Response'
5147 'json object': { description: 'FHIR Json object.', type: object }
5150 meta: { lastUpdated: '2021-09-14T09:13:51' }
5151 resourceType: Bundle
5154 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Medication' }]
5156 $ref: '#/components/responses/badrequest'
5158 $ref: '#/components/responses/unauthorized'
5162 '/fhir/Medication/{uuid}':
5166 description: 'Returns a single Medication resource.'
5171 description: 'The uuid for the Medication resource.'
5177 description: 'Standard Response'
5182 'json object': { description: 'FHIR Json object.', type: object }
5185 id: 961aa334-9348-4145-8252-de665e3c4afa
5186 meta: { versionId: '1', lastUpdated: '2022-04-19T23:42:14+00:00' }
5187 resourceType: Medication
5188 code: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: 153165 }] }
5190 batch: { lotNumber: '132', expirationDate: '0000-00-00' }
5192 $ref: '#/components/responses/badrequest'
5194 $ref: '#/components/responses/unauthorized'
5196 $ref: '#/components/responses/uuidnotfound'
5200 /fhir/MedicationRequest:
5204 description: 'Returns a list of MedicationRequest resources.'
5209 description: 'The uuid for the MedicationRequest resource.'
5216 description: 'The uuid for the patient.'
5223 description: 'The intent of the MedicationRequest resource.'
5230 description: 'The status of the MedicationRequest resource.'
5236 description: 'Standard Response'
5241 'json object': { description: 'FHIR Json object.', type: object }
5244 meta: { lastUpdated: '2021-09-14T09:13:51' }
5245 resourceType: Bundle
5248 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/MedicationRequest' }]
5250 $ref: '#/components/responses/badrequest'
5252 $ref: '#/components/responses/unauthorized'
5256 '/fhir/MedicationRequest/{uuid}':
5260 description: 'Returns a single MedicationRequest resource.'
5265 description: 'The uuid for the MedicationRequest resource.'
5271 description: 'Standard Response'
5276 'json object': { description: 'FHIR Json object.', type: object }
5279 id: 946da61d-9cff-4416-8d27-805f19f9d7d8
5280 meta: { versionId: '1', lastUpdated: '2021-09-20T04:03:14+00:00' }
5281 resourceType: MedicationRequest
5284 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/medicationrequest-category', code: community, display: Home/Community }] }]
5285 reportedBoolean: false
5286 medicationCodeableConcept: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: '1738139', display: 'Acetaminophen 325 MG Oral Tablet' }] }
5287 subject: { reference: Patient/946da617-1a4a-4b2c-ae66-93b84377cb1e, type: Patient }
5288 authoredOn: '2021-09-18T00:00:00+00:00'
5289 requester: { reference: Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b, type: Practitioner }
5291 $ref: '#/components/responses/badrequest'
5293 $ref: '#/components/responses/unauthorized'
5295 $ref: '#/components/responses/uuidnotfound'
5303 description: 'Returns a list of Observation resources.'
5308 description: 'The uuid for the Observation resource.'
5315 description: 'The uuid for the patient.'
5322 description: 'The code of the Observation resource.'
5329 description: 'The category of the Observation resource.'
5336 description: 'The datetime of the Observation resource.'
5342 description: 'Standard Response'
5347 'json object': { description: 'FHIR Json object.', type: object }
5350 meta: { lastUpdated: '2021-09-14T09:13:51' }
5351 resourceType: Bundle
5354 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Observation' }]
5356 $ref: '#/components/responses/badrequest'
5358 $ref: '#/components/responses/unauthorized'
5362 '/fhir/Observation/{uuid}':
5366 description: 'Returns a single Observation resource.'
5371 description: 'The uuid for the Observation resource.'
5377 description: 'Standard Response'
5382 'json object': { description: 'FHIR Json object.', type: object }
5385 id: 946da61e-0597-485e-9dfd-a87205ea56b3
5386 meta: { versionId: '1', lastUpdated: '2021-09-20T04:12:16+00:00' }
5387 resourceType: Observation
5389 category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/observation-category', code: vital-signs }] }]
5390 code: { coding: [{ system: 'http://loinc.org', code: 85354-9, display: 'Blood pressure systolic and diastolic' }] }
5391 subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
5392 effectiveDateTime: '2015-08-31T00:00:00+00:00'
5393 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]' } }]
5395 $ref: '#/components/responses/badrequest'
5397 $ref: '#/components/responses/unauthorized'
5399 $ref: '#/components/responses/uuidnotfound'
5407 description: 'Returns a list of Organization resources.'
5412 description: 'The uuid for the Organization resource.'
5419 description: 'The name of the Organization resource.'
5426 description: 'The email of the Organization resource.'
5433 description: 'The phone of the Organization resource.'
5440 description: 'The telecom of the Organization resource.'
5447 description: 'The address of the Organization resource.'
5454 description: 'The address-city of the Organization resource.'
5459 name: address-postalcode
5461 description: 'The address-postalcode of the Organization resource.'
5468 description: 'The address-state of the Organization resource.'
5474 description: 'Standard Response'
5479 'json object': { description: 'FHIR Json object.', type: object }
5482 meta: { lastUpdated: '2021-09-14T09:13:51' }
5483 resourceType: Bundle
5486 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Organization' }]
5488 $ref: '#/components/responses/badrequest'
5490 $ref: '#/components/responses/unauthorized'
5497 description: 'Adds a Organization resource.'
5503 description: 'The json object for the Organization resource.'
5506 id: 95f0e672-be37-4c73-95c9-649c2d200018
5509 lastUpdated: '2022-03-30T07:43:23+00:00'
5510 resourceType: Organization
5513 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5516 system: 'http://hl7.org/fhir/sid/us-npi'
5521 coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5522 name: 'Your Clinic Name Here Hey'
5536 description: 'Standard Response'
5541 'json object': { description: 'FHIR Json object.', type: object }
5544 id: 95f0e672-be37-4c73-95c9-649c2d200018
5545 meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5546 resourceType: Organization
5547 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5548 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5550 type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5551 name: 'Your Clinic Name Here Now'
5552 telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5555 $ref: '#/components/responses/badrequest'
5557 $ref: '#/components/responses/unauthorized'
5561 '/fhir/Organization/{uuid}':
5565 description: 'Returns a single Organization resource.'
5570 description: 'The uuid for the Organization resource.'
5576 description: 'Standard Response'
5581 'json object': { description: 'FHIR Json object.', type: object }
5584 id: 95f0e672-be37-4c73-95c9-649c2d200018
5585 meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5586 resourceType: Organization
5587 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5588 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5590 type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5591 name: 'Your Clinic Name Here'
5592 telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5595 $ref: '#/components/responses/badrequest'
5597 $ref: '#/components/responses/unauthorized'
5599 $ref: '#/components/responses/uuidnotfound'
5606 description: 'Modifies a Organization resource.'
5611 description: 'The uuid for the organization.'
5620 description: 'The json object for the Organization resource.'
5623 id: 95f0e672-be37-4c73-95c9-649c2d200018
5626 lastUpdated: '2022-03-30T07:43:23+00:00'
5627 resourceType: Organization
5630 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5633 system: 'http://hl7.org/fhir/sid/us-npi'
5638 coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5639 name: 'Your Clinic Name Here'
5653 description: 'Standard Response'
5659 uuid: 95f217c1-258c-44ca-bf11-909dce369574
5661 $ref: '#/components/responses/badrequest'
5663 $ref: '#/components/responses/unauthorized'
5671 description: 'Returns a list of Patient resources.'
5676 description: 'The uuid for the Patient resource.'
5683 description: 'The identifier of the Patient resource.'
5690 description: 'The name of the Patient resource.'
5697 description: 'The birthdate of the Patient resource.'
5704 description: 'The gender of the Patient resource.'
5711 description: 'The address of the Patient resource.'
5718 description: 'The address-city of the Patient resource.'
5723 name: address-postalcode
5725 description: 'The address-postalcode of the Patient resource.'
5732 description: 'The address-state of the Patient resource.'
5739 description: 'The email of the Patient resource.'
5746 description: 'The family name of the Patient resource.'
5753 description: 'The given name of the Patient resource.'
5760 description: 'The phone number of the Patient resource.'
5767 description: 'The fax number of the Patient resource.'
5772 $ref: '#/components/parameters/_lastUpdated'
5775 description: 'Standard Response'
5780 'json object': { description: 'FHIR Json object.', type: object }
5783 meta: { lastUpdated: '2021-09-14T09:13:51' }
5784 resourceType: Bundle
5787 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Patient' }]
5789 $ref: '#/components/responses/badrequest'
5791 $ref: '#/components/responses/unauthorized'
5798 description: 'Adds a Patient resource.'
5804 description: 'The json object for the Patient resource.'
5807 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5810 lastUpdated: '2022-03-31T02:48:28+00:00'
5811 resourceType: Patient
5814 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5818 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5820 extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5821 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5825 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5826 system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5835 birthDate: '2017-03-10'
5838 language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5841 description: 'Standard Response'
5846 'json object': { description: 'FHIR Json object.', type: object }
5849 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5850 meta: { versionId: '1', lastUpdated: '2022-03-31T02:48:28+00:00' }
5851 resourceType: Patient
5852 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>' }
5853 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' }]
5854 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' }]
5856 name: [{ use: official, family: Smith, given: [Brenda] }]
5858 birthDate: '2017-03-10'
5859 communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5861 $ref: '#/components/responses/badrequest'
5863 $ref: '#/components/responses/unauthorized'
5867 '/fhir/Patient/{uuid}':
5871 description: 'Returns a single Patient resource.'
5876 description: 'The uuid for the Patient resource.'
5882 description: 'Standard Response'
5887 'json object': { description: 'FHIR Json object.', type: object }
5890 id: 946da617-1a4a-4b2c-ae66-93b84377cb1e
5891 meta: { versionId: '1', lastUpdated: '2021-09-21T17:08:03+00:00' }
5892 resourceType: Patient
5893 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Aurore252 Von197</p></div>' }
5894 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' }]
5895 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' }]
5897 name: [{ use: official, family: Von197, given: [Aurore252] }]
5899 birthDate: '1970-07-03'
5900 address: [{ line: ['245 Crona Wall'], city: Boston, state: Massachusetts, postalCode: '02215', period: { start: '2020-09-21T17:08:03.532+00:00' } }]
5901 communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5903 $ref: '#/components/responses/badrequest'
5905 $ref: '#/components/responses/unauthorized'
5907 $ref: '#/components/responses/uuidnotfound'
5914 description: 'Modifies a Patient resource.'
5919 description: 'The uuid for the Patient resource.'
5928 description: 'The json object for the Patient resource.'
5931 id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5934 lastUpdated: '2022-03-31T02:48:28+00:00'
5935 resourceType: Patient
5938 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5942 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5944 extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5945 url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5949 type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5950 system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5959 birthDate: '2017-03-10'
5962 language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5965 description: 'Standard Response'
5971 uuid: 95f2ad04-5834-4243-8838-e396a7faadbf
5973 $ref: '#/components/responses/badrequest'
5975 $ref: '#/components/responses/unauthorized'
5979 /fhir/Patient/$export:
5983 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>'
5986 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>'
5988 $ref: '#/components/responses/badrequest'
5990 $ref: '#/components/responses/unauthorized'
5998 description: 'Returns a list of Person resources.'
6003 description: 'The name of the Person resource.'
6010 description: 'The active status of the Person resource.'
6017 description: 'The address of the Person resource.'
6024 description: 'The address-city of the Person resource.'
6029 name: address-postalcode
6031 description: 'The address-postalcode of the Person resource.'
6038 description: 'The address-state of the Person resource.'
6045 description: 'The email of the Person resource.'
6052 description: 'The family name of the Person resource.'
6059 description: 'The given name of the Person resource.'
6066 description: 'The phone number of the Person resource.'
6073 description: 'The fax number of the Person resource.'
6079 description: 'Standard Response'
6084 'json object': { description: 'FHIR Json object.', type: object }
6087 meta: { lastUpdated: '2021-09-14T09:13:51' }
6088 resourceType: Bundle
6091 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Person' }]
6093 $ref: '#/components/responses/badrequest'
6095 $ref: '#/components/responses/unauthorized'
6099 '/fhir/Person/{uuid}':
6103 description: 'Returns a single Person resource.'
6108 description: 'The uuid for the Person resource.'
6114 description: 'Standard Response'
6119 'json object': { description: 'FHIR Json object.', type: object }
6122 id: 960c7cd6-187a-4119-8cd4-85389d80efb9
6123 meta: { versionId: '1', lastUpdated: '2022-04-13T08:57:32+00:00' }
6124 resourceType: Person
6125 text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Administrator Administrator</p></div>' }
6126 name: [{ use: official, family: Administrator, given: [Administrator, Larry] }]
6127 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 }]
6128 address: [{ line: ['123 Lane Street'], city: Bellevue, state: WA, period: { start: '2021-04-13T08:57:32.146+00:00' } }]
6131 $ref: '#/components/responses/badrequest'
6133 $ref: '#/components/responses/unauthorized'
6135 $ref: '#/components/responses/uuidnotfound'
6143 description: 'Returns a list of Practitioner resources.'
6148 description: 'The uuid for the Practitioner resource.'
6155 description: 'The name of the Practitioner resource.'
6162 description: 'The active status of the Practitioner resource.'
6169 description: 'The address of the Practitioner resource.'
6176 description: 'The address-city of the Practitioner resource.'
6181 name: address-postalcode
6183 description: 'The address-postalcode of the Practitioner resource.'
6190 description: 'The address-state of the Practitioner resource.'
6197 description: 'The email of the Practitioner resource.'
6204 description: 'The family name of the Practitioner resource.'
6211 description: 'The given name of the Practitioner resource.'
6218 description: 'The phone number of the Practitioner resource.'
6225 description: 'The fax number of the Practitioner resource.'
6231 description: 'Standard Response'
6236 'json object': { description: 'FHIR Json object.', type: object }
6239 meta: { lastUpdated: '2021-09-14T09:13:51' }
6240 resourceType: Bundle
6243 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Practitioner' }]
6245 $ref: '#/components/responses/badrequest'
6247 $ref: '#/components/responses/unauthorized'
6254 description: 'Adds a Practitioner resources.'
6260 description: 'The json object for the Practitioner resource.'
6263 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6266 lastUpdated: '2021-09-21T17:41:57+00:00'
6267 resourceType: Practitioner
6270 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
6273 system: 'http://hl7.org/fhir/sid/us-npi'
6274 value: '11223344554543'
6283 description: 'Standard Response'
6288 'json object': { description: 'FHIR Json object.', type: object }
6291 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6292 meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
6293 resourceType: Practitioner
6294 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
6295 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
6297 name: [{ use: official, family: Smith, given: [Danny] }]
6299 $ref: '#/components/responses/badrequest'
6301 $ref: '#/components/responses/unauthorized'
6305 '/fhir/Practitioner/{uuid}':
6309 description: 'Returns a single Practitioner resource.'
6314 description: 'The uuid for the Practitioner resource.'
6320 description: 'Standard Response'
6325 'json object': { description: 'FHIR Json object.', type: object }
6328 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6329 meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
6330 resourceType: Practitioner
6331 text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
6332 identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
6334 name: [{ use: official, family: Smith, given: [Billy] }]
6336 $ref: '#/components/responses/badrequest'
6338 $ref: '#/components/responses/unauthorized'
6340 $ref: '#/components/responses/uuidnotfound'
6347 description: 'Modify a Practitioner resource.'
6352 description: 'The uuid for the Practitioner resource.'
6361 description: 'The json object for the Practitioner resource.'
6364 id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6367 lastUpdated: '2021-09-21T17:41:57+00:00'
6368 resourceType: Practitioner
6371 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
6374 system: 'http://hl7.org/fhir/sid/us-npi'
6375 value: '11223344554543'
6384 description: 'Standard Response'
6390 uuid: 95f294d7-e14c-441d-81a6-309fe369ee21
6392 $ref: '#/components/responses/badrequest'
6394 $ref: '#/components/responses/unauthorized'
6398 /fhir/PractitionerRole:
6402 description: 'Returns a list of PractitionerRole resources.'
6407 description: 'The specialty of the PractitionerRole resource.'
6414 description: 'The practitioner of the PractitionerRole resource.'
6420 description: 'Standard Response'
6425 'json object': { description: 'FHIR Json object.', type: object }
6428 meta: { lastUpdated: '2021-09-14T09:13:51' }
6429 resourceType: Bundle
6432 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/PractitionerRole' }]
6434 $ref: '#/components/responses/badrequest'
6436 $ref: '#/components/responses/unauthorized'
6440 '/fhir/PractitionerRole/{uuid}':
6444 description: 'Returns a single PractitionerRole resource.'
6449 description: 'The uuid for the PractitionerRole resource.'
6455 description: 'Standard Response'
6460 'json object': { description: 'FHIR Json object.', type: object }
6463 id: 960c806f-9463-482e-b228-67b5be1fed55
6464 meta: { versionId: '1', lastUpdated: '2022-04-13T06:18:17+00:00' }
6465 resourceType: PractitionerRole
6466 practitioner: { reference: Practitioner/960c7cd6-187a-4119-8cd4-85389d80efb9, display: 'Administrator Administrator' }
6467 organization: { reference: Organization/960c7cc6-b4ae-49bc-877b-1a2913271c43, display: 'Your Clinic Name Here' }
6468 code: [{ coding: [102L00000X], text: Psychoanalyst }, { coding: [101Y00000X], text: Counselor }]
6470 $ref: '#/components/responses/badrequest'
6472 $ref: '#/components/responses/unauthorized'
6474 $ref: '#/components/responses/uuidnotfound'
6482 description: 'Returns a list of Procedure resources.'
6487 description: 'The uuid for the Procedure resource.'
6494 description: 'The uuid for the patient.'
6501 description: 'The datetime of the Procedure resource.'
6507 description: 'Standard Response'
6512 'json object': { description: 'FHIR Json object.', type: object }
6515 meta: { lastUpdated: '2021-09-14T09:13:51' }
6516 resourceType: Bundle
6519 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Procedure' }]
6521 $ref: '#/components/responses/badrequest'
6523 $ref: '#/components/responses/unauthorized'
6527 '/fhir/Procedure/{uuid}':
6531 description: 'Returns a single Procedure resource.'
6536 description: 'The uuid for the Procedure resource.'
6542 description: 'Standard Response'
6547 'json object': { description: 'FHIR Json object.', type: object }
6550 id: 95e9d3fb-fe7b-448a-aa60-d40b11b486a5
6551 meta: { versionId: '1', lastUpdated: '2022-03-26T17:20:14+00:00' }
6552 resourceType: Procedure
6554 subject: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf, type: Patient }
6556 $ref: '#/components/responses/badrequest'
6558 $ref: '#/components/responses/unauthorized'
6560 $ref: '#/components/responses/uuidnotfound'
6564 '/fhir/Provenance/{uuid}':
6568 description: 'Returns a single Provenance resource.'
6573 description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6579 description: 'Standard Response'
6584 'json object': { description: 'FHIR Json object.', type: object }
6587 id: 'AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145'
6588 resourceType: Provenance
6589 target: [{ reference: AllergyIntolerance/95ea43f3-1066-4bc7-b224-6c23b985f145, type: AllergyIntolerance }]
6590 recorded: '2022-03-26T22:43:30+00:00'
6591 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 } }
6593 $ref: '#/components/responses/badrequest'
6595 $ref: '#/components/responses/unauthorized'
6597 $ref: '#/components/responses/uuidnotfound'
6605 description: 'Returns a list of Provenance resources.'
6610 description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6616 description: 'Standard Response'
6621 'json object': { description: 'FHIR Json object.', type: object }
6624 meta: { lastUpdated: '2021-09-14T09:13:51' }
6625 resourceType: Bundle
6628 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Provenance' }]
6630 $ref: '#/components/responses/badrequest'
6632 $ref: '#/components/responses/unauthorized'
6640 description: 'Returns a list of ValueSet resources.'
6645 description: 'The uuid for the ValueSet resource.'
6651 description: 'Standard Response'
6656 'json object': { description: 'FHIR Json object.', type: object }
6659 meta: { lastUpdated: '2021-09-14T09:13:51' }
6660 resourceType: Bundle
6663 link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/ValueSet' }]
6665 $ref: '#/components/responses/badrequest'
6667 $ref: '#/components/responses/unauthorized'
6671 '/fhir/ValueSet/{uuid}':
6675 description: 'Returns a single ValueSet resource.'
6680 description: 'The uuid for the ValueSet resource.'
6686 description: 'Standard Response'
6691 'json object': { description: 'FHIR Json object.', type: object }
6694 resourceType: ValueSet
6695 id: appointment-type
6696 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' }] }] }
6698 $ref: '#/components/responses/badrequest'
6700 $ref: '#/components/responses/unauthorized'
6702 $ref: '#/components/responses/uuidnotfound'
6710 description: 'Returns metadata (ie. CapabilityStatement resource) of the fhir server.'
6713 description: 'Return CapabilityStatement resource of the fhir server'
6714 /fhir/.well-known/smart-configuration:
6718 description: 'Returns smart configuration of the fhir server.'
6721 description: 'Return smart configuration of the fhir server'
6722 /fhir/OperationDefinition:
6726 description: 'Returns a list of the OperationDefinition resources that are specific to this OpenEMR installation'
6729 description: 'Return list of OperationDefinition resources'
6730 '/fhir/OperationDefinition/{operation}':
6734 description: 'Returns a single OperationDefinition resource that is specific to this OpenEMR installation'
6739 description: 'The name of the operation to query. For example $bulkdata-status'
6745 description: 'Standard Response'
6750 'json object': { description: 'FHIR Json object.', type: object }
6753 resourceType: OperationDefinition
6754 name: $bulkdata-status
6757 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 } }]
6762 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>'
6765 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>'
6767 $ref: '#/components/responses/badrequest'
6769 $ref: '#/components/responses/unauthorized'
6773 /fhir/$bulkdata-status:
6777 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>'
6780 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>'
6782 $ref: '#/components/responses/badrequest'
6784 $ref: '#/components/responses/unauthorized'
6791 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>'
6794 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>'
6796 $ref: '#/components/responses/badrequest'
6798 $ref: '#/components/responses/unauthorized'
6806 description: 'Returns the patient.'
6809 description: 'Standard response'
6813 $ref: '#/components/schemas/api_patient_response'
6815 $ref: '#/components/responses/unauthorized'
6819 /portal/patient/encounter:
6823 description: 'Returns encounters for the patient.'
6826 $ref: '#/components/responses/standard'
6828 $ref: '#/components/responses/badrequest'
6830 $ref: '#/components/responses/unauthorized'
6834 '/portal/patient/encounter/{euuid}':
6838 description: 'Returns a selected encounter by its uuid.'
6843 description: 'The uuid for the encounter.'
6849 $ref: '#/components/responses/standard'
6851 $ref: '#/components/responses/badrequest'
6853 $ref: '#/components/responses/unauthorized'
6857 /portal/patient/appointment:
6861 description: 'Retrieves all appointments for a patient'
6864 $ref: '#/components/responses/standard'
6866 $ref: '#/components/responses/badrequest'
6868 $ref: '#/components/responses/unauthorized'
6872 '/portal/patient/appointment/{auuid}':
6876 description: 'Returns a selected appointment by its uuid.'
6881 description: 'The uuid for the appointment.'
6887 $ref: '#/components/responses/standard'
6889 $ref: '#/components/responses/badrequest'
6891 $ref: '#/components/responses/unauthorized'
6897 api_patient_request:
6898 description: 'Schema for the patient request'
6906 description: 'The title of patient.'
6909 description: 'The fname of patient.'
6912 description: 'The mname of patient.'
6915 description: 'The lname of patient.'
6918 description: 'The street address of patient.'
6921 description: 'The postal code of patient.'
6924 description: 'The city of patient.'
6927 description: 'The state of patient.'
6930 description: 'The country code of patient.'
6933 description: 'The phone contact of patient.'
6936 description: 'The DOB of patient.'
6939 description: 'The lname of patient.'
6942 description: 'The race of patient.'
6945 description: 'The ethnicity of patient.'
6953 street: '456 Tree Lane'
6954 postal_code: '08642'
6958 phone_contact: 123-456-7890
6963 api_patient_response:
6964 description: 'Schema for the patient response'
6967 description: 'Validation errors.'
6972 description: 'Internal errors.'
6977 description: 'Returned data.'
6982 description: 'patient id'
6985 description: 'patient pid'
6988 description: 'patient public id'
6991 description: 'patient title'
6994 description: 'patient first name'
6997 description: 'patient middle name'
7000 description: 'patient last name'
7003 description: 'patient social security number'
7006 description: 'patient street address'
7009 description: 'patient postal code'
7012 description: 'patient city'
7015 description: 'patient state'
7018 description: 'patient county'
7021 description: 'patient country code'
7024 description: 'patient drivers license id'
7026 contact_relationship:
7027 description: 'patient contact relationship'
7030 description: 'patient phone contact'
7033 description: 'patient home phone'
7036 description: 'patient work phone'
7039 description: 'patient mobile phone'
7042 description: 'patient email'
7045 description: 'patient DOB'
7048 description: 'patient sex (gender)'
7051 description: 'patient race'
7054 description: 'patient ethnicity'
7057 description: 'patient status'
7062 validationErrors: []
7063 error_description: []
7073 street: '456 Tree Lane'
7074 postal_code: '08642'
7080 contact_relationship: ''
7081 phone_contact: 123-456-7890
7091 api_encounter_request:
7092 description: 'Schema for the encounter request'
7098 description: 'The date of encounter.'
7101 description: 'The onset date of encounter.'
7104 description: 'The reason of encounter.'
7107 description: 'The facility of encounter.'
7110 description: 'The pc_catid of encounter.'
7113 description: 'The facility id of encounter.'
7116 description: 'The billing facility id of encounter.'
7119 description: 'The sensitivity of encounter.'
7122 description: 'The referral source of encounter.'
7125 description: 'The pos_code of encounter.'
7128 description: 'The external id of encounter.'
7131 description: 'The provider id of encounter.'
7134 description: 'The class_code of encounter.'
7140 reason: 'Pregnancy Test'
7141 facility: 'Owerri General Hospital'
7144 billing_facility: '3'
7151 api_encounter_response:
7152 description: 'Schema for the encounter response'
7155 description: 'Validation errors.'
7160 description: 'Internal errors.'
7165 description: 'Returned data.'
7170 description: 'encounter id'
7173 description: 'encounter uuid'
7176 description: 'encounter date'
7179 description: 'encounter reason'
7182 description: 'encounter facility name'
7185 description: 'encounter facility id name'
7188 description: 'encounter for patient pid'
7191 description: 'encounter onset date'
7194 description: 'encounter sensitivity'
7197 description: 'encounter billing note'
7200 description: 'encounter pc_catid'
7203 description: 'encounter last_level_billed'
7206 description: 'encounter last_level_closed'
7209 description: 'encounter last_stmt_date'
7212 description: 'encounter stmt_count'
7215 description: 'provider id'
7218 description: 'encounter supervisor id'
7221 description: 'encounter invoice_refno'
7224 description: 'encounter referral source'
7227 description: 'encounter billing facility id'
7230 description: 'encounter external id'
7233 description: 'encounter pos_code'
7236 description: 'encounter class_code'
7239 description: 'encounter class_title'
7242 description: 'encounter pc_catname'
7244 billing_facility_name:
7245 description: 'encounter billing facility name'
7250 validationErrors: []
7251 error_description: []
7254 uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef
7255 date: '2019-09-14 00:00:00'
7256 reason: 'Pregnancy Test'
7257 facility: 'Owerri General Hospital'
7260 onset_date: '2019-04-20 00:00:00'
7264 last_level_billed: '0'
7265 last_level_closed: '0'
7266 last_stmt_date: null
7272 billing_facility: '3'
7276 class_title: ambulatory
7277 pc_catname: 'Office Visit'
7278 billing_facility_name: 'Owerri General Hospital'
7280 description: 'Schema for the vital request'
7283 description: 'The bps of vitals.'
7286 description: 'The bpd of vitals.'
7289 description: 'The weight of vitals. (unit is lb)'
7292 description: 'The height of vitals. (unit is inches)'
7295 description: 'The temperature of temperature. (unit is F)'
7298 description: 'The temp_method of vitals.'
7301 description: 'The pulse of vitals.'
7304 description: 'The respiration of vitals.'
7307 description: 'The note (ie. comments) of vitals.'
7310 description: 'The waist circumference of vitals. (unit is inches)'
7313 description: 'The head circumference of vitals. (unit is inches)'
7316 description: 'The oxygen_saturation of vitals.'
7328 note: 'Patient with difficulty standing, which made weight measurement difficult.'
7331 oxygen_saturation: '96'
7332 api_soap_note_request:
7333 description: 'Schema for the soap_note request'
7336 description: 'The subjective of soap note.'
7339 description: 'The objective of soap note.'
7342 description: 'The assessment of soap note.'
7345 description: 'The plan of soap note.'
7349 subjective: 'The patient with mechanical fall and cut finger.'
7350 objective: 'The patient with finger laceration on exam.'
7351 assessment: 'The patient with finger laceration requiring sutures.'
7352 plan: 'Sutured finger laceration.'
7353 api_medical_problem_request:
7354 description: 'Schema for the medical_problem request'
7360 description: 'The title of medical problem.'
7363 description: 'The beginning date of medical problem.'
7366 description: 'The end date of medical problem.'
7369 description: 'The diagnosis of medical problem. In format `<codetype>:<code>`'
7373 title: Dermatochalasis
7374 begdate: '2010-10-13'
7376 diagnosis: 'ICD10:H02.839'
7377 api_allergy_request:
7378 description: 'Schema for the allergy request'
7384 description: 'The title of allergy.'
7387 description: 'The beginning date of allergy.'
7390 description: 'The end date of allergy.'
7393 description: 'The diagnosis of allergy. In format `<codetype>:<code>`'
7398 begdate: '2010-10-13'
7400 api_medication_request:
7401 description: 'Schema for the medication request'
7407 description: 'The title of medication.'
7410 description: 'The beginning date of medication.'
7413 description: 'The end date of medication.'
7416 description: 'The diagnosis of medication. In format `<codetype>:<code>`'
7421 begdate: '2013-04-13'
7423 api_surgery_request:
7424 description: 'Schema for the surgery request'
7430 description: 'The title of surgery.'
7433 description: 'The beginning date of surgery.'
7436 description: 'The end date of surgery.'
7439 description: 'The diagnosis of surgery. In format `<codetype>:<code>`'
7443 title: Blepharoplasty
7444 begdate: '2013-10-14'
7446 diagnosis: 'CPT4:15823-50'
7447 api_dental_issue_request:
7448 description: 'Schema for the dental_issue request'
7454 description: 'The title of dental issue.'
7457 description: 'The beginning date of dental issue.'
7460 description: 'The end date of dental issue.'
7463 description: 'The diagnosis of dental issue. In format `<codetype>:<code>`'
7468 begdate: '2015-03-17'
7470 api_insurance_company_request:
7471 description: 'Schema for the insurance_company request'
7476 description: 'The name of insurance company.'
7479 description: 'The attn of insurance company.'
7482 description: 'The cms id of insurance company.'
7485 description: 'The insurance type code of insurance company. The insurance type code can be found by inspecting the route at (/api/insurance_type).'
7488 description: 'The x12 receiver id of insurance company.'
7490 x12_default_partner_id:
7491 description: 'The x12 default partner id of insurance company.'
7494 description: 'The alternate cms id of insurance company.'
7497 description: 'The line1 address of insurance company.'
7500 description: 'The line2 address of insurance company.'
7503 description: 'The city of insurance company.'
7506 description: 'The state of insurance company.'
7509 description: 'The zip of insurance company.'
7512 description: 'The country of insurance company.'
7516 name: 'Cool Insurance Company'
7520 x12_receiver_id: null
7521 x12_default_partner_id: null
7523 line1: '123 Cool Lane'
7529 api_insurance_request:
7530 description: "Schema for the insurance request. Note the following additional validation checks on the request.\nIf the subscriber_relationship value is of type 'self' then the subscriber_fname and subscriber_lname fields\nmust match the patient's first and last name or a patient's previous first and last name.\n\nIf the subscriber_relationship value is of type 'self' then the subscriber_ss field must match the patient's\nsocial security number.\n\nIf the subscriber_relationship value is not of type 'self' then the subscriber_ss field MUST not be the current patient's social security number.\n\nIf the system's global configuration permits only a single insurance type option then any insurance rquest where the type is NOT 'primary' will fail.\n\nAn insurance is considered the current policy for the policy type if the policy date_end field is null. Only one of these records per policy type can exist for a patient."
7536 - subscriber_relationship
7540 - subscriber_postal_code
7543 - subscriber_country
7548 description: 'The insurance company id.'
7551 description: 'The plan name of insurance. (2-255 characters)'
7554 description: 'The policy number of insurance. (2-255 characters)'
7557 description: 'The group number of insurance.(2-255 characters)'
7560 description: 'The subscriber last name of insurance.(2-255 characters).'
7563 description: 'The subscriber middle name of insurance.'
7566 description: 'The subscriber first name of insurance.'
7568 subscriber_relationship:
7569 description: 'The subscriber relationship of insurance. `subscriber_relationship` can be found by querying `resource=/api/list/subscriber_relationship`'
7572 description: 'The subscriber ss number of insurance.'
7575 description: 'The subscriber DOB of insurance.'
7578 description: 'The subscriber street address of insurance.'
7580 subscriber_postal_code:
7581 description: 'The subscriber postal code of insurance.'
7584 description: 'The subscriber city of insurance.'
7587 description: 'The subscriber state of insurance. `state` can be found by querying `resource=/api/list/state`'
7590 description: 'The subscriber country of insurance. `country` can be found by querying `resource=/api/list/country`'
7593 description: 'The subscriber phone of insurance.'
7595 subscriber_employer:
7596 description: 'The subscriber employer of insurance.'
7598 subscriber_employer_street:
7599 description: 'The subscriber employer street of insurance.'
7601 subscriber_employer_postal_code:
7602 description: 'The subscriber employer postal code of insurance.'
7604 subscriber_employer_state:
7605 description: 'The subscriber employer state of insurance.'
7607 subscriber_employer_country:
7608 description: 'The subscriber employer country of insurance.'
7610 subscriber_employer_city:
7611 description: 'The subscriber employer city of insurance.'
7614 description: 'The copay of insurance.'
7617 description: 'The effective date of insurance in YYYY-MM-DD format. This value cannot be after the date_end property and cannot be the same date as any other insurance policy for the same insurance type (''primary, ''secondary'', etc).'
7620 description: 'The effective end date of insurance in YYYY-MM-DD format. This value cannot be before the date property. If it is null then this policy is the current policy for this policy type for the patient. There can only be one current policy per type and the request will fail if there is already a current policy for this type.'
7623 description: 'The subscriber sex of insurance.'
7626 description: 'The accept_assignment of insurance.'
7629 description: 'The 837p list of policy types for an insurance. See src/Billing/InsurancePolicyType.php for the list of valid values.'
7632 description: 'The type or category of OpenEMR insurance policy, ''primary'', ''secondary'', or ''tertiary''. If this field is missing it will default to ''primary''.'
7637 plan_name: 'Some Plan'
7638 policy_number: '12345'
7639 group_number: '252412'
7640 subscriber_lname: Tester
7641 subscriber_mname: Xi
7642 subscriber_fname: Foo
7643 subscriber_relationship: other
7644 subscriber_ss: '234231234'
7645 subscriber_DOB: '2018-10-03'
7646 subscriber_street: '183 Cool St'
7647 subscriber_postal_code: '23418'
7648 subscriber_city: Cooltown
7649 subscriber_state: AZ
7650 subscriber_country: USA
7651 subscriber_phone: 234-598-2123
7652 subscriber_employer: 'Some Employer'
7653 subscriber_employer_street: '123 Heather Lane'
7654 subscriber_employer_postal_code: '23415'
7655 subscriber_employer_state: AZ
7656 subscriber_employer_country: USA
7657 subscriber_employer_city: Cooltown
7660 subscriber_sex: Female
7661 accept_assignment: 'TRUE'
7664 api_message_request:
7665 description: 'Schema for the message request'
7675 description: 'The body of message.'
7678 description: 'The group name (usually is ''Default'').'
7681 description: 'The sender of the message.'
7684 description: 'The recipient of the message.'
7687 description: 'use an option from resource=/api/list/note_type'
7690 description: 'use an option from resource=/api/list/message_status'
7700 api_transaction_request:
7701 description: 'Schema for the transaction request'
7708 description: 'The message of the transaction.'
7711 description: 'The type of transaction. Use an option from resource=/api/transaction_type'
7714 description: 'The group name (usually is ''Default'').'
7717 description: 'NPI of the person creating the referral.'
7720 description: 'NPI of the person getting the referral.'
7723 description: 'The referral diagnosis.'
7726 description: 'The risk level. (Low, Medium, High)'
7729 description: 'Are vitals included (0,1)'
7732 description: 'The date of the referral'
7735 description: 'The authorization for the referral'
7738 description: 'The number of vists for the referral'
7741 description: 'The date the referral is valid from'
7744 description: 'The date the referral is valid through'
7751 referByNpi: '9999999999'
7752 referToNpi: '9999999999'
7753 referDiagnosis: 'Diag 1'
7756 referralDate: '2022-01-01'
7757 authorization: Auth_123
7759 validFrom: '2022-01-02'
7760 validThrough: '2022-01-03'
7764 description: 'Standard Response'
7770 description: 'Validation errors.'
7775 description: 'Internal errors.'
7780 description: 'Returned data.'
7786 validationErrors: []
7787 error_description: []
7790 description: 'Bad Request'
7796 description: 'Validation errors.'
7801 _id: 'The search field argument was invalid, improperly formatted, or could not be parsed. Inner message: UUID columns must be a valid UUID string'
7803 description: Unauthorized
7809 description: 'The error.'
7812 description: 'The description of the error.'
7815 description: 'More specific information on the error.'
7818 description: 'Message regarding the error.'
7822 error: access_denied
7823 error_description: 'The resource owner or authorization server denied the request.'
7824 hint: 'Missing "Authorization" header'
7825 message: 'The resource owner or authorization server denied the request.'
7827 description: 'Not Found'
7841 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)'
7848 description: 'The date the resource was last updated.'
7857 authorizationUrl: /oauth2/default/authorize
7858 tokenUrl: /oauth2/default/token
7859 refreshUrl: /oauth2/default/token
7861 openid: 'Generic mandatory scope'
7862 offline_access: 'Will signal server to provide a refresh token'
7863 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)'
7864 'api:fhir': 'FHIR R4 API'
7865 patient/AllergyIntolerance.read: 'Read allergy intolerance resources for the current patient (api:fhir)'
7866 patient/Appointment.read: 'Read appointment resources for the current patient (api:fhir)'
7867 patient/Binary.read: 'Read binary document resources for the current patient (api:fhir)'
7868 patient/CarePlan.read: 'Read care plan resources for the current patient (api:fhir)'
7869 patient/CareTeam.read: 'Read care team resources for the current patient (api:fhir)'
7870 patient/Condition.read: 'Read condition resources for the current patient (api:fhir)'
7871 patient/Coverage.read: 'Read coverage resources for the current patient (api:fhir)'
7872 patient/Device.read: 'Read device resources for the current patient (api:fhir)'
7873 patient/DiagnosticReport.read: 'Read diagnostic report resources for the current patient (api:fhir)'
7874 patient/DocumentReference.read: 'Read document reference resources for the current patient (api:fhir)'
7875 patient/DocumentReference.$docref: 'Generate a document for the current patient or returns the most current Clinical Summary of Care Document (CCD)'
7876 patient/Encounter.read: 'Read encounter resources for the current patient (api:fhir)'
7877 patient/Goal.read: 'Read goal resources for the current patient (api:fhir)'
7878 patient/Immunization.read: 'Read immunization resources for the current patient (api:fhir)'
7879 patient/Location.read: 'Read location resources for the current patient (api:fhir)'
7880 patient/Medication.read: 'Read medication resources for the current patient (api:fhir)'
7881 patient/MedicationRequest.read: 'Read medication request resources for the current patient (api:fhir)'
7882 patient/Observation.read: 'Read observation resources for the current patient (api:fhir)'
7883 patient/Organization.read: 'Read organization resources for the current patient (api:fhir)'
7884 patient/Patient.read: 'Read patient resource for the current patient (api:fhir)'
7885 patient/Person.read: 'Read person resources for the current patient (api:fhir)'
7886 patient/Practitioner.read: 'Read practitioner resources for the current patient (api:fhir)'
7887 patient/Procedure.read: 'Read procedure resources for the current patient (api:fhir)'
7888 patient/Provenance.read: 'Read provenance resources for the current patient (api:fhir)'
7889 system/AllergyIntolerance.read: 'Read all allergy intolerance resources in the system (api:fhir)'
7890 system/Binary.read: 'Read all binary document resources in the system (api:fhir)'
7891 system/CarePlan.read: 'Read all care plan resources in the system (api:fhir)'
7892 system/CareTeam.read: 'Read all care team resources in the system (api:fhir)'
7893 system/Condition.read: 'Read all condition resources in the system (api:fhir)'
7894 system/Coverage.read: 'Read all coverage resources in the system (api:fhir)'
7895 system/Device.read: 'Read all device resources in the system (api:fhir)'
7896 system/DiagnosticReport.read: 'Read all diagnostic report resources in the system (api:fhir)'
7897 system/DocumentReference.read: 'Read all document reference resources in the system (api:fhir)'
7898 system/DocumentReference.$docref: 'Generate a document for any patient in the system or returns the most current Clinical Summary of Care Document (CCD)'
7899 system/Encounter.read: 'Read all encounter resources in the system (api:fhir)'
7900 system/Goal.read: 'Read all goal resources in the system (api:fhir)'
7901 system/Group.read: 'Read all group resources in the system (api:fhir)'
7902 system/Immunization.read: 'Read all immunization resources in the system (api:fhir)'
7903 system/Location.read: 'Read all location resources in the system (api:fhir)'
7904 system/Medication.read: 'Read all medication resources in the system (api:fhir)'
7905 system/MedicationRequest.read: 'Read all medication request resources in the system (api:fhir)'
7906 system/Observation.read: 'Read all observation resources in the system (api:fhir)'
7907 system/Organization.read: 'Read all organization resources in the system (api:fhir)'
7908 system/Patient.read: 'Read all patient resources in the system (api:fhir)'
7909 system/Person.read: 'Read all person resources in the system (api:fhir)'
7910 system/Practitioner.read: 'Read all practitioner resources in the system (api:fhir)'
7911 system/PractitionerRole.read: 'Read all practitioner role resources in the system (api:fhir)'
7912 system/Procedure.read: 'Read all procedure resources in the system (api:fhir)'
7913 system/Provenance.read: 'Read all provenance resources in the system (api:fhir)'
7914 system/ValueSet.read: 'Read all valueSet resources in the system (api:fhir)'
7915 user/AllergyIntolerance.read: 'Read all allergy intolerance resources the user has access to (api:fhir)'
7916 user/Binary.read: 'Read all binary documents the user has access to (api:fhir)'
7917 user/CarePlan.read: 'Read all care plan resources the user has access to (api:fhir)'
7918 user/CareTeam.read: 'Read all care team resources the user has access to (api:fhir)'
7919 user/Condition.read: 'Read all condition resources the user has access to (api:fhir)'
7920 user/Coverage.read: 'Read all coverage resources the user has access to (api:fhir)'
7921 user/Device.read: 'Read all device resources the user has access to (api:fhir)'
7922 user/DiagnosticReport.read: 'Read all diagnostic report resources the user has access to (api:fhir)'
7923 user/DocumentReference.read: 'Read all document reference resources the user has access to (api:fhir)'
7924 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)'
7925 user/Encounter.read: 'Read all encounter resources the user has access to (api:fhir)'
7926 user/Goal.read: 'Read all goal resources the user has access to (api:fhir)'
7927 user/Immunization.read: 'Read all immunization resources the user has access to (api:fhir)'
7928 user/Location.read: 'Read all location resources the user has access to (api:fhir)'
7929 user/Medication.read: 'Read all medication resources the user has access to (api:fhir)'
7930 user/MedicationRequest.read: 'Read all medication request resources the user has access to (api:fhir)'
7931 user/Observation.read: 'Read all observation resources the user has access to (api:fhir)'
7932 user/Organization.read: 'Read all organization resources the user has access to (api:fhir)'
7933 user/Organization.write: 'Write all organization resources the user has access to (api:fhir)'
7934 user/Patient.read: 'Read all patient resources the user has access to (api:fhir)'
7935 user/Patient.write: 'Write all patient resources the user has access to (api:fhir)'
7936 user/Person.read: 'Read all person resources the user has access to (api:fhir)'
7937 user/Practitioner.read: 'Read all practitioner resources the user has access to (api:fhir)'
7938 user/Practitioner.write: 'Write all practitioner resources the user has access to (api:fhir)'
7939 user/PractitionerRole.read: 'Read all practitioner role resources the user has access to (api:fhir)'
7940 user/Procedure.read: 'Read all procedure resources the user has access to (api:fhir)'
7941 user/Provenance.read: 'Read all provenance resources the user has access to (api:fhir)'
7942 user/ValueSet.read: 'Read all valueSet resources the user has access to (api:fhir)'
7943 'api:oemr': 'Standard OpenEMR API'
7944 user/allergy.read: 'Read allergies the user has access to (api:oemr)'
7945 user/allergy.write: 'Write allergies the user has access to for (api:oemr)'
7946 user/appointment.read: 'Read appointments the user has access to (api:oemr)'
7947 user/appointment.write: 'Write appointments the user has access to for (api:oemr)'
7948 user/dental_issue.read: 'Read dental issues the user has access to (api:oemr)'
7949 user/dental_issue.write: 'Write dental issues the user has access to (api:oemr)'
7950 user/document.read: 'Read documents the user has access to (api:oemr)'
7951 user/document.write: 'Write documents the user has access to (api:oemr)'
7952 user/drug.read: 'Read drugs the user has access to (api:oemr)'
7953 user/encounter.read: 'Read encounters the user has access to (api:oemr)'
7954 user/encounter.write: 'Write encounters the user has access to (api:oemr)'
7955 user/facility.read: 'Read facilities the user has access to (api:oemr)'
7956 user/facility.write: 'Write facilities the user has access to (api:oemr)'
7957 user/immunization.read: 'Read immunizations the user has access to (api:oemr)'
7958 user/insurance.read: 'Read insurances the user has access to (api:oemr)'
7959 user/insurance.write: 'Write insurances the user has access to (api:oemr)'
7960 user/insurance_company.read: 'Read insurance companies the user has access to (api:oemr)'
7961 user/insurance_company.write: 'Write insurance companies the user has access to (api:oemr)'
7962 user/insurance_type.read: 'Read insurance types the user has access to (api:oemr)'
7963 user/list.read: 'Read lists the user has access to (api:oemr)'
7964 user/medical_problem.read: 'Read medical problems the user has access to (api:oemr)'
7965 user/medical_problem.write: 'Write medical problems the user has access to (api:oemr)'
7966 user/medication.read: 'Read medications the user has access to (api:oemr)'
7967 user/medication.write: 'Write medications the user has access to (api:oemr)'
7968 user/message.write: 'Read messages the user has access to (api:oemr)'
7969 user/patient.read: 'Read patients the user has access to (api:oemr)'
7970 user/patient.write: 'Write patients the user has access to (api:oemr)'
7971 user/practitioner.read: 'Read practitioners the user has access to (api:oemr)'
7972 user/practitioner.write: 'Write practitioners the user has access to (api:oemr)'
7973 user/prescription.read: 'Read prescriptions the user has access to (api:oemr)'
7974 user/procedure.read: 'Read procedures the user has access to (api:oemr)'
7975 user/soap_note.read: 'Read soap notes the user has access to (api:oemr)'
7976 user/soap_note.write: 'Write soap notes the user has access to (api:oemr)'
7977 user/surgery.read: 'Read surgeries the user has access to (api:oemr)'
7978 user/surgery.write: 'Write surgeries the user has access to (api:oemr)'
7979 user/transaction.read: 'Read transactions the user has access to (api:oemr)'
7980 user/transaction.write: 'Write transactions the user has access to (api:oemr)'
7981 user/user.read: 'Read users the current user has access to (api:oemr)'
7982 user/vital.read: 'Read vitals the user has access to (api:oemr)'
7983 user/vital.write: 'Write vitals the user has access to (api:oemr)'
7984 'api:port': 'Standard Patient Portal OpenEMR API'
7985 patient/encounter.read: 'Read encounters the patient has access to (api:port)'
7986 patient/patient.read: 'Write encounters the patient has access to (api:port)'
7987 patient/appointment.read: 'Read appointments the patient has access to (api:port)'
7991 description: 'FHIR R4 API'
7994 description: 'Standard OpenEMR API'
7996 name: standard-patient
7997 description: 'Standard Patient Portal OpenEMR API'