API_README.md

   1 # OpenEMR REST API Documentation
   2
   3 ## Overview
   4
   5 Easy-to-use JSON-based REST API for OpenEMR. All code is done in classes and separate from the view to help with codebase modernization efforts. FHIR is also supported, see FHIR API documentation [here](FHIR_README.md)
   6
   7 ### Sections
   8 * [facility API](API_README.md#post-apifacility)
   9 * [provider API](API_README.md#get-apiprovider)
  10 * [patient API](API_README.md#post-apipatient)
  11 * [insurance API](API_README.md#get-apipatientpidinsurance)
  12 * [appointment API](API_README.md#get-apiappointment)
  13 * [document API](API_README.md#get-apipatientpiddocument)
  14 * [message API](API_README.md#post-apipatientpidmessage)
  15 * [dev notes](API_README.md#dev-notes)
  16 * [todos](API_README.md#project-management)
  17
  18 ### Prerequisite
  19 Enable this API service in OpenEMR menu: Administration->Globals->Connectors->"Enable OpenEMR REST API"
  20
  21 ### Using API Internally
  22 There are several ways to make API calls from an authorized session and maintain security:
  23 * See the script at tests/api/InternalApiTest.php for examples of internal API use cases.
  24
  25 ### Endpoints
  26 OpenEMR standard endpoints Use `http://localhost:8300/apis/ as base URI.`
  27
  28 _Example:_ `http://localhost:8300/apis/api/patient` returns a resource of all Patients.
  29 #### POST /apis/auth
  30
  31 The OpenEMR API utilizes the OAuth2 password credential flow for authentication. To obtain an API token, submit your login credentials and requested scope. The scope must match a site that has been setup in OpenEMR, in the /sites/ directory.  If additional sites have not been created, set the scope
  32 to 'default'.
  33
  34 ```sh
  35 curl -X POST -H 'Content-Type: application/json' 'http://localhost:8300/apis/api/auth' \
  36 -d '{
  37     "grant_type":"password",
  38     "username": "ServiceUser",
  39     "password": "password",
  40     "scope":"site id"
  41 }'
  42 ```
  43 Response:
  44 ```json
  45 {
  46     "token_type": "Bearer",
  47     "access_token": "eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ==",
  48     "expires_in": "3600",
  49     "user_data": {
  50         "user_id": "1"
  51     }
  52 }
  53 ```
  54 The Bearer token is required for each OpenEMR API request, and is conveyed using an Authorization header.
  55
  56 ```sh
  57 curl -X GET 'http://localhost:8300/apis/api/patient/1/medical_problem' \
  58   -H 'Authorization: Bearer eyJ0b2tlbiI6IjAwNmZ4TWpsNWhsZmNPelZicXBEdEZVUlNPQUY5KzdzR1Jjejc4WGZyeGFjUjY2QlhaaEs4eThkU3cxbTd5VXFBeTVyeEZpck9mVzBQNWc5dUlidERLZ0trUElCME5wRDVtTVk5bE9WaE5DTHF5RnRnT0Q0OHVuaHRvbXZ6OTEyNmZGUmVPUllSYVJORGoyZTkzTDA5OWZSb0ZRVGViTUtWUFd4ZW5cL1piSzhIWFpJZUxsV3VNcUdjQXR5dmlLQXRXNDAiLCJzaXRlX2lkIjoiZGVmYXVsdCIsImFwaSI6Im9lbXIifQ=='
  59 ```
  60
  61 #### POST /api/facility
  62
  63 ```sh
  64 curl -X POST 'http://localhost:8300/apis/api/facility' -d \
  65 '{
  66     "name": "Aquaria",
  67     "phone": "808-606-3030",
  68     "fax": "808-606-3031",
  69     "street": "1337 Bit Shifter Ln",
  70     "city": "San Lorenzo",
  71     "state": "ZZ",
  72     "postal_code": "54321",
  73     "email": "foo@bar.com",
  74     "service_location": "1",
  75     "billing_location": "1",
  76     "color": "#FF69B4"
  77 }'
  78 ```
  79
  80 #### PUT /api/facility/:fid
  81
  82 ```sh
  83 curl -X PUT 'http://localhost:8300/apis/api/facility/1' -d \
  84 '{
  85     "name": "Aquaria",
  86     "phone": "808-606-3030",
  87     "fax": "808-606-3031",
  88     "street": "1337 Bit Shifter Ln",
  89     "city": "San Lorenzo",
  90     "state": "AZ",
  91     "postal_code": "54321",
  92     "email": "foo@bar.com",
  93     "service_location": "1",
  94     "billing_location": "1",
  95     "color": "#FF69B4"
  96 }'
  97 ```
  98
  99 #### GET /api/facility
 100
 101 ```sh
 102 curl -X GET 'http://localhost:8300/apis/api/facility'
 103 ```
 104
 105 #### GET /api/facility/:fid
 106
 107 ```sh
 108 curl -X GET 'http://localhost:8300/apis/api/facility/1'
 109 ```
 110
 111 #### GET /api/provider
 112
 113 ```sh
 114 curl -X GET 'http://localhost:8300/apis/api/provider'
 115 ```
 116
 117 #### GET /api/provider/:prid
 118
 119 ```sh
 120 curl -X GET 'http://localhost:8300/apis/api/provider/1'
 121 ```
 122
 123 #### POST /api/patient
 124
 125 ```sh
 126 curl -X POST 'http://localhost:8300/apis/api/patient' -d \
 127 '{
 128     "title": "Mr",
 129     "fname": "Foo",
 130     "mname": "",
 131     "lname": "Bar",
 132     "street": "456 Tree Lane",
 133     "postal_code": "08642",
 134     "city": "FooTown",
 135     "state": "FL",
 136     "country_code": "US",
 137     "phone_contact": "123-456-7890",
 138     "dob": "1992-02-02",
 139     "sex": "Male",
 140     "race": "",
 141     "ethnicity": ""
 142 }'
 143 ```
 144
 145 #### PUT /api/patient/:pid
 146
 147 ```sh
 148 curl -X PUT 'http://localhost:8300/apis/api/patient/1' -d \
 149 '{
 150     "title": "Mr",
 151     "fname": "Baz",
 152     "mname": "",
 153     "lname": "Bop",
 154     "street": "456 Tree Lane",
 155     "postal_code": "08642",
 156     "city": "FooTown",
 157     "state": "FL",
 158     "country_code": "US",
 159     "phone_contact": "123-456-7890",
 160     "dob": "1992-02-03",
 161     "sex": "Male",
 162     "race": "",
 163     "ethnicity": ""
 164 }'
 165 ```
 166
 167 #### GET /api/patient
 168
 169 ```sh
 170 curl -X GET 'http://localhost:8300/apis/api/patient'
 171 ```
 172
 173 ```sh
 174 curl -X GET 'http://localhost:8300/apis/api/patient&fname=...&lname=...&dob=...'
 175 ```
 176
 177 #### GET /api/patient/:pid
 178
 179 ```sh
 180 curl -X GET 'http://localhost:8300/apis/api/patient/1'
 181 ```
 182
 183 #### POST /api/patient/:pid/encounter
 184
 185 ```sh
 186 curl -X POST 'http://localhost:8300/apis/api/patient/1/encounter' -d \
 187 '{
 188     "date":"2020-11-10",
 189     "onset_date": "",
 190     "reason": "Pregnancy Test",
 191     "facility": "Owerri General Hospital",
 192     "pc_catid": "5",
 193     "facility_id": "3",
 194     "billing_facility": "3",
 195     "sensitivity": "normal",
 196     "referral_source": "",
 197     "pos_code": "0",
 198     "external_id": "",
 199     "provider_id": "1"
 200 }'
 201 ```
 202
 203
 204 #### PUT /api/patient/:pid/encounter/:eid
 205
 206 ```sh
 207 curl -X POST 'http://localhost:8300/apis/api/patient/1/encounter/1' -d \
 208 '{
 209     "date":"2019-09-14",
 210     "onset_date": "2019-04-20 00:00:00",
 211     "reason": "Pregnancy Test",
 212     "pc_catid": "5",
 213     "facility_id": "3",
 214     "billing_facility": "3",
 215     "sensitivity": "normal",
 216     "referral_source": "",
 217     "pos_code": "0"
 218 }'
 219 ```
 220
 221
 222 #### GET /api/patient/:pid/encounter
 223
 224 ```sh
 225 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter'
 226 ```
 227
 228 #### GET /api/patient/:pid/encounter/:eid
 229
 230 ```sh
 231 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter/1'
 232 ```
 233
 234 #### POST /api/patient/:pid/encounter/:eid/vital
 235
 236 ```sh
 237 curl -X POST 'http://localhost:8300/apis/api/patient/1/encounter/1/vital' -d \
 238 '{
 239     "bps": "130",
 240     "bpd": "80",
 241     "weight": "220",
 242     "height": "70",
 243     "temperature": "98",
 244     "temp_method": "Oral",
 245     "pulse": "60",
 246     "respiration": "20",
 247     "note": "...",
 248     "waist_circ": "37",
 249     "head_circ": "22.2",
 250     "oxygen_saturation": "80"
 251 }'
 252 ```
 253
 254 #### PUT /api/patient/:pid/encounter/:eid/vital/:vid
 255
 256 ```sh
 257 curl -X PUT 'http://localhost:8300/apis/api/patient/1/encounter/1/vital/1' -d \
 258 '{
 259     "bps": "140",
 260     "bpd": "80",
 261     "weight": "220",
 262     "height": "70",
 263     "temperature": "98",
 264     "temp_method": "Oral",
 265     "pulse": "60",
 266     "respiration": "20",
 267     "note": "...",
 268     "waist_circ": "37",
 269     "head_circ": "22.2",
 270     "oxygen_saturation": "80"
 271 }'
 272 ```
 273
 274 #### GET /api/patient/:pid/encounter/:eid/vital
 275
 276 ```sh
 277 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter/1/vital'
 278 ```
 279
 280 #### GET /api/patient/:pid/encounter/:eid/vital/:vid
 281
 282 ```sh
 283 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter/1/vital/1'
 284 ```
 285
 286 #### POST /api/patient/:pid/encounter/:eid/soap_note
 287
 288 ```sh
 289 curl -X POST 'http://localhost:8300/apis/api/patient/1/encounter/1/soap_note' -d \
 290 '{
 291     "subjective": "...",
 292     "objective": "...",
 293     "assessment": "...",
 294     "plan": "..."
 295 }'
 296 ```
 297
 298 #### PUT /api/patient/:pid/encounter/:eid/soap_note/:sid
 299
 300 ```sh
 301 curl -X PUT 'http://localhost:8300/apis/api/patient/1/encounter/1/soap_note/1' -d \
 302 '{
 303     "subjective": "...",
 304     "objective": "...",
 305     "assessment": "...",
 306     "plan": "..."
 307 }'
 308 ```
 309
 310 #### GET /api/patient/:pid/encounter/:eid/soap_note
 311
 312 ```sh
 313 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter/1/soap_note'
 314 ```
 315
 316 #### GET /api/patient/:pid/encounter/:eid/soap_note/:sid
 317
 318 ```sh
 319 curl -X GET 'http://localhost:8300/apis/api/patient/1/encounter/1/soap_note/1'
 320 ```
 321
 322 #### POST /api/patient/:pid/medical_problem
 323
 324 ```sh
 325 curl -X POST 'http://localhost:8300/apis/api/patient/1/medical_problem' -d \
 326 '{
 327     "title": "Dermatochalasis",
 328     "begdate": "2010-04-13",
 329     "enddate": null,
 330     "diagnosis": "ICD10:H02.839"
 331 }'
 332 ```
 333
 334 #### PUT /api/patient/:pid/medical_problem/:mid
 335
 336 ```sh
 337 curl -X PUT 'http://localhost:8300/apis/api/patient/1/medical_problem/1' -d \
 338 '{
 339     "title": "Dermatochalasis",
 340     "begdate": "2010-04-13",
 341     "enddate": "2018-03-12",
 342     "diagnosis": "ICD10:H02.839"
 343 }'
 344 ```
 345
 346 #### GET /api/patient/:pid/medical_problem
 347
 348 ```sh
 349 curl -X GET 'http://localhost:8300/apis/api/patient/1/medical_problem'
 350 ```
 351
 352 #### GET /api/patient/:pid/medical_problem/:mid
 353
 354 ```sh
 355 curl -X GET 'http://localhost:8300/apis/api/patient/1/medical_problem/1'
 356 ```
 357
 358 #### DELETE /api/patient/:pid/medical_problem/:mid
 359
 360 ```sh
 361 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/medical_problem/1'
 362 ```
 363
 364 #### POST /api/patient/:pid/allergy
 365
 366 ```sh
 367 curl -X POST 'http://localhost:8300/apis/api/patient/1/allergy' -d \
 368 '{
 369     "title": "Iodine",
 370     "begdate": "2010-10-13",
 371     "enddate": null
 372 }'
 373 ```
 374
 375 #### PUT /api/patient/:pid/allergy/:aid
 376
 377 ```sh
 378 curl -X PUT 'http://localhost:8300/apis/api/patient/1/allergy/1' -d \
 379 '{
 380     "title": "Iodine",
 381     "begdate": "2012-10-13",
 382     "enddate": null
 383 }'
 384 ```
 385
 386 #### GET /api/patient/:pid/allergy
 387
 388 ```sh
 389 curl -X GET 'http://localhost:8300/apis/api/patient/1/allergy'
 390 ```
 391
 392 #### GET /api/patient/:pid/allergy/:aid
 393
 394 ```sh
 395 curl -X GET 'http://localhost:8300/apis/api/patient/1/allergy/1'
 396 ```
 397
 398 #### DELETE /api/patient/:pid/allergy/:aid
 399
 400 ```sh
 401 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/allergy/1'
 402 ```
 403
 404 #### POST /api/patient/:pid/medication
 405
 406 ```sh
 407 curl -X POST 'http://localhost:8300/apis/api/patient/1/medication' -d \
 408 '{
 409     "title": "Norvasc",
 410     "begdate": "2013-10-13",
 411     "enddate": null
 412 }'
 413 ```
 414
 415 #### PUT /api/patient/:pid/medication/:mid
 416
 417 ```sh
 418 curl -X PUT 'http://localhost:8300/apis/api/patient/1/medication/1' -d \
 419 '{
 420     "title": "Norvasc",
 421     "begdate": "2013-04-13",
 422     "enddate": null
 423 }'
 424 ```
 425
 426 #### GET /api/patient/:pid/medication
 427
 428 ```sh
 429 curl -X GET 'http://localhost:8300/apis/api/patient/1/medication'
 430 ```
 431
 432 #### GET /api/patient/:pid/medication/:mid
 433
 434 ```sh
 435 curl -X GET 'http://localhost:8300/apis/api/patient/1/medication/1'
 436 ```
 437
 438 #### DELETE /api/patient/:pid/medication/:mid
 439
 440 ```sh
 441 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/medication/1'
 442 ```
 443
 444 #### POST /api/patient/:pid/surgery
 445
 446 ```sh
 447 curl -X POST 'http://localhost:8300/apis/api/patient/1/surgery' -d \
 448 '{
 449     "title": "Blepharoplasty",
 450     "begdate": "2013-10-13",
 451     "enddate": null,
 452     "diagnosis": "CPT4:15823-50"
 453 }'
 454 ```
 455
 456 #### PUT /api/patient/:pid/surgery/:sid
 457
 458 ```sh
 459 curl -X PUT 'http://localhost:8300/apis/api/patient/1/surgery/1' -d \
 460 '{
 461     "title": "Blepharoplasty",
 462     "begdate": "2013-10-14",
 463     "enddate": null,
 464     "diagnosis": "CPT4:15823-50"
 465 }'
 466 ```
 467
 468 #### GET /api/patient/:pid/surgery
 469
 470 ```sh
 471 curl -X GET 'http://localhost:8300/apis/api/patient/1/surgery'
 472 ```
 473
 474 #### GET /api/patient/:pid/surgery/:sid
 475
 476 ```sh
 477 curl -X GET 'http://localhost:8300/apis/api/patient/1/surgery/1'
 478 ```
 479
 480 #### DELETE /api/patient/:pid/surgery/:sid
 481
 482 ```sh
 483 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/surgery/1'
 484 ```
 485
 486 #### POST /api/patient/:pid/dental_issue
 487
 488 ```sh
 489 curl -X POST 'http://localhost:8300/apis/api/patient/1/dental_issue' -d \
 490 '{
 491     "title": "Halitosis",
 492     "begdate": "2015-03-17",
 493     "enddate": null
 494 }'
 495 ```
 496
 497 #### PUT /api/patient/:pid/dental_issue/:did
 498
 499 ```sh
 500 curl -X PUT 'http://localhost:8300/apis/api/patient/1/dental_issue/1' -d \
 501 '{
 502     "title": "Halitosis",
 503     "begdate": "2015-03-17",
 504     "enddate": "2018-03-20"
 505 }'
 506 ```
 507
 508 #### GET /api/patient/:pid/dental_issue
 509
 510 ```sh
 511 curl -X GET 'http://localhost:8300/apis/api/patient/1/dental_issue'
 512 ```
 513
 514 #### GET /api/patient/:pid/dental_issue/:did
 515
 516 ```sh
 517 curl -X GET 'http://localhost:8300/apis/api/patient/1/dental_issue/1'
 518 ```
 519
 520 #### DELETE /api/patient/:pid/dental_issue/:did
 521
 522 ```sh
 523 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/dental_issue/1'
 524 ```
 525
 526 #### GET /api/patient/:pid/insurance
 527
 528 ```sh
 529 curl -X GET 'http://localhost:8300/apis/api/patient/1/insurance'
 530 ```
 531
 532 #### GET /api/patient/:pid/insurance/:type
 533
 534 ```sh
 535 curl -X GET 'http://localhost:8300/apis/api/patient/1/insurance/secondary'
 536 ```
 537
 538 #### POST /api/patient/:pid/insurance/:type
 539
 540 ```sh
 541 curl -X POST 'http://localhost:8300/apis/api/patient/10/insurance/primary' -d \
 542 '{
 543     "type": "primary",
 544     "provider": "33",
 545     "plan_name": "Some Plan",
 546     "policy_number": "12345",
 547     "group_number": "252412",
 548     "subscriber_lname": "Tester",
 549     "subscriber_mname": "Xi",
 550     "subscriber_fname": "Foo",
 551     "subscriber_relationship": "other",
 552     "subscriber_ss": "234231234",
 553     "subscriber_DOB": "2018-10-03",
 554     "subscriber_street": "183 Cool St",
 555     "subscriber_postal_code": "23418",
 556     "subscriber_city": "Cooltown",
 557     "subscriber_state": "AZ",
 558     "subscriber_country": "USA",
 559     "subscriber_phone": "234-598-2123",
 560     "subscriber_employer": "Some Employer",
 561     "subscriber_employer_street": "123 Heather Lane",
 562     "subscriber_employer_postal_code": "23415",
 563     "subscriber_employer_state": "AZ",
 564     "subscriber_employer_country": "USA",
 565     "subscriber_employer_city": "Cooltown",
 566     "copay": "35",
 567     "date": "2018-10-15",
 568     "subscriber_sex": "Female",
 569     "accept_assignment": "TRUE",
 570     "policy_type": "a"
 571 }'
 572 ```
 573
 574 Notes:
 575 - `provider` is the insurance company id
 576 - `state` can be found by querying `resource=/api/list/state`
 577 - `country` can be found by querying `resource=/api/list/country`
 578
 579
 580 #### PUT /api/patient/:pid/insurance/:type
 581
 582 ```sh
 583 curl -X PUT 'http://localhost:8300/apis/api/patient/10/insurance/primary' -d \
 584 '{
 585     "type": "primary",
 586     "provider": "33",
 587     "plan_name": "Some Plan",
 588     "policy_number": "12345",
 589     "group_number": "252412",
 590     "subscriber_lname": "Tester",
 591     "subscriber_mname": "Xi",
 592     "subscriber_fname": "Foo",
 593     "subscriber_relationship": "other",
 594     "subscriber_ss": "234231234",
 595     "subscriber_DOB": "2018-10-03",
 596     "subscriber_street": "183 Cool St",
 597     "subscriber_postal_code": "23418",
 598     "subscriber_city": "Cooltown",
 599     "subscriber_state": "AZ",
 600     "subscriber_country": "USA",
 601     "subscriber_phone": "234-598-2123",
 602     "subscriber_employer": "Some Employer",
 603     "subscriber_employer_street": "123 Heather Lane",
 604     "subscriber_employer_postal_code": "23415",
 605     "subscriber_employer_state": "AZ",
 606     "subscriber_employer_country": "USA",
 607     "subscriber_employer_city": "Cooltown",
 608     "copay": "35",
 609     "date": "2018-10-15",
 610     "subscriber_sex": "Female",
 611     "accept_assignment": "TRUE",
 612     "policy_type": "a"
 613 }'
 614 ```
 615
 616 Notes:
 617 - `provider` is the insurance company id
 618 - `state` can be found by querying `resource=/api/list/state`
 619 - `country` can be found by querying `resource=/api/list/country`
 620
 621 #### GET /api/list/:list_name
 622
 623 ```sh
 624 curl -X GET 'http://localhost:8300/apis/api/list/medical_problem_issue_list'
 625 ```
 626
 627 #### GET /api/version
 628
 629 ```sh
 630 curl -X GET 'http://localhost:8300/apis/api/version'
 631 ```
 632
 633 #### GET /api/product
 634
 635 ```sh
 636 curl -X GET 'http://localhost:8300/apis/api/product'
 637 ```
 638
 639 #### GET /api/insurance_company
 640
 641 ```sh
 642 curl -X GET 'http://localhost:8300/apis/api/insurance_company'
 643 ```
 644
 645 #### GET /api/insurance_type
 646
 647 ```sh
 648 curl -X GET 'http://localhost:8300/apis/api/insurance_type'
 649 ```
 650
 651 #### POST /api/insurance_company
 652
 653 ```sh
 654 curl -X POST 'http://localhost:8300/apis/api/insurance_company' -d \
 655 '{
 656     "name": "Cool Insurance Company",
 657     "attn": null,
 658     "cms_id": null,
 659     "ins_type_code": "2",
 660     "x12_receiver_id": null,
 661     "x12_default_partner_id": null,
 662     "alt_cms_id": "",
 663     "line1": "123 Cool Lane",
 664     "line2": "Suite 123",
 665     "city": "Cooltown",
 666     "state": "CA",
 667     "zip": "12245",
 668     "country": "USA"
 669 }'
 670 ```
 671
 672 Notes: `ins_type_code` can be found by inspecting the above route (/api/insurance_type).
 673
 674 #### PUT /api/insurance_company/:iid
 675
 676 ```sh
 677 curl -X PUT 'http://localhost:8300/apis/api/insurance_company/1' -d \
 678 '{
 679     "name": "Super Insurance Company",
 680     "attn": null,
 681     "cms_id": null,
 682     "ins_type_code": "2",
 683     "x12_receiver_id": null,
 684     "x12_default_partner_id": null,
 685     "alt_cms_id": "",
 686     "line1": "123 Cool Lane",
 687     "line2": "Suite 123",
 688     "city": "Cooltown",
 689     "state": "CA",
 690     "zip": "12245",
 691     "country": "USA"
 692 }'
 693 ```
 694
 695 Notes: `ins_type_code` can be found by inspecting the above route (/api/insurance_type).
 696
 697 #### GET /api/appointment
 698
 699 ```sh
 700 curl -X GET 'http://localhost:8300/apis/api/appointment'
 701 ```
 702
 703 #### GET /api/appointment/:eid
 704
 705 ```sh
 706 curl -X GET 'http://localhost:8300/apis/api/appointment/1'
 707 ```
 708
 709 #### GET /api/patient/:pid/appointment
 710
 711 ```sh
 712 curl -X GET 'http://localhost:8300/apis/api/patient/1/appointment'
 713 ```
 714
 715 #### GET /api/patient/:pid/appointment/:eid
 716
 717 ```sh
 718 curl -X GET 'http://localhost:8300/apis/api/patient/1/appointment/1'
 719 ```
 720
 721 #### POST /api/patient/:pid/appointment
 722
 723 ```sh
 724 curl -X POST 'http://localhost:8300/apis/api/patient/1/appointment' -d \
 725 '{
 726     "pc_eid":"1",
 727     "pc_catid": "5",
 728     "pc_title": "Office Visit",
 729     "pc_duration": "900",
 730     "pc_hometext": "Test",
 731     "pc_apptstatus": "-",
 732     "pc_eventDate": "2018-10-19",
 733     "pc_startTime": "09:00",
 734     "pc_facility": "9",
 735     "pc_billing_location": "10"
 736 }'
 737 ```
 738
 739 #### DELETE /api/patient/:pid/appointment/:eid
 740
 741 ```sh
 742 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/appointment/1' -d \
 743 ```
 744
 745 #### GET /api/patient/:pid/document
 746
 747 ```sh
 748 curl -X GET 'http://localhost:8300/apis/api/patient/1/document&path=/eye_module/imaging-eye/drawings-eye'
 749 ```
 750
 751 Note: The `path` query string represents the OpenEMR documents paths with two exceptions:
 752
 753 - Spaces are represented with `_`
 754 - All characters are lowercase
 755
 756 #### POST /api/patient/:pid/document
 757
 758 ```sh
 759 curl -X POST 'http://localhost:8300/apis/api/patient/1/document&path=/eye_module/imaging-eye/drawings-eye' \
 760  -F document=@/home/someone/Desktop/drawing.jpg
 761 ```
 762
 763 Note: The `path` query string represents the OpenEMR documents paths with two exceptions:
 764
 765 - Spaces are represented with `_`
 766 - All characters are lowercase
 767
 768 #### GET /api/patient/:pid/document/:did
 769
 770 ```sh
 771 curl -X GET 'http://localhost:8300/apis/api/patient/1/document/1'
 772 ```
 773
 774 #### POST /api/patient/:pid/message
 775
 776 ```sh
 777 curl -X POST 'http://localhost:8300/apis/api/patient/1/message' -d \
 778 '{
 779     "body": "Test 123",
 780     "groupname": "Default",
 781     "from": "admin",
 782     "to": "Matthew",
 783     "title": "Other",
 784     "message_status": "New"
 785 }'
 786 ```
 787
 788 Notes:
 789 - For `title`, use `resource=/api/list/note_type`
 790 - For `message_type`, use `resource=/api/list/message_status`
 791
 792 #### PUT /api/patient/:pid/message/:mid
 793
 794 ```sh
 795 curl -X PUT 'http://localhost:8300/apis/api/patient/1/message/1' -d \
 796 '{
 797     "body": "Test 456",
 798     "groupname": "Default",
 799     "from": "Matthew",
 800     "to": "admin",
 801     "title": "Other",
 802     "message_status": "New"
 803 }'
 804 ```
 805
 806 Notes:
 807 - For `title`, use `resource=/api/list/note_type`
 808 - For `message_type`, use `resource=/api/list/message_status`
 809
 810 #### DELETE /api/patient/:pid/message/:mid
 811
 812 ```sh
 813 curl -X DELETE 'http://localhost:8300/apis/api/patient/1/message/1'
 814 ```
 815
 816 ### Dev Notes
 817
 818 - For business logic, make or use the services [here](src/Services)
 819 - For controller logic, make or use the classes [here](src/RestControllers)
 820 - For routing declarations, use the class [here](_rest_routes.inc.php).
 821
 822
 823 ### Project Management
 824
 825 #### General API
 826
 827 - TODO(?): Prevent `ListService` from using `enddate` of `0000-00-00` by default
 828 - TODO(?): API for fee sheets
 829 - TODO(?): API for pharmacies
 830 - TODO(?): API for immunizations
 831 - TODO(?): API for prescriptions
 832 - TODO(?): Drug search API
 833 - TODO(?): API for onotes
 834
 835