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