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