API_README.md

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