swagger/openemr-api.yaml

   1 openapi: 3.0.0
   2 info:
   3   title: 'OpenEMR API'
   4   version: 7.0.0
   5 servers:
   6   -
   7     url: /apis/default/
   8 paths:
   9   /api/facility:
  10     get:
  11       tags:
  12         - standard
  13       description: 'Returns a single facility.'
  14       parameters:
  15         -
  16           name: name
  17           in: query
  18           description: 'The name for the facility.'
  19           required: false
  20           schema:
  21             type: string
  22         -
  23           name: facility_npi
  24           in: query
  25           description: 'The facility_npi for the facility.'
  26           required: false
  27           schema:
  28             type: string
  29         -
  30           name: phone
  31           in: query
  32           description: 'The phone for the facility.'
  33           required: false
  34           schema:
  35             type: string
  36         -
  37           name: fax
  38           in: query
  39           description: 'The fax for the facility.'
  40           required: false
  41           schema:
  42             type: string
  43         -
  44           name: street
  45           in: query
  46           description: 'The street for the facility.'
  47           required: false
  48           schema:
  49             type: string
  50         -
  51           name: city
  52           in: query
  53           description: 'The city for the facility.'
  54           required: false
  55           schema:
  56             type: string
  57         -
  58           name: state
  59           in: query
  60           description: 'The state for the facility.'
  61           required: false
  62           schema:
  63             type: string
  64         -
  65           name: postal_code
  66           in: query
  67           description: 'The postal_code for the facility.'
  68           required: false
  69           schema:
  70             type: string
  71         -
  72           name: country_code
  73           in: query
  74           description: 'The country_code for the facility.'
  75           required: false
  76           schema:
  77             type: string
  78         -
  79           name: federal_ein
  80           in: query
  81           description: 'The federal_ein for the facility.'
  82           required: false
  83           schema:
  84             type: string
  85         -
  86           name: website
  87           in: query
  88           description: 'The website for the facility.'
  89           required: false
  90           schema:
  91             type: string
  92         -
  93           name: email
  94           in: query
  95           description: 'The email for the facility.'
  96           required: false
  97           schema:
  98             type: string
  99         -
 100           name: domain_identifier
 101           in: query
 102           description: 'The domain_identifier for the facility.'
 103           required: false
 104           schema:
 105             type: string
 106         -
 107           name: facility_taxonomy
 108           in: query
 109           description: 'The facility_taxonomy for the facility.'
 110           required: false
 111           schema:
 112             type: string
 113         -
 114           name: facility_code
 115           in: query
 116           description: 'The facility_code for the facility.'
 117           required: false
 118           schema:
 119             type: string
 120         -
 121           name: billing_location
 122           in: query
 123           description: 'The billing_location setting for the facility.'
 124           required: false
 125           schema:
 126             type: string
 127         -
 128           name: accepts_assignment
 129           in: query
 130           description: 'The accepts_assignment setting for the facility.'
 131           required: false
 132           schema:
 133             type: string
 134         -
 135           name: oid
 136           in: query
 137           description: 'The oid for the facility.'
 138           required: false
 139           schema:
 140             type: string
 141         -
 142           name: service_location
 143           in: query
 144           description: 'The service_location setting for the facility.'
 145           required: false
 146           schema:
 147             type: string
 148       responses:
 149         '200':
 150           $ref: '#/components/responses/standard'
 151         '400':
 152           $ref: '#/components/responses/badrequest'
 153         '401':
 154           $ref: '#/components/responses/unauthorized'
 155       security:
 156         -
 157           openemr_auth: []
 158     post:
 159       tags:
 160         - standard
 161       description: 'Creates a facility in the system'
 162       requestBody:
 163         required: true
 164         content:
 165           application/json:
 166             schema:
 167               required:
 168                 - name
 169                 - facility_npi
 170               properties:
 171                 name:
 172                   description: 'The name for the facility.'
 173                   type: string
 174                 facility_npi:
 175                   description: 'The facility_npi for the facility.'
 176                   type: string
 177                 phone:
 178                   description: 'The phone for the facility.'
 179                   type: string
 180                 fax:
 181                   description: 'The fax for the facility.'
 182                   type: string
 183                 street:
 184                   description: 'The street for the facility.'
 185                   type: string
 186                 city:
 187                   description: 'The city for the facility.'
 188                   type: string
 189                 state:
 190                   description: 'The state for the facility.'
 191                   type: string
 192                 postal_code:
 193                   description: 'The postal_code for the facility.'
 194                   type: string
 195                 country_code:
 196                   description: 'The country_code for the facility.'
 197                   type: string
 198                 federal_ein:
 199                   description: 'The federal_ein for the facility.'
 200                   type: string
 201                 website:
 202                   description: 'The website for the facility.'
 203                   type: string
 204                 email:
 205                   description: 'The email for the facility.'
 206                   type: string
 207                 domain_identifier:
 208                   description: 'The domain_identifier for the facility.'
 209                   type: string
 210                 facility_taxonomy:
 211                   description: 'The facility_taxonomy for the facility.'
 212                   type: string
 213                 facility_code:
 214                   description: 'The facility_code for the facility.'
 215                   type: string
 216                 billing_location:
 217                   description: 'The billing_location setting for the facility.'
 218                   type: string
 219                 accepts_assignment:
 220                   description: 'The accepts_assignment setting for the facility.'
 221                   type: string
 222                 oid:
 223                   description: 'The oid for the facility.'
 224                   type: string
 225                 service_location:
 226                   description: 'The service_location setting for the facility.'
 227                   type: string
 228               type: object
 229               example:
 230                 name: Aquaria
 231                 facility_npi: '123456789123'
 232                 phone: 808-606-3030
 233                 fax: 808-606-3031
 234                 street: '1337 Bit Shifter Ln'
 235                 city: 'San Lorenzo'
 236                 state: ZZ
 237                 postal_code: '54321'
 238                 country_code: US
 239                 federal_ein: '4343434'
 240                 website: 'https://example.com'
 241                 email: foo@bar.com
 242                 domain_identifier: ''
 243                 facility_taxonomy: ''
 244                 facility_code: ''
 245                 billing_location: '1'
 246                 accepts_assignment: '1'
 247                 oid: ''
 248                 service_location: '1'
 249       responses:
 250         '200':
 251           $ref: '#/components/responses/standard'
 252         '400':
 253           $ref: '#/components/responses/badrequest'
 254         '401':
 255           $ref: '#/components/responses/unauthorized'
 256       security:
 257         -
 258           openemr_auth: []
 259   '/api/facility/{fuuid}':
 260     get:
 261       tags:
 262         - standard
 263       description: 'Returns a single facility.'
 264       parameters:
 265         -
 266           name: fuuid
 267           in: path
 268           description: 'The uuid for the facility.'
 269           required: true
 270           schema:
 271             type: string
 272       responses:
 273         '200':
 274           $ref: '#/components/responses/standard'
 275         '400':
 276           $ref: '#/components/responses/badrequest'
 277         '401':
 278           $ref: '#/components/responses/unauthorized'
 279       security:
 280         -
 281           openemr_auth: []
 282     put:
 283       tags:
 284         - standard
 285       description: 'Updates a facility in the system'
 286       parameters:
 287         -
 288           name: fuuid
 289           in: path
 290           description: 'The uuid for the facility.'
 291           required: true
 292           schema:
 293             type: string
 294       requestBody:
 295         required: true
 296         content:
 297           application/json:
 298             schema:
 299               properties:
 300                 name:
 301                   description: 'The name for the facility.'
 302                   type: string
 303                 facility_npi:
 304                   description: 'The facility_npi for the facility.'
 305                   type: string
 306                 phone:
 307                   description: 'The phone for the facility.'
 308                   type: string
 309                 fax:
 310                   description: 'The fax for the facility.'
 311                   type: string
 312                 street:
 313                   description: 'The street for the facility.'
 314                   type: string
 315                 city:
 316                   description: 'The city for the facility.'
 317                   type: string
 318                 state:
 319                   description: 'The state for the facility.'
 320                   type: string
 321                 postal_code:
 322                   description: 'The postal_code for the facility.'
 323                   type: string
 324                 country_code:
 325                   description: 'The country_code for the facility.'
 326                   type: string
 327                 federal_ein:
 328                   description: 'The federal_ein for the facility.'
 329                   type: string
 330                 website:
 331                   description: 'The website for the facility.'
 332                   type: string
 333                 email:
 334                   description: 'The email for the facility.'
 335                   type: string
 336                 domain_identifier:
 337                   description: 'The domain_identifier for the facility.'
 338                   type: string
 339                 facility_taxonomy:
 340                   description: 'The facility_taxonomy for the facility.'
 341                   type: string
 342                 facility_code:
 343                   description: 'The facility_code for the facility.'
 344                   type: string
 345                 billing_location:
 346                   description: 'The billing_location setting for the facility.'
 347                   type: string
 348                 accepts_assignment:
 349                   description: 'The accepts_assignment setting for the facility.'
 350                   type: string
 351                 oid:
 352                   description: 'The oid for the facility.'
 353                   type: string
 354                 service_location:
 355                   description: 'The service_location setting for the facility.'
 356                   type: string
 357               type: object
 358               example:
 359                 name: Aquaria
 360                 facility_npi: '123456789123'
 361                 phone: 808-606-3030
 362                 fax: 808-606-3031
 363                 street: '1337 Bit Shifter Ln'
 364                 city: 'San Lorenzo'
 365                 state: ZZ
 366                 postal_code: '54321'
 367                 country_code: US
 368                 federal_ein: '4343434'
 369                 website: 'https://example.com'
 370                 email: foo@bar.com
 371                 domain_identifier: ''
 372                 facility_taxonomy: ''
 373                 facility_code: ''
 374                 billing_location: '1'
 375                 accepts_assignment: '1'
 376                 oid: ''
 377                 service_location: '1'
 378       responses:
 379         '200':
 380           $ref: '#/components/responses/standard'
 381         '400':
 382           $ref: '#/components/responses/badrequest'
 383         '401':
 384           $ref: '#/components/responses/unauthorized'
 385       security:
 386         -
 387           openemr_auth: []
 388   /api/patient:
 389     get:
 390       tags:
 391         - standard
 392       description: 'Retrieves a list of patients'
 393       parameters:
 394         -
 395           name: fname
 396           in: query
 397           description: 'The first name for the patient.'
 398           required: false
 399           schema:
 400             type: string
 401         -
 402           name: lname
 403           in: query
 404           description: 'The last name for the patient.'
 405           required: false
 406           schema:
 407             type: string
 408         -
 409           name: ss
 410           in: query
 411           description: 'The social security number for the patient.'
 412           required: false
 413           schema:
 414             type: string
 415         -
 416           name: street
 417           in: query
 418           description: 'The street for the patient.'
 419           required: false
 420           schema:
 421             type: string
 422         -
 423           name: postal_code
 424           in: query
 425           description: 'The postal code for the patient.'
 426           required: false
 427           schema:
 428             type: string
 429         -
 430           name: city
 431           in: query
 432           description: 'The city for the patient.'
 433           required: false
 434           schema:
 435             type: string
 436         -
 437           name: state
 438           in: query
 439           description: 'The state for the patient.'
 440           required: false
 441           schema:
 442             type: string
 443         -
 444           name: phone_home
 445           in: query
 446           description: 'The home phone for the patient.'
 447           required: false
 448           schema:
 449             type: string
 450         -
 451           name: phone_biz
 452           in: query
 453           description: 'The business phone for the patient.'
 454           required: false
 455           schema:
 456             type: string
 457         -
 458           name: phone_cell
 459           in: query
 460           description: 'The cell phone for the patient.'
 461           required: false
 462           schema:
 463             type: string
 464         -
 465           name: postal_contact
 466           in: query
 467           description: 'The postal_contact for the patient.'
 468           required: false
 469           schema:
 470             type: string
 471         -
 472           name: sex
 473           in: query
 474           description: 'The gender for the patient.'
 475           required: false
 476           schema:
 477             type: string
 478         -
 479           name: country_code
 480           in: query
 481           description: 'The country code for the patient.'
 482           required: false
 483           schema:
 484             type: string
 485         -
 486           name: email
 487           in: query
 488           description: 'The email for the patient.'
 489           required: false
 490           schema:
 491             type: string
 492         -
 493           name: DOB
 494           in: query
 495           description: 'The DOB for the patient.'
 496           required: false
 497           schema:
 498             type: string
 499       responses:
 500         '200':
 501           $ref: '#/components/responses/standard'
 502         '400':
 503           $ref: '#/components/responses/badrequest'
 504         '401':
 505           $ref: '#/components/responses/unauthorized'
 506       security:
 507         -
 508           openemr_auth: []
 509     post:
 510       tags:
 511         - standard
 512       description: 'Creates a new patient'
 513       requestBody:
 514         required: true
 515         content:
 516           application/json:
 517             schema:
 518               $ref: '#/components/schemas/api_patient_request'
 519       responses:
 520         '200':
 521           description: 'Standard response'
 522           content:
 523             application/json:
 524               schema:
 525                 properties:
 526                   validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
 527                   internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
 528                   data: { description: 'Returned data.', type: array, items: { properties: { pid: { description: 'patient pid', type: integer } }, type: object } }
 529                 type: object
 530                 example:
 531                   validationErrors: []
 532                   error_description: []
 533                   data: { pid: 1 }
 534         '401':
 535           $ref: '#/components/responses/unauthorized'
 536       security:
 537         -
 538           openemr_auth: []
 539   '/api/patient/{puuid}':
 540     get:
 541       tags:
 542         - standard
 543       description: 'Retrieves a single patient by their uuid'
 544       parameters:
 545         -
 546           name: puuid
 547           in: path
 548           description: 'The uuid for the patient.'
 549           required: true
 550           schema:
 551             type: string
 552       responses:
 553         '200':
 554           description: 'Standard response'
 555           content:
 556             application/json:
 557               schema:
 558                 $ref: '#/components/schemas/api_patient_response'
 559         '401':
 560           $ref: '#/components/responses/unauthorized'
 561       security:
 562         -
 563           openemr_auth: []
 564     put:
 565       tags:
 566         - standard
 567       description: 'Updates a patient'
 568       parameters:
 569         -
 570           name: puuid
 571           in: path
 572           description: 'The uuid for the patient.'
 573           required: true
 574           schema:
 575             type: string
 576       requestBody:
 577         required: true
 578         content:
 579           application/json:
 580             schema:
 581               $ref: '#/components/schemas/api_patient_request'
 582       responses:
 583         '200':
 584           description: 'Standard response'
 585           content:
 586             application/json:
 587               schema:
 588                 $ref: '#/components/schemas/api_patient_response'
 589         '401':
 590           $ref: '#/components/responses/unauthorized'
 591       security:
 592         -
 593           openemr_auth: []
 594   '/api/patient/{puuid}/encounter':
 595     get:
 596       tags:
 597         - standard
 598       description: 'Retrieves a list of encounters for a single patient'
 599       parameters:
 600         -
 601           name: puuid
 602           in: path
 603           description: 'The uuid for the patient.'
 604           required: true
 605           schema:
 606             type: string
 607       responses:
 608         '200':
 609           $ref: '#/components/responses/standard'
 610         '400':
 611           $ref: '#/components/responses/badrequest'
 612         '401':
 613           $ref: '#/components/responses/unauthorized'
 614       security:
 615         -
 616           openemr_auth: []
 617     post:
 618       tags:
 619         - standard
 620       description: 'Creates a new encounter'
 621       parameters:
 622         -
 623           name: puuid
 624           in: path
 625           description: 'The uuid for the patient.'
 626           required: true
 627           schema:
 628             type: string
 629       requestBody:
 630         required: true
 631         content:
 632           application/json:
 633             schema:
 634               $ref: '#/components/schemas/api_encounter_request'
 635       responses:
 636         '200':
 637           description: 'Standard response'
 638           content:
 639             application/json:
 640               schema:
 641                 properties:
 642                   validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
 643                   internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
 644                   data: { description: 'Returned data.', type: array, items: { properties: { encounter: { description: 'encounter id', type: integer }, uuid: { description: 'encounter uuid', type: string } }, type: object } }
 645                 type: object
 646                 example:
 647                   validationErrors: []
 648                   error_description: []
 649                   data: { encounter: 1, uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef }
 650         '401':
 651           $ref: '#/components/responses/unauthorized'
 652       security:
 653         -
 654           openemr_auth: []
 655   '/api/patient/{puuid}/encounter/{euuid}':
 656     get:
 657       tags:
 658         - standard
 659       description: 'Retrieves a single encounter for a patient'
 660       parameters:
 661         -
 662           name: puuid
 663           in: path
 664           description: 'The uuid for the patient.'
 665           required: true
 666           schema:
 667             type: string
 668         -
 669           name: euuid
 670           in: path
 671           description: 'The uuid for the encounter.'
 672           required: true
 673           schema:
 674             type: string
 675       responses:
 676         '200':
 677           description: 'Standard response'
 678           content:
 679             application/json:
 680               schema:
 681                 $ref: '#/components/schemas/api_encounter_response'
 682         '401':
 683           $ref: '#/components/responses/unauthorized'
 684       security:
 685         -
 686           openemr_auth: []
 687     put:
 688       tags:
 689         - standard
 690       description: 'Modify a encounter'
 691       parameters:
 692         -
 693           name: puuid
 694           in: path
 695           description: 'The uuid for the patient.'
 696           required: true
 697           schema:
 698             type: string
 699         -
 700           name: euuid
 701           in: path
 702           description: 'The uuid for the encounter.'
 703           required: true
 704           schema:
 705             type: string
 706       requestBody:
 707         required: true
 708         content:
 709           application/json:
 710             schema:
 711               $ref: '#/components/schemas/api_encounter_request'
 712       responses:
 713         '200':
 714           description: 'Standard response'
 715           content:
 716             application/json:
 717               schema:
 718                 $ref: '#/components/schemas/api_encounter_response'
 719         '401':
 720           $ref: '#/components/responses/unauthorized'
 721       security:
 722         -
 723           openemr_auth: []
 724   '/api/patient/{pid}/encounter/{eid}/soap_note':
 725     get:
 726       tags:
 727         - standard
 728       description: 'Retrieves soap notes from an encounter for a patient'
 729       parameters:
 730         -
 731           name: pid
 732           in: path
 733           description: 'The pid for the patient.'
 734           required: true
 735           schema:
 736             type: string
 737         -
 738           name: eid
 739           in: path
 740           description: 'The id for the encounter.'
 741           required: true
 742           schema:
 743             type: string
 744       responses:
 745         '200':
 746           $ref: '#/components/responses/standard'
 747         '400':
 748           $ref: '#/components/responses/badrequest'
 749         '401':
 750           $ref: '#/components/responses/unauthorized'
 751       security:
 752         -
 753           openemr_auth: []
 754     post:
 755       tags:
 756         - standard
 757       description: 'Submits a new soap note'
 758       parameters:
 759         -
 760           name: pid
 761           in: path
 762           description: 'The id for the patient.'
 763           required: true
 764           schema:
 765             type: string
 766         -
 767           name: eid
 768           in: path
 769           description: 'The id for the encounter.'
 770           required: true
 771           schema:
 772             type: string
 773       requestBody:
 774         required: true
 775         content:
 776           application/json:
 777             schema:
 778               $ref: '#/components/schemas/api_soap_note_request'
 779       responses:
 780         '200':
 781           $ref: '#/components/responses/standard'
 782         '400':
 783           $ref: '#/components/responses/badrequest'
 784         '401':
 785           $ref: '#/components/responses/unauthorized'
 786       security:
 787         -
 788           openemr_auth: []
 789   '/api/patient/{pid}/encounter/{eid}/vital':
 790     get:
 791       tags:
 792         - standard
 793       description: 'Retrieves all vitals from an encounter for a patient'
 794       parameters:
 795         -
 796           name: pid
 797           in: path
 798           description: 'The pid for the patient.'
 799           required: true
 800           schema:
 801             type: string
 802         -
 803           name: eid
 804           in: path
 805           description: 'The id for the encounter.'
 806           required: true
 807           schema:
 808             type: string
 809       responses:
 810         '200':
 811           $ref: '#/components/responses/standard'
 812         '400':
 813           $ref: '#/components/responses/badrequest'
 814         '401':
 815           $ref: '#/components/responses/unauthorized'
 816       security:
 817         -
 818           openemr_auth: []
 819     post:
 820       tags:
 821         - standard
 822       description: 'Submits a new vitals form'
 823       parameters:
 824         -
 825           name: pid
 826           in: path
 827           description: 'The id for the patient.'
 828           required: true
 829           schema:
 830             type: string
 831         -
 832           name: eid
 833           in: path
 834           description: 'The id for the encounter.'
 835           required: true
 836           schema:
 837             type: string
 838       requestBody:
 839         required: true
 840         content:
 841           application/json:
 842             schema:
 843               $ref: '#/components/schemas/api_vital_request'
 844       responses:
 845         '200':
 846           $ref: '#/components/responses/standard'
 847         '400':
 848           $ref: '#/components/responses/badrequest'
 849         '401':
 850           $ref: '#/components/responses/unauthorized'
 851       security:
 852         -
 853           openemr_auth: []
 854   '/api/patient/{pid}/encounter/{eid}/vital/{vid}':
 855     get:
 856       tags:
 857         - standard
 858       description: 'Retrieves a vitals form from an encounter for a patient'
 859       parameters:
 860         -
 861           name: pid
 862           in: path
 863           description: 'The pid for the patient.'
 864           required: true
 865           schema:
 866             type: string
 867         -
 868           name: eid
 869           in: path
 870           description: 'The id for the encounter.'
 871           required: true
 872           schema:
 873             type: string
 874         -
 875           name: vid
 876           in: path
 877           description: 'The id for the vitals form.'
 878           required: true
 879           schema:
 880             type: string
 881       responses:
 882         '200':
 883           $ref: '#/components/responses/standard'
 884         '400':
 885           $ref: '#/components/responses/badrequest'
 886         '401':
 887           $ref: '#/components/responses/unauthorized'
 888       security:
 889         -
 890           openemr_auth: []
 891     put:
 892       tags:
 893         - standard
 894       description: 'Edit a vitals form'
 895       parameters:
 896         -
 897           name: pid
 898           in: path
 899           description: 'The id for the patient.'
 900           required: true
 901           schema:
 902             type: string
 903         -
 904           name: eid
 905           in: path
 906           description: 'The id for the encounter.'
 907           required: true
 908           schema:
 909             type: string
 910         -
 911           name: vid
 912           in: path
 913           description: 'The id for the vitalss form.'
 914           required: true
 915           schema:
 916             type: string
 917       requestBody:
 918         required: true
 919         content:
 920           application/json:
 921             schema:
 922               $ref: '#/components/schemas/api_vital_request'
 923       responses:
 924         '200':
 925           $ref: '#/components/responses/standard'
 926         '400':
 927           $ref: '#/components/responses/badrequest'
 928         '401':
 929           $ref: '#/components/responses/unauthorized'
 930       security:
 931         -
 932           openemr_auth: []
 933   '/api/patient/{pid}/encounter/{eid}/soap_note/{sid}':
 934     get:
 935       tags:
 936         - standard
 937       description: 'Retrieves a soap note from an encounter for a patient'
 938       parameters:
 939         -
 940           name: pid
 941           in: path
 942           description: 'The pid for the patient.'
 943           required: true
 944           schema:
 945             type: string
 946         -
 947           name: eid
 948           in: path
 949           description: 'The id for the encounter.'
 950           required: true
 951           schema:
 952             type: string
 953         -
 954           name: sid
 955           in: path
 956           description: 'The id for the soap note.'
 957           required: true
 958           schema:
 959             type: string
 960       responses:
 961         '200':
 962           $ref: '#/components/responses/standard'
 963         '400':
 964           $ref: '#/components/responses/badrequest'
 965         '401':
 966           $ref: '#/components/responses/unauthorized'
 967       security:
 968         -
 969           openemr_auth: []
 970     put:
 971       tags:
 972         - standard
 973       description: 'Edit a soap note'
 974       parameters:
 975         -
 976           name: pid
 977           in: path
 978           description: 'The id for the patient.'
 979           required: true
 980           schema:
 981             type: string
 982         -
 983           name: eid
 984           in: path
 985           description: 'The id for the encounter.'
 986           required: true
 987           schema:
 988             type: string
 989         -
 990           name: sid
 991           in: path
 992           description: 'The id for the soap noted.'
 993           required: true
 994           schema:
 995             type: string
 996       requestBody:
 997         required: true
 998         content:
 999           application/json:
1000             schema:
1001               $ref: '#/components/schemas/api_soap_note_request'
1002       responses:
1003         '200':
1004           $ref: '#/components/responses/standard'
1005         '400':
1006           $ref: '#/components/responses/badrequest'
1007         '401':
1008           $ref: '#/components/responses/unauthorized'
1009       security:
1010         -
1011           openemr_auth: []
1012   /api/practitioner:
1013     get:
1014       tags:
1015         - standard
1016       description: 'Retrieves a list of practitioners'
1017       parameters:
1018         -
1019           name: title
1020           in: query
1021           description: 'The title for the practitioner.'
1022           required: false
1023           schema:
1024             type: string
1025         -
1026           name: fname
1027           in: query
1028           description: 'The first name for the practitioner.'
1029           required: false
1030           schema:
1031             type: string
1032         -
1033           name: lname
1034           in: query
1035           description: 'The last name for the practitioner.'
1036           required: false
1037           schema:
1038             type: string
1039         -
1040           name: mname
1041           in: query
1042           description: 'The middle name for the practitioner.'
1043           required: false
1044           schema:
1045             type: string
1046         -
1047           name: federaltaxid
1048           in: query
1049           description: 'The federal tax id for the practitioner.'
1050           required: false
1051           schema:
1052             type: string
1053         -
1054           name: federaldrugid
1055           in: query
1056           description: 'The federal drug id for the practitioner.'
1057           required: false
1058           schema:
1059             type: string
1060         -
1061           name: upin
1062           in: query
1063           description: 'The upin for the practitioner.'
1064           required: false
1065           schema:
1066             type: string
1067         -
1068           name: facility_id
1069           in: query
1070           description: 'The facility id for the practitioner.'
1071           required: false
1072           schema:
1073             type: string
1074         -
1075           name: facility
1076           in: query
1077           description: 'The facility for the practitioner.'
1078           required: false
1079           schema:
1080             type: string
1081         -
1082           name: npi
1083           in: query
1084           description: 'The npi for the practitioner.'
1085           required: false
1086           schema:
1087             type: string
1088         -
1089           name: email
1090           in: query
1091           description: 'The email for the practitioner.'
1092           required: false
1093           schema:
1094             type: string
1095         -
1096           name: specialty
1097           in: query
1098           description: 'The specialty for the practitioner.'
1099           required: false
1100           schema:
1101             type: string
1102         -
1103           name: billname
1104           in: query
1105           description: 'The billname for the practitioner.'
1106           required: false
1107           schema:
1108             type: string
1109         -
1110           name: url
1111           in: query
1112           description: 'The url for the practitioner.'
1113           required: false
1114           schema:
1115             type: string
1116         -
1117           name: assistant
1118           in: query
1119           description: 'The assistant for the practitioner.'
1120           required: false
1121           schema:
1122             type: string
1123         -
1124           name: organization
1125           in: query
1126           description: 'The organization for the practitioner.'
1127           required: false
1128           schema:
1129             type: string
1130         -
1131           name: valedictory
1132           in: query
1133           description: 'The valedictory for the practitioner.'
1134           required: false
1135           schema:
1136             type: string
1137         -
1138           name: street
1139           in: query
1140           description: 'The street for the practitioner.'
1141           required: false
1142           schema:
1143             type: string
1144         -
1145           name: streetb
1146           in: query
1147           description: 'The street (line 2) for the practitioner.'
1148           required: false
1149           schema:
1150             type: string
1151         -
1152           name: city
1153           in: query
1154           description: 'The city for the practitioner.'
1155           required: false
1156           schema:
1157             type: string
1158         -
1159           name: state
1160           in: query
1161           description: 'The state for the practitioner.'
1162           required: false
1163           schema:
1164             type: string
1165         -
1166           name: zip
1167           in: query
1168           description: 'The zip for the practitioner.'
1169           required: false
1170           schema:
1171             type: string
1172         -
1173           name: phone
1174           in: query
1175           description: 'The phone for the practitioner.'
1176           required: false
1177           schema:
1178             type: string
1179         -
1180           name: fax
1181           in: query
1182           description: 'The fax for the practitioner.'
1183           required: false
1184           schema:
1185             type: string
1186         -
1187           name: phonew1
1188           in: query
1189           description: 'The phonew1 for the practitioner.'
1190           required: false
1191           schema:
1192             type: string
1193         -
1194           name: phonecell
1195           in: query
1196           description: 'The phonecell for the practitioner.'
1197           required: false
1198           schema:
1199             type: string
1200         -
1201           name: notes
1202           in: query
1203           description: 'The notes for the practitioner.'
1204           required: false
1205           schema:
1206             type: string
1207         -
1208           name: state_license_number2
1209           in: query
1210           description: 'The state license number for the practitioner.'
1211           required: false
1212           schema:
1213             type: string
1214         -
1215           name: username
1216           in: query
1217           description: 'The username for the practitioner.'
1218           required: false
1219           schema:
1220             type: string
1221       responses:
1222         '200':
1223           $ref: '#/components/responses/standard'
1224         '400':
1225           $ref: '#/components/responses/badrequest'
1226         '401':
1227           $ref: '#/components/responses/unauthorized'
1228       security:
1229         -
1230           openemr_auth: []
1231     post:
1232       tags:
1233         - standard
1234       description: 'Submits a new practitioner'
1235       requestBody:
1236         required: true
1237         content:
1238           application/json:
1239             schema:
1240               required:
1241                 - fname
1242                 - lname
1243                 - npi
1244               properties:
1245                 title:
1246                   description: 'The title for the practitioner.'
1247                   type: string
1248                 fname:
1249                   description: 'The first name for the practitioner.'
1250                   type: string
1251                 mname:
1252                   description: 'The middle name for the practitioner.'
1253                   type: string
1254                 lname:
1255                   description: 'The last name for the practitioner.'
1256                   type: string
1257                 federaltaxid:
1258                   description: 'The federal tax id for the practitioner.'
1259                   type: string
1260                 federaldrugid:
1261                   description: 'The federal drug id for the practitioner.'
1262                   type: string
1263                 upin:
1264                   description: 'The upin for the practitioner.'
1265                   type: string
1266                 facility_id:
1267                   description: 'The facility_id for the practitioner.'
1268                   type: string
1269                 facility:
1270                   description: 'The facility name for the practitioner.'
1271                   type: string
1272                 npi:
1273                   description: 'The npi for the practitioner.'
1274                   type: string
1275                 email:
1276                   description: 'The email for the practitioner.'
1277                   type: string
1278                 specialty:
1279                   description: 'The specialty for the practitioner.'
1280                   type: string
1281                 billname:
1282                   description: 'The billname for the practitioner.'
1283                   type: string
1284                 url:
1285                   description: 'The url for the practitioner.'
1286                   type: string
1287                 assistant:
1288                   description: 'The assistant for the practitioner.'
1289                   type: string
1290                 valedictory:
1291                   description: 'The valedictory for the practitioner.'
1292                   type: string
1293                 street:
1294                   description: 'The street address for the practitioner.'
1295                   type: string
1296                 streetb:
1297                   description: 'The streetb address for the practitioner.'
1298                   type: string
1299                 city:
1300                   description: 'The city for the practitioner.'
1301                   type: string
1302                 state:
1303                   description: 'The state for the practitioner.'
1304                   type: string
1305                 zip:
1306                   description: 'The zip for the practitioner.'
1307                   type: string
1308                 phone:
1309                   description: 'The phone for the practitioner.'
1310                   type: string
1311                 fax:
1312                   description: 'The fax for the practitioner.'
1313                   type: string
1314                 phonew1:
1315                   description: 'The phonew1 for the practitioner.'
1316                   type: string
1317                 phonecell:
1318                   description: 'The phonecell for the practitioner.'
1319                   type: string
1320                 notes:
1321                   description: 'The notes for the practitioner.'
1322                   type: string
1323                 state_license_number:
1324                   description: 'The state license number for the practitioner.'
1325                   type: string
1326                 username:
1327                   description: 'The username for the practitioner.'
1328                   type: string
1329               type: object
1330               example:
1331                 title: Mrs.
1332                 fname: Eduardo
1333                 mname: Kathy
1334                 lname: Perez
1335                 federaltaxid: ''
1336                 federaldrugid: ''
1337                 upin: ''
1338                 facility_id: '3'
1339                 facility: 'Your Clinic Name Here'
1340                 npi: '12345678901'
1341                 email: info@pennfirm.com
1342                 specialty: ''
1343                 billname: null
1344                 url: null
1345                 assistant: null
1346                 organization: null
1347                 valedictory: null
1348                 street: '789 Third Avenue'
1349                 streetb: '123 Cannaut Street'
1350                 city: 'San Diego'
1351                 state: CA
1352                 zip: '90210'
1353                 phone: '(619) 555-9827'
1354                 fax: null
1355                 phonew1: '(619) 555-7822'
1356                 phonecell: '(619) 555-7821'
1357                 notes: null
1358                 state_license_number: '123456'
1359                 username: eduardoperez
1360       responses:
1361         '200':
1362           description: 'Standard response'
1363           content:
1364             application/json:
1365               schema:
1366                 properties:
1367                   validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
1368                   internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
1369                   data: { description: 'Returned data.', type: array, items: { properties: { id: { description: 'practitioner id', type: integer }, uuid: { description: 'practitioner uuid', type: string } }, type: object } }
1370                 type: object
1371                 example:
1372                   validationErrors: []
1373                   error_description: []
1374                   data: { id: 7, uuid: 90d453fb-0248-4c0d-9575-d99d02b169f5 }
1375         '401':
1376           $ref: '#/components/responses/unauthorized'
1377       security:
1378         -
1379           openemr_auth: []
1380   '/api/practitioner/{pruuid}':
1381     get:
1382       tags:
1383         - standard
1384       description: 'Retrieves a single practitioner by their uuid'
1385       parameters:
1386         -
1387           name: pruuid
1388           in: path
1389           description: 'The uuid for the practitioner.'
1390           required: true
1391           schema:
1392             type: string
1393       responses:
1394         '200':
1395           $ref: '#/components/responses/standard'
1396         '400':
1397           $ref: '#/components/responses/badrequest'
1398         '401':
1399           $ref: '#/components/responses/unauthorized'
1400       security:
1401         -
1402           openemr_auth: []
1403     put:
1404       tags:
1405         - standard
1406       description: 'Edit a practitioner'
1407       parameters:
1408         -
1409           name: pruuid
1410           in: path
1411           description: 'The uuid for the practitioner.'
1412           required: true
1413           schema:
1414             type: string
1415       requestBody:
1416         required: true
1417         content:
1418           application/json:
1419             schema:
1420               properties:
1421                 title:
1422                   description: 'The title for the practitioner.'
1423                   type: string
1424                 fname:
1425                   description: 'The first name for the practitioner.'
1426                   type: string
1427                 mname:
1428                   description: 'The middle name for the practitioner.'
1429                   type: string
1430                 lname:
1431                   description: 'The last name for the practitioner.'
1432                   type: string
1433                 federaltaxid:
1434                   description: 'The federal tax id for the practitioner.'
1435                   type: string
1436                 federaldrugid:
1437                   description: 'The federal drug id for the practitioner.'
1438                   type: string
1439                 upin:
1440                   description: 'The upin for the practitioner.'
1441                   type: string
1442                 facility_id:
1443                   description: 'The facility_id for the practitioner.'
1444                   type: string
1445                 facility:
1446                   description: 'The facility name for the practitioner.'
1447                   type: string
1448                 npi:
1449                   description: 'The npi for the practitioner.'
1450                   type: string
1451                 email:
1452                   description: 'The email for the practitioner.'
1453                   type: string
1454                 specialty:
1455                   description: 'The specialty for the practitioner.'
1456                   type: string
1457                 billname:
1458                   description: 'The billname for the practitioner.'
1459                   type: string
1460                 url:
1461                   description: 'The url for the practitioner.'
1462                   type: string
1463                 assistant:
1464                   description: 'The assistant for the practitioner.'
1465                   type: string
1466                 valedictory:
1467                   description: 'The valedictory for the practitioner.'
1468                   type: string
1469                 street:
1470                   description: 'The street address for the practitioner.'
1471                   type: string
1472                 streetb:
1473                   description: 'The streetb address for the practitioner.'
1474                   type: string
1475                 city:
1476                   description: 'The city for the practitioner.'
1477                   type: string
1478                 state:
1479                   description: 'The state for the practitioner.'
1480                   type: string
1481                 zip:
1482                   description: 'The zip for the practitioner.'
1483                   type: string
1484                 phone:
1485                   description: 'The phone for the practitioner.'
1486                   type: string
1487                 fax:
1488                   description: 'The fax for the practitioner.'
1489                   type: string
1490                 phonew1:
1491                   description: 'The phonew1 for the practitioner.'
1492                   type: string
1493                 phonecell:
1494                   description: 'The phonecell for the practitioner.'
1495                   type: string
1496                 notes:
1497                   description: 'The notes for the practitioner.'
1498                   type: string
1499                 state_license_number:
1500                   description: 'The state license number for the practitioner.'
1501                   type: string
1502                 username:
1503                   description: 'The username for the practitioner.'
1504                   type: string
1505               type: object
1506               example:
1507                 title: Mr
1508                 fname: Baz
1509                 mname: ''
1510                 lname: Bop
1511                 street: '456 Tree Lane'
1512                 zip: '08642'
1513                 city: FooTown
1514                 state: FL
1515                 phone: 123-456-7890
1516       responses:
1517         '200':
1518           description: 'Standard response'
1519           content:
1520             application/json:
1521               schema:
1522                 properties:
1523                   validationErrors: { description: 'Validation errors.', type: array, items: { type: object } }
1524                   internalErrors: { description: 'Internal errors.', type: array, items: { type: object } }
1525                   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 } }
1526                 type: object
1527                 example:
1528                   validationErrors: []
1529                   error_description: []
1530                   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 }
1531         '401':
1532           $ref: '#/components/responses/unauthorized'
1533       security:
1534         -
1535           openemr_auth: []
1536   /api/medical_problem:
1537     get:
1538       tags:
1539         - standard
1540       description: 'Retrieves a list of medical problems'
1541       parameters:
1542         -
1543           name: puuid
1544           in: query
1545           description: 'The uuid for the patient.'
1546           required: false
1547           schema:
1548             type: string
1549         -
1550           name: condition_uuid
1551           in: query
1552           description: 'The uuid for the medical problem.'
1553           required: false
1554           schema:
1555             type: string
1556         -
1557           name: title
1558           in: query
1559           description: 'The title for the medical problem.'
1560           required: false
1561           schema:
1562             type: string
1563         -
1564           name: begdate
1565           in: query
1566           description: 'The start date for the medical problem.'
1567           required: false
1568           schema:
1569             type: string
1570         -
1571           name: enddate
1572           in: query
1573           description: 'The end date for the medical problem.'
1574           required: false
1575           schema:
1576             type: string
1577         -
1578           name: diagnosis
1579           in: query
1580           description: 'The diagnosis for the medical problem.'
1581           required: false
1582           schema:
1583             type: string
1584       responses:
1585         '200':
1586           $ref: '#/components/responses/standard'
1587         '400':
1588           $ref: '#/components/responses/badrequest'
1589         '401':
1590           $ref: '#/components/responses/unauthorized'
1591       security:
1592         -
1593           openemr_auth: []
1594   '/api/medical_problem/{muuid}':
1595     get:
1596       tags:
1597         - standard
1598       description: 'Retrieves a single medical problem by their uuid'
1599       parameters:
1600         -
1601           name: muuid
1602           in: path
1603           description: 'The uuid for the medical problem.'
1604           required: true
1605           schema:
1606             type: string
1607       responses:
1608         '200':
1609           $ref: '#/components/responses/standard'
1610         '400':
1611           $ref: '#/components/responses/badrequest'
1612         '401':
1613           $ref: '#/components/responses/unauthorized'
1614       security:
1615         -
1616           openemr_auth: []
1617   '/api/patient/{puuid}/medical_problem':
1618     get:
1619       tags:
1620         - standard
1621       description: 'Retrieves all medical problems for a patient'
1622       parameters:
1623         -
1624           name: puuid
1625           in: path
1626           description: 'The uuid for the patient.'
1627           required: true
1628           schema:
1629             type: string
1630       responses:
1631         '200':
1632           $ref: '#/components/responses/standard'
1633         '400':
1634           $ref: '#/components/responses/badrequest'
1635         '401':
1636           $ref: '#/components/responses/unauthorized'
1637       security:
1638         -
1639           openemr_auth: []
1640     post:
1641       tags:
1642         - standard
1643       description: 'Submits a new medical problem'
1644       parameters:
1645         -
1646           name: puuid
1647           in: path
1648           description: 'The uuid for the patient.'
1649           required: true
1650           schema:
1651             type: string
1652       requestBody:
1653         required: true
1654         content:
1655           application/json:
1656             schema:
1657               $ref: '#/components/schemas/api_medical_problem_request'
1658       responses:
1659         '200':
1660           $ref: '#/components/responses/standard'
1661         '400':
1662           $ref: '#/components/responses/badrequest'
1663         '401':
1664           $ref: '#/components/responses/unauthorized'
1665       security:
1666         -
1667           openemr_auth: []
1668   '/api/patient/{puuid}/medical_problem/{muuid}':
1669     get:
1670       tags:
1671         - standard
1672       description: 'Retrieves a medical problem for a patient'
1673       parameters:
1674         -
1675           name: puuid
1676           in: path
1677           description: 'The uuid for the patient.'
1678           required: true
1679           schema:
1680             type: string
1681         -
1682           name: muuid
1683           in: path
1684           description: 'The uuid for the medical problem.'
1685           required: true
1686           schema:
1687             type: string
1688       responses:
1689         '200':
1690           $ref: '#/components/responses/standard'
1691         '400':
1692           $ref: '#/components/responses/badrequest'
1693         '401':
1694           $ref: '#/components/responses/unauthorized'
1695       security:
1696         -
1697           openemr_auth: []
1698     put:
1699       tags:
1700         - standard
1701       description: 'Edit a medical problem'
1702       parameters:
1703         -
1704           name: puuid
1705           in: path
1706           description: 'The uuid for the patient.'
1707           required: true
1708           schema:
1709             type: string
1710         -
1711           name: muuid
1712           in: path
1713           description: 'The uuid for the medical problem.'
1714           required: true
1715           schema:
1716             type: string
1717       requestBody:
1718         required: true
1719         content:
1720           application/json:
1721             schema:
1722               $ref: '#/components/schemas/api_medical_problem_request'
1723       responses:
1724         '200':
1725           $ref: '#/components/responses/standard'
1726         '400':
1727           $ref: '#/components/responses/badrequest'
1728         '401':
1729           $ref: '#/components/responses/unauthorized'
1730       security:
1731         -
1732           openemr_auth: []
1733     delete:
1734       tags:
1735         - standard
1736       description: 'Delete a medical problem'
1737       parameters:
1738         -
1739           name: puuid
1740           in: path
1741           description: 'The uuid for the patient.'
1742           required: true
1743           schema:
1744             type: string
1745         -
1746           name: muuid
1747           in: path
1748           description: 'The uuid for the medical problem.'
1749           required: true
1750           schema:
1751             type: string
1752       responses:
1753         '200':
1754           $ref: '#/components/responses/standard'
1755         '400':
1756           $ref: '#/components/responses/badrequest'
1757         '401':
1758           $ref: '#/components/responses/unauthorized'
1759       security:
1760         -
1761           openemr_auth: []
1762   /api/allergy:
1763     get:
1764       tags:
1765         - standard
1766       description: 'Retrieves a list of allergies'
1767       parameters:
1768         -
1769           name: lists.pid
1770           in: query
1771           description: 'The uuid for the patient.'
1772           required: false
1773           schema:
1774             type: string
1775         -
1776           name: lists.id
1777           in: query
1778           description: 'The uuid for the allergy.'
1779           required: false
1780           schema:
1781             type: string
1782         -
1783           name: title
1784           in: query
1785           description: 'The title for the allergy.'
1786           required: false
1787           schema:
1788             type: string
1789         -
1790           name: begdate
1791           in: query
1792           description: 'The start date for the allergy.'
1793           required: false
1794           schema:
1795             type: string
1796         -
1797           name: enddate
1798           in: query
1799           description: 'The end date for the allergy.'
1800           required: false
1801           schema:
1802             type: string
1803         -
1804           name: diagnosis
1805           in: query
1806           description: 'The diagnosis for the allergy.'
1807           required: false
1808           schema:
1809             type: string
1810       responses:
1811         '200':
1812           $ref: '#/components/responses/standard'
1813         '400':
1814           $ref: '#/components/responses/badrequest'
1815         '401':
1816           $ref: '#/components/responses/unauthorized'
1817       security:
1818         -
1819           openemr_auth: []
1820   '/api/allergy/{auuid}':
1821     get:
1822       tags:
1823         - standard
1824       description: 'Retrieves a single allergy by their uuid'
1825       parameters:
1826         -
1827           name: auuid
1828           in: path
1829           description: 'The uuid for the allergy.'
1830           required: true
1831           schema:
1832             type: string
1833       responses:
1834         '200':
1835           $ref: '#/components/responses/standard'
1836         '400':
1837           $ref: '#/components/responses/badrequest'
1838         '401':
1839           $ref: '#/components/responses/unauthorized'
1840       security:
1841         -
1842           openemr_auth: []
1843   '/api/patient/{puuid}/allergy':
1844     get:
1845       tags:
1846         - standard
1847       description: 'Retrieves all allergies for a patient'
1848       parameters:
1849         -
1850           name: puuid
1851           in: path
1852           description: 'The uuid for the patient.'
1853           required: true
1854           schema:
1855             type: string
1856       responses:
1857         '200':
1858           $ref: '#/components/responses/standard'
1859         '400':
1860           $ref: '#/components/responses/badrequest'
1861         '401':
1862           $ref: '#/components/responses/unauthorized'
1863       security:
1864         -
1865           openemr_auth: []
1866     post:
1867       tags:
1868         - standard
1869       description: 'Submits a new allergy'
1870       parameters:
1871         -
1872           name: puuid
1873           in: path
1874           description: 'The uuid for the patient.'
1875           required: true
1876           schema:
1877             type: string
1878       requestBody:
1879         required: true
1880         content:
1881           application/json:
1882             schema:
1883               $ref: '#/components/schemas/api_allergy_request'
1884       responses:
1885         '200':
1886           $ref: '#/components/responses/standard'
1887         '400':
1888           $ref: '#/components/responses/badrequest'
1889         '401':
1890           $ref: '#/components/responses/unauthorized'
1891       security:
1892         -
1893           openemr_auth: []
1894   '/api/patient/{puuid}/allergy/{auuid}':
1895     get:
1896       tags:
1897         - standard
1898       description: 'Retrieves a allergy for a patient'
1899       parameters:
1900         -
1901           name: puuid
1902           in: path
1903           description: 'The uuid for the patient.'
1904           required: true
1905           schema:
1906             type: string
1907         -
1908           name: auuid
1909           in: path
1910           description: 'The uuid for the allergy.'
1911           required: true
1912           schema:
1913             type: string
1914       responses:
1915         '200':
1916           $ref: '#/components/responses/standard'
1917         '400':
1918           $ref: '#/components/responses/badrequest'
1919         '401':
1920           $ref: '#/components/responses/unauthorized'
1921       security:
1922         -
1923           openemr_auth: []
1924     put:
1925       tags:
1926         - standard
1927       description: 'Edit a allergy'
1928       parameters:
1929         -
1930           name: puuid
1931           in: path
1932           description: 'The uuid for the patient.'
1933           required: true
1934           schema:
1935             type: string
1936         -
1937           name: auuid
1938           in: path
1939           description: 'The uuid for the allergy.'
1940           required: true
1941           schema:
1942             type: string
1943       requestBody:
1944         required: true
1945         content:
1946           application/json:
1947             schema:
1948               $ref: '#/components/schemas/api_allergy_request'
1949       responses:
1950         '200':
1951           $ref: '#/components/responses/standard'
1952         '400':
1953           $ref: '#/components/responses/badrequest'
1954         '401':
1955           $ref: '#/components/responses/unauthorized'
1956       security:
1957         -
1958           openemr_auth: []
1959     delete:
1960       tags:
1961         - standard
1962       description: 'Delete a medical problem'
1963       parameters:
1964         -
1965           name: puuid
1966           in: path
1967           description: 'The uuid for the patient.'
1968           required: true
1969           schema:
1970             type: string
1971         -
1972           name: auuid
1973           in: path
1974           description: 'The uuid for the allergy.'
1975           required: true
1976           schema:
1977             type: string
1978       responses:
1979         '200':
1980           $ref: '#/components/responses/standard'
1981         '400':
1982           $ref: '#/components/responses/badrequest'
1983         '401':
1984           $ref: '#/components/responses/unauthorized'
1985       security:
1986         -
1987           openemr_auth: []
1988   '/api/patient/{pid}/medication':
1989     get:
1990       tags:
1991         - standard
1992       description: 'Retrieves all medications for a patient'
1993       parameters:
1994         -
1995           name: pid
1996           in: path
1997           description: 'The pid for the patient.'
1998           required: true
1999           schema:
2000             type: string
2001       responses:
2002         '200':
2003           $ref: '#/components/responses/standard'
2004         '400':
2005           $ref: '#/components/responses/badrequest'
2006         '401':
2007           $ref: '#/components/responses/unauthorized'
2008       security:
2009         -
2010           openemr_auth: []
2011     post:
2012       tags:
2013         - standard
2014       description: 'Submits a new medication'
2015       parameters:
2016         -
2017           name: pid
2018           in: path
2019           description: 'The pid for the patient.'
2020           required: true
2021           schema:
2022             type: string
2023       requestBody:
2024         required: true
2025         content:
2026           application/json:
2027             schema:
2028               $ref: '#/components/schemas/api_medication_request'
2029       responses:
2030         '200':
2031           $ref: '#/components/responses/standard'
2032         '400':
2033           $ref: '#/components/responses/badrequest'
2034         '401':
2035           $ref: '#/components/responses/unauthorized'
2036       security:
2037         -
2038           openemr_auth: []
2039   '/api/patient/{pid}/medication/{mid}':
2040     get:
2041       tags:
2042         - standard
2043       description: 'Retrieves a medication for a patient'
2044       parameters:
2045         -
2046           name: pid
2047           in: path
2048           description: 'The id for the patient.'
2049           required: true
2050           schema:
2051             type: string
2052         -
2053           name: mid
2054           in: path
2055           description: 'The id for the medication.'
2056           required: true
2057           schema:
2058             type: string
2059       responses:
2060         '200':
2061           $ref: '#/components/responses/standard'
2062         '400':
2063           $ref: '#/components/responses/badrequest'
2064         '401':
2065           $ref: '#/components/responses/unauthorized'
2066       security:
2067         -
2068           openemr_auth: []
2069     put:
2070       tags:
2071         - standard
2072       description: 'Edit a medication'
2073       parameters:
2074         -
2075           name: pid
2076           in: path
2077           description: 'The pid for the patient.'
2078           required: true
2079           schema:
2080             type: string
2081         -
2082           name: mid
2083           in: path
2084           description: 'The id for the medication.'
2085           required: true
2086           schema:
2087             type: string
2088       requestBody:
2089         required: true
2090         content:
2091           application/json:
2092             schema:
2093               $ref: '#/components/schemas/api_medication_request'
2094       responses:
2095         '200':
2096           $ref: '#/components/responses/standard'
2097         '400':
2098           $ref: '#/components/responses/badrequest'
2099         '401':
2100           $ref: '#/components/responses/unauthorized'
2101       security:
2102         -
2103           openemr_auth: []
2104     delete:
2105       tags:
2106         - standard
2107       description: 'Delete a medication'
2108       parameters:
2109         -
2110           name: pid
2111           in: path
2112           description: 'The id for the patient.'
2113           required: true
2114           schema:
2115             type: string
2116         -
2117           name: mid
2118           in: path
2119           description: 'The id for the medication.'
2120           required: true
2121           schema:
2122             type: string
2123       responses:
2124         '200':
2125           $ref: '#/components/responses/standard'
2126         '400':
2127           $ref: '#/components/responses/badrequest'
2128         '401':
2129           $ref: '#/components/responses/unauthorized'
2130       security:
2131         -
2132           openemr_auth: []
2133   '/api/patient/{pid}/surgery':
2134     get:
2135       tags:
2136         - standard
2137       description: 'Retrieves all surgeries for a patient'
2138       parameters:
2139         -
2140           name: pid
2141           in: path
2142           description: 'The pid for the patient.'
2143           required: true
2144           schema:
2145             type: string
2146       responses:
2147         '200':
2148           $ref: '#/components/responses/standard'
2149         '400':
2150           $ref: '#/components/responses/badrequest'
2151         '401':
2152           $ref: '#/components/responses/unauthorized'
2153       security:
2154         -
2155           openemr_auth: []
2156     post:
2157       tags:
2158         - standard
2159       description: 'Submits a new surgery'
2160       parameters:
2161         -
2162           name: pid
2163           in: path
2164           description: 'The pid for the patient.'
2165           required: true
2166           schema:
2167             type: string
2168       requestBody:
2169         required: true
2170         content:
2171           application/json:
2172             schema:
2173               $ref: '#/components/schemas/api_surgery_request'
2174       responses:
2175         '200':
2176           $ref: '#/components/responses/standard'
2177         '400':
2178           $ref: '#/components/responses/badrequest'
2179         '401':
2180           $ref: '#/components/responses/unauthorized'
2181       security:
2182         -
2183           openemr_auth: []
2184   '/api/patient/{pid}/surgery/{sid}':
2185     get:
2186       tags:
2187         - standard
2188       description: 'Retrieves a surgery for a patient'
2189       parameters:
2190         -
2191           name: pid
2192           in: path
2193           description: 'The id for the patient.'
2194           required: true
2195           schema:
2196             type: string
2197         -
2198           name: sid
2199           in: path
2200           description: 'The id for the surgery.'
2201           required: true
2202           schema:
2203             type: string
2204       responses:
2205         '200':
2206           $ref: '#/components/responses/standard'
2207         '400':
2208           $ref: '#/components/responses/badrequest'
2209         '401':
2210           $ref: '#/components/responses/unauthorized'
2211       security:
2212         -
2213           openemr_auth: []
2214     put:
2215       tags:
2216         - standard
2217       description: 'Edit a surgery'
2218       parameters:
2219         -
2220           name: pid
2221           in: path
2222           description: 'The pid for the patient.'
2223           required: true
2224           schema:
2225             type: string
2226         -
2227           name: sid
2228           in: path
2229           description: 'The id for the surgery.'
2230           required: true
2231           schema:
2232             type: string
2233       requestBody:
2234         required: true
2235         content:
2236           application/json:
2237             schema:
2238               $ref: '#/components/schemas/api_surgery_request'
2239       responses:
2240         '200':
2241           $ref: '#/components/responses/standard'
2242         '400':
2243           $ref: '#/components/responses/badrequest'
2244         '401':
2245           $ref: '#/components/responses/unauthorized'
2246       security:
2247         -
2248           openemr_auth: []
2249     delete:
2250       tags:
2251         - standard
2252       description: 'Delete a surgery'
2253       parameters:
2254         -
2255           name: pid
2256           in: path
2257           description: 'The id for the patient.'
2258           required: true
2259           schema:
2260             type: string
2261         -
2262           name: sid
2263           in: path
2264           description: 'The id for the surgery.'
2265           required: true
2266           schema:
2267             type: string
2268       responses:
2269         '200':
2270           $ref: '#/components/responses/standard'
2271         '400':
2272           $ref: '#/components/responses/badrequest'
2273         '401':
2274           $ref: '#/components/responses/unauthorized'
2275       security:
2276         -
2277           openemr_auth: []
2278   '/api/patient/{pid}/dental_issue':
2279     get:
2280       tags:
2281         - standard
2282       description: 'Retrieves all dental issues for a patient'
2283       parameters:
2284         -
2285           name: pid
2286           in: path
2287           description: 'The pid for the patient.'
2288           required: true
2289           schema:
2290             type: string
2291       responses:
2292         '200':
2293           $ref: '#/components/responses/standard'
2294         '400':
2295           $ref: '#/components/responses/badrequest'
2296         '401':
2297           $ref: '#/components/responses/unauthorized'
2298       security:
2299         -
2300           openemr_auth: []
2301     post:
2302       tags:
2303         - standard
2304       description: 'Submits a new dental issue'
2305       parameters:
2306         -
2307           name: pid
2308           in: path
2309           description: 'The pid for the patient.'
2310           required: true
2311           schema:
2312             type: string
2313       requestBody:
2314         required: true
2315         content:
2316           application/json:
2317             schema:
2318               $ref: '#/components/schemas/api_dental_issue_request'
2319       responses:
2320         '200':
2321           $ref: '#/components/responses/standard'
2322         '400':
2323           $ref: '#/components/responses/badrequest'
2324         '401':
2325           $ref: '#/components/responses/unauthorized'
2326       security:
2327         -
2328           openemr_auth: []
2329   '/api/patient/{pid}/dental_issue/{did}':
2330     get:
2331       tags:
2332         - standard
2333       description: 'Retrieves a dental issue for a patient'
2334       parameters:
2335         -
2336           name: pid
2337           in: path
2338           description: 'The id for the patient.'
2339           required: true
2340           schema:
2341             type: string
2342         -
2343           name: did
2344           in: path
2345           description: 'The id for the dental issue.'
2346           required: true
2347           schema:
2348             type: string
2349       responses:
2350         '200':
2351           $ref: '#/components/responses/standard'
2352         '400':
2353           $ref: '#/components/responses/badrequest'
2354         '401':
2355           $ref: '#/components/responses/unauthorized'
2356       security:
2357         -
2358           openemr_auth: []
2359     put:
2360       tags:
2361         - standard
2362       description: 'Edit a dental issue'
2363       parameters:
2364         -
2365           name: pid
2366           in: path
2367           description: 'The pid for the patient.'
2368           required: true
2369           schema:
2370             type: string
2371         -
2372           name: did
2373           in: path
2374           description: 'The id for the dental issue.'
2375           required: true
2376           schema:
2377             type: string
2378       requestBody:
2379         required: true
2380         content:
2381           application/json:
2382             schema:
2383               $ref: '#/components/schemas/api_dental_issue_request'
2384       responses:
2385         '200':
2386           $ref: '#/components/responses/standard'
2387         '400':
2388           $ref: '#/components/responses/badrequest'
2389         '401':
2390           $ref: '#/components/responses/unauthorized'
2391       security:
2392         -
2393           openemr_auth: []
2394     delete:
2395       tags:
2396         - standard
2397       description: 'Delete a dental issue'
2398       parameters:
2399         -
2400           name: pid
2401           in: path
2402           description: 'The id for the patient.'
2403           required: true
2404           schema:
2405             type: string
2406         -
2407           name: did
2408           in: path
2409           description: 'The id for the dental issue.'
2410           required: true
2411           schema:
2412             type: string
2413       responses:
2414         '200':
2415           $ref: '#/components/responses/standard'
2416         '400':
2417           $ref: '#/components/responses/badrequest'
2418         '401':
2419           $ref: '#/components/responses/unauthorized'
2420       security:
2421         -
2422           openemr_auth: []
2423   '/api/patient/{pid}/appointment':
2424     get:
2425       tags:
2426         - standard
2427       description: 'Retrieves all appointments for a patient'
2428       parameters:
2429         -
2430           name: pid
2431           in: path
2432           description: 'The pid for the patient.'
2433           required: true
2434           schema:
2435             type: string
2436       responses:
2437         '200':
2438           $ref: '#/components/responses/standard'
2439         '400':
2440           $ref: '#/components/responses/badrequest'
2441         '401':
2442           $ref: '#/components/responses/unauthorized'
2443       security:
2444         -
2445           openemr_auth: []
2446     post:
2447       tags:
2448         - standard
2449       description: 'Submits a new appointment'
2450       parameters:
2451         -
2452           name: pid
2453           in: path
2454           description: 'The id for the patient.'
2455           required: true
2456           schema:
2457             type: string
2458       requestBody:
2459         required: true
2460         content:
2461           application/json:
2462             schema:
2463               required:
2464                 - pc_catid
2465                 - pc_title
2466                 - pc_duration
2467                 - pc_hometext
2468                 - pc_apptstatus
2469                 - pc_eventDate
2470                 - pc_startTime
2471                 - pc_facility
2472                 - pc_billing_location
2473               properties:
2474                 pc_catid:
2475                   description: 'The category of the appointment.'
2476                   type: string
2477                 pc_title:
2478                   description: 'The title of the appointment.'
2479                   type: string
2480                 pc_duration:
2481                   description: 'The duration of the appointment.'
2482                   type: string
2483                 pc_hometext:
2484                   description: 'Comments for the appointment.'
2485                   type: string
2486                 pc_apptstatus:
2487                   description: 'use an option from resource=/api/list/apptstat'
2488                   type: string
2489                 pc_eventDate:
2490                   description: 'The date of the appointment.'
2491                   type: string
2492                 pc_startTime:
2493                   description: 'The time of the appointment.'
2494                   type: string
2495                 pc_facility:
2496                   description: 'The facility id of the appointment.'
2497                   type: string
2498                 pc_billing_location:
2499                   description: 'The billinag location id of the appointment.'
2500                   type: string
2501                 pc_aid:
2502                   description: 'The provider id for the appointment.'
2503                   type: string
2504               type: object
2505               example:
2506                 pc_catid: '5'
2507                 pc_title: 'Office Visit'
2508                 pc_duration: '900'
2509                 pc_hometext: Test
2510                 pc_apptstatus: '-'
2511                 pc_eventDate: '2018-10-19'
2512                 pc_startTime: '09:00'
2513                 pc_facility: '9'
2514                 pc_billing_location: '10'
2515                 pc_aid: '1'
2516       responses:
2517         '200':
2518           $ref: '#/components/responses/standard'
2519         '400':
2520           $ref: '#/components/responses/badrequest'
2521         '401':
2522           $ref: '#/components/responses/unauthorized'
2523       security:
2524         -
2525           openemr_auth: []
2526   /api/appointment:
2527     get:
2528       tags:
2529         - standard
2530       description: 'Retrieves all appointments'
2531       responses:
2532         '200':
2533           $ref: '#/components/responses/standard'
2534         '400':
2535           $ref: '#/components/responses/badrequest'
2536         '401':
2537           $ref: '#/components/responses/unauthorized'
2538       security:
2539         -
2540           openemr_auth: []
2541   '/api/appointment/{eid}':
2542     get:
2543       tags:
2544         - standard
2545       description: 'Retrieves an appointment'
2546       parameters:
2547         -
2548           name: eid
2549           in: path
2550           description: 'The eid for the appointment.'
2551           required: true
2552           schema:
2553             type: string
2554       responses:
2555         '200':
2556           $ref: '#/components/responses/standard'
2557         '400':
2558           $ref: '#/components/responses/badrequest'
2559         '401':
2560           $ref: '#/components/responses/unauthorized'
2561       security:
2562         -
2563           openemr_auth: []
2564   '/api/patient/{pid}/appointment/{eid}':
2565     get:
2566       tags:
2567         - standard
2568       description: 'Retrieves a appointment for a patient'
2569       parameters:
2570         -
2571           name: pid
2572           in: path
2573           description: 'The id for the patient.'
2574           required: true
2575           schema:
2576             type: string
2577         -
2578           name: eid
2579           in: path
2580           description: 'The eid for the appointment.'
2581           required: true
2582           schema:
2583             type: string
2584       responses:
2585         '200':
2586           $ref: '#/components/responses/standard'
2587         '400':
2588           $ref: '#/components/responses/badrequest'
2589         '401':
2590           $ref: '#/components/responses/unauthorized'
2591       security:
2592         -
2593           openemr_auth: []
2594     delete:
2595       tags:
2596         - standard
2597       description: 'Delete a appointment'
2598       parameters:
2599         -
2600           name: pid
2601           in: path
2602           description: 'The id for the patient.'
2603           required: true
2604           schema:
2605             type: string
2606         -
2607           name: eid
2608           in: path
2609           description: 'The eid for the appointment.'
2610           required: true
2611           schema:
2612             type: string
2613       responses:
2614         '200':
2615           $ref: '#/components/responses/standard'
2616         '400':
2617           $ref: '#/components/responses/badrequest'
2618         '401':
2619           $ref: '#/components/responses/unauthorized'
2620       security:
2621         -
2622           openemr_auth: []
2623   '/api/list/{list_name}':
2624     get:
2625       tags:
2626         - standard
2627       description: 'Retrieves a list'
2628       parameters:
2629         -
2630           name: list_name
2631           in: path
2632           description: 'The list_id of the list.'
2633           required: true
2634           schema:
2635             type: string
2636       responses:
2637         '200':
2638           $ref: '#/components/responses/standard'
2639         '400':
2640           $ref: '#/components/responses/badrequest'
2641         '401':
2642           $ref: '#/components/responses/unauthorized'
2643       security:
2644         -
2645           openemr_auth: []
2646   /api/version:
2647     get:
2648       tags:
2649         - standard
2650       description: 'Retrieves the OpenEMR version information'
2651       responses:
2652         '200':
2653           $ref: '#/components/responses/standard'
2654         '400':
2655           $ref: '#/components/responses/badrequest'
2656         '401':
2657           $ref: '#/components/responses/unauthorized'
2658       security:
2659         -
2660           openemr_auth: []
2661   /api/product:
2662     get:
2663       tags:
2664         - standard
2665       description: 'Retrieves the OpenEMR product registration information'
2666       responses:
2667         '200':
2668           $ref: '#/components/responses/standard'
2669         '400':
2670           $ref: '#/components/responses/badrequest'
2671         '401':
2672           $ref: '#/components/responses/unauthorized'
2673       security:
2674         -
2675           openemr_auth: []
2676   /api/insurance_company:
2677     get:
2678       tags:
2679         - standard
2680       description: 'Retrieves all insurance companies'
2681       responses:
2682         '200':
2683           $ref: '#/components/responses/standard'
2684         '400':
2685           $ref: '#/components/responses/badrequest'
2686         '401':
2687           $ref: '#/components/responses/unauthorized'
2688       security:
2689         -
2690           openemr_auth: []
2691     post:
2692       tags:
2693         - standard
2694       description: 'Submits a new insurance company'
2695       requestBody:
2696         required: true
2697         content:
2698           application/json:
2699             schema:
2700               $ref: '#/components/schemas/api_insurance_company_request'
2701       responses:
2702         '200':
2703           $ref: '#/components/responses/standard'
2704         '400':
2705           $ref: '#/components/responses/badrequest'
2706         '401':
2707           $ref: '#/components/responses/unauthorized'
2708       security:
2709         -
2710           openemr_auth: []
2711   '/api/insurance_company/{iid}':
2712     get:
2713       tags:
2714         - standard
2715       description: 'Retrieves insurance company'
2716       parameters:
2717         -
2718           name: iid
2719           in: path
2720           description: 'The id of the insurance company.'
2721           required: true
2722           schema:
2723             type: string
2724       responses:
2725         '200':
2726           $ref: '#/components/responses/standard'
2727         '400':
2728           $ref: '#/components/responses/badrequest'
2729         '401':
2730           $ref: '#/components/responses/unauthorized'
2731       security:
2732         -
2733           openemr_auth: []
2734     put:
2735       tags:
2736         - standard
2737       description: 'Edit a insurance company'
2738       parameters:
2739         -
2740           name: iid
2741           in: path
2742           description: 'The id for the insurance company.'
2743           required: true
2744           schema:
2745             type: string
2746       requestBody:
2747         required: true
2748         content:
2749           application/json:
2750             schema:
2751               $ref: '#/components/schemas/api_insurance_company_request'
2752       responses:
2753         '200':
2754           $ref: '#/components/responses/standard'
2755         '400':
2756           $ref: '#/components/responses/badrequest'
2757         '401':
2758           $ref: '#/components/responses/unauthorized'
2759       security:
2760         -
2761           openemr_auth: []
2762   /api/insurance_type:
2763     get:
2764       tags:
2765         - standard
2766       description: 'Retrieves all insurance types'
2767       responses:
2768         '200':
2769           $ref: '#/components/responses/standard'
2770         '400':
2771           $ref: '#/components/responses/badrequest'
2772         '401':
2773           $ref: '#/components/responses/unauthorized'
2774       security:
2775         -
2776           openemr_auth: []
2777   '/api/patient/{pid}/document':
2778     get:
2779       tags:
2780         - standard
2781       description: 'Retrieves all file information of documents from a category for a patient'
2782       parameters:
2783         -
2784           name: pid
2785           in: path
2786           description: 'The pid for the patient.'
2787           required: true
2788           schema:
2789             type: string
2790         -
2791           name: path
2792           in: query
2793           description: 'The category of the documents.'
2794           required: true
2795           schema:
2796             type: string
2797       responses:
2798         '200':
2799           $ref: '#/components/responses/standard'
2800         '400':
2801           $ref: '#/components/responses/badrequest'
2802         '401':
2803           $ref: '#/components/responses/unauthorized'
2804       security:
2805         -
2806           openemr_auth: []
2807     post:
2808       tags:
2809         - standard
2810       description: 'Submits a new patient document'
2811       parameters:
2812         -
2813           name: pid
2814           in: path
2815           description: 'The pid for the patient.'
2816           required: true
2817           schema:
2818             type: string
2819         -
2820           name: path
2821           in: query
2822           description: 'The category of the document.'
2823           required: true
2824           schema:
2825             type: string
2826       requestBody:
2827         required: true
2828         content:
2829           multipart/form-data:
2830             schema:
2831               properties:
2832                 document:
2833                   description: document
2834                   type: string
2835                   format: binary
2836               type: object
2837       responses:
2838         '200':
2839           $ref: '#/components/responses/standard'
2840         '400':
2841           $ref: '#/components/responses/badrequest'
2842         '401':
2843           $ref: '#/components/responses/unauthorized'
2844       security:
2845         -
2846           openemr_auth: []
2847   '/api/patient/{pid}/document/{did}':
2848     get:
2849       tags:
2850         - standard
2851       description: 'Retrieves a document for a patient'
2852       parameters:
2853         -
2854           name: pid
2855           in: path
2856           description: 'The pid for the patient.'
2857           required: true
2858           schema:
2859             type: string
2860         -
2861           name: did
2862           in: path
2863           description: 'The id for the patient document.'
2864           required: true
2865           schema:
2866             type: string
2867       responses:
2868         '200':
2869           $ref: '#/components/responses/standard'
2870         '400':
2871           $ref: '#/components/responses/badrequest'
2872         '401':
2873           $ref: '#/components/responses/unauthorized'
2874       security:
2875         -
2876           openemr_auth: []
2877   '/api/patient/{pid}/insurance':
2878     get:
2879       tags:
2880         - standard
2881       description: 'Retrieves all insurances for a patient'
2882       parameters:
2883         -
2884           name: pid
2885           in: path
2886           description: 'The pid for the patient.'
2887           required: true
2888           schema:
2889             type: string
2890       responses:
2891         '200':
2892           $ref: '#/components/responses/standard'
2893         '400':
2894           $ref: '#/components/responses/badrequest'
2895         '401':
2896           $ref: '#/components/responses/unauthorized'
2897       security:
2898         -
2899           openemr_auth: []
2900   '/api/patient/{pid}/insurance/{type}':
2901     get:
2902       tags:
2903         - standard
2904       description: 'Retrieves a insurance (by type) for a patient'
2905       parameters:
2906         -
2907           name: pid
2908           in: path
2909           description: 'The pid for the patient.'
2910           required: true
2911           schema:
2912             type: string
2913         -
2914           name: type
2915           in: path
2916           description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
2917           required: true
2918           schema:
2919             type: string
2920       responses:
2921         '200':
2922           $ref: '#/components/responses/standard'
2923         '400':
2924           $ref: '#/components/responses/badrequest'
2925         '401':
2926           $ref: '#/components/responses/unauthorized'
2927       security:
2928         -
2929           openemr_auth: []
2930     put:
2931       tags:
2932         - standard
2933       description: 'Edit a patient insurance (by type)'
2934       parameters:
2935         -
2936           name: pid
2937           in: path
2938           description: 'The pid for the patient.'
2939           required: true
2940           schema:
2941             type: string
2942         -
2943           name: type
2944           in: path
2945           description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
2946           required: true
2947           schema:
2948             type: string
2949       requestBody:
2950         required: true
2951         content:
2952           application/json:
2953             schema:
2954               $ref: '#/components/schemas/api_insurance_request'
2955       responses:
2956         '200':
2957           $ref: '#/components/responses/standard'
2958         '400':
2959           $ref: '#/components/responses/badrequest'
2960         '401':
2961           $ref: '#/components/responses/unauthorized'
2962       security:
2963         -
2964           openemr_auth: []
2965     post:
2966       tags:
2967         - standard
2968       description: 'Submits a new patient insurance (with type)'
2969       parameters:
2970         -
2971           name: pid
2972           in: path
2973           description: 'The pid for the patient.'
2974           required: true
2975           schema:
2976             type: string
2977         -
2978           name: type
2979           in: path
2980           description: 'The insurance type for the patient. (options are ''primary'', ''secondary'', or ''tertiary'')'
2981           required: true
2982           schema:
2983             type: string
2984       requestBody:
2985         required: true
2986         content:
2987           application/json:
2988             schema:
2989               $ref: '#/components/schemas/api_insurance_request'
2990       responses:
2991         '200':
2992           $ref: '#/components/responses/standard'
2993         '400':
2994           $ref: '#/components/responses/badrequest'
2995         '401':
2996           $ref: '#/components/responses/unauthorized'
2997       security:
2998         -
2999           openemr_auth: []
3000   '/api/patient/{pid}/message':
3001     post:
3002       tags:
3003         - standard
3004       description: 'Submits a pnote message'
3005       parameters:
3006         -
3007           name: pid
3008           in: path
3009           description: 'The id for the patient.'
3010           required: true
3011           schema:
3012             type: string
3013       requestBody:
3014         required: true
3015         content:
3016           application/json:
3017             schema:
3018               $ref: '#/components/schemas/api_message_request'
3019       responses:
3020         '200':
3021           $ref: '#/components/responses/standard'
3022         '400':
3023           $ref: '#/components/responses/badrequest'
3024         '401':
3025           $ref: '#/components/responses/unauthorized'
3026       security:
3027         -
3028           openemr_auth: []
3029   '/api/patient/{pid}/transaction':
3030     get:
3031       tags:
3032         - standard
3033       description: 'Get Transactions for a patient'
3034       parameters:
3035         -
3036           name: pid
3037           in: path
3038           description: 'The pid for the patient'
3039           required: true
3040           schema:
3041             type: string
3042       responses:
3043         '200':
3044           $ref: '#/components/responses/standard'
3045         '400':
3046           $ref: '#/components/responses/badrequest'
3047         '401':
3048           $ref: '#/components/responses/unauthorized'
3049       security:
3050         -
3051           openemr_auth: []
3052     post:
3053       tags:
3054         - standard
3055       description: 'Submits a transaction'
3056       parameters:
3057         -
3058           name: pid
3059           in: path
3060           description: 'The pid for the patient.'
3061           required: true
3062           schema:
3063             type: string
3064       requestBody:
3065         required: true
3066         content:
3067           application/json:
3068             schema:
3069               $ref: '#/components/schemas/api_transaction_request'
3070       responses:
3071         '200':
3072           $ref: '#/components/responses/standard'
3073         '400':
3074           $ref: '#/components/responses/badrequest'
3075         '401':
3076           $ref: '#/components/responses/unauthorized'
3077       security:
3078         -
3079           openemr_auth: []
3080   '/api/transaction/{tid}':
3081     put:
3082       tags:
3083         - standard
3084       description: 'Updates a transaction'
3085       parameters:
3086         -
3087           name: tid
3088           in: path
3089           description: 'The id for the transaction.'
3090           required: true
3091           schema:
3092             type: string
3093       requestBody:
3094         required: true
3095         content:
3096           application/json:
3097             schema:
3098               $ref: '#/components/schemas/api_transaction_request'
3099       responses:
3100         '200':
3101           $ref: '#/components/responses/standard'
3102         '400':
3103           $ref: '#/components/responses/badrequest'
3104         '401':
3105           $ref: '#/components/responses/unauthorized'
3106       security:
3107         -
3108           openemr_auth: []
3109   '/api/patient/{pid}/message/{mid}':
3110     put:
3111       tags:
3112         - standard
3113       description: 'Edit a pnote message'
3114       parameters:
3115         -
3116           name: pid
3117           in: path
3118           description: 'The id for the patient.'
3119           required: true
3120           schema:
3121             type: string
3122         -
3123           name: mid
3124           in: path
3125           description: 'The id for the pnote message.'
3126           required: true
3127           schema:
3128             type: string
3129       requestBody:
3130         required: true
3131         content:
3132           application/json:
3133             schema:
3134               $ref: '#/components/schemas/api_message_request'
3135       responses:
3136         '200':
3137           $ref: '#/components/responses/standard'
3138         '400':
3139           $ref: '#/components/responses/badrequest'
3140         '401':
3141           $ref: '#/components/responses/unauthorized'
3142       security:
3143         -
3144           openemr_auth: []
3145     delete:
3146       tags:
3147         - standard
3148       description: 'Delete a pnote message'
3149       parameters:
3150         -
3151           name: pid
3152           in: path
3153           description: 'The id for the patient.'
3154           required: true
3155           schema:
3156             type: string
3157         -
3158           name: eid
3159           in: path
3160           description: 'The id for the pnote message.'
3161           required: true
3162           schema:
3163             type: string
3164       responses:
3165         '200':
3166           $ref: '#/components/responses/standard'
3167         '400':
3168           $ref: '#/components/responses/badrequest'
3169         '401':
3170           $ref: '#/components/responses/unauthorized'
3171       security:
3172         -
3173           openemr_auth: []
3174   /api/immunization:
3175     get:
3176       tags:
3177         - standard
3178       description: 'Retrieves a list of immunizations'
3179       parameters:
3180         -
3181           name: patient_id
3182           in: query
3183           description: 'The pid for the patient.'
3184           required: false
3185           schema:
3186             type: string
3187         -
3188           name: id
3189           in: query
3190           description: 'The id for the immunization.'
3191           required: false
3192           schema:
3193             type: string
3194         -
3195           name: uuid
3196           in: query
3197           description: 'The uuid for the immunization.'
3198           required: false
3199           schema:
3200             type: string
3201         -
3202           name: administered_date
3203           in: query
3204           description: 'The administered date for the immunization.'
3205           required: false
3206           schema:
3207             type: string
3208         -
3209           name: immunization_id
3210           in: query
3211           description: 'The immunization list_id for the immunization.'
3212           required: false
3213           schema:
3214             type: string
3215         -
3216           name: cvx_code
3217           in: query
3218           description: 'The cvx code for the immunization.'
3219           required: false
3220           schema:
3221             type: string
3222         -
3223           name: manufacturer
3224           in: query
3225           description: 'The manufacturer for the immunization.'
3226           required: false
3227           schema:
3228             type: string
3229         -
3230           name: lot_number
3231           in: query
3232           description: 'The lot number for the immunization.'
3233           required: false
3234           schema:
3235             type: string
3236         -
3237           name: administered_by_id
3238           in: query
3239           description: 'The administered by id for the immunization.'
3240           required: false
3241           schema:
3242             type: string
3243         -
3244           name: administered_by
3245           in: query
3246           description: 'The administered by for the immunization.'
3247           required: false
3248           schema:
3249             type: string
3250         -
3251           name: education_date
3252           in: query
3253           description: 'The education date for the immunization.'
3254           required: false
3255           schema:
3256             type: string
3257         -
3258           name: vis_date
3259           in: query
3260           description: 'The vis date for the immunization.'
3261           required: false
3262           schema:
3263             type: string
3264         -
3265           name: note
3266           in: query
3267           description: 'The note for the immunization.'
3268           required: false
3269           schema:
3270             type: string
3271         -
3272           name: create_date
3273           in: query
3274           description: 'The create date for the immunization.'
3275           required: false
3276           schema:
3277             type: string
3278         -
3279           name: update_date
3280           in: query
3281           description: 'The update date for the immunization.'
3282           required: false
3283           schema:
3284             type: string
3285         -
3286           name: created_by
3287           in: query
3288           description: 'The created_by for the immunization.'
3289           required: false
3290           schema:
3291             type: string
3292         -
3293           name: updated_by
3294           in: query
3295           description: 'The updated_by for the immunization.'
3296           required: false
3297           schema:
3298             type: string
3299         -
3300           name: amount_administered
3301           in: query
3302           description: 'The amount administered for the immunization.'
3303           required: false
3304           schema:
3305             type: string
3306         -
3307           name: amount_administered_unit
3308           in: query
3309           description: 'The amount administered unit for the immunization.'
3310           required: false
3311           schema:
3312             type: string
3313         -
3314           name: expiration_date
3315           in: query
3316           description: 'The expiration date for the immunization.'
3317           required: false
3318           schema:
3319             type: string
3320         -
3321           name: route
3322           in: query
3323           description: 'The route for the immunization.'
3324           required: false
3325           schema:
3326             type: string
3327         -
3328           name: administration_site
3329           in: query
3330           description: 'The administration site for the immunization.'
3331           required: false
3332           schema:
3333             type: string
3334         -
3335           name: added_erroneously
3336           in: query
3337           description: 'The added_erroneously for the immunization.'
3338           required: false
3339           schema:
3340             type: string
3341         -
3342           name: external_id
3343           in: query
3344           description: 'The external_id for the immunization.'
3345           required: false
3346           schema:
3347             type: string
3348         -
3349           name: completion_status
3350           in: query
3351           description: 'The completion status for the immunization.'
3352           required: false
3353           schema:
3354             type: string
3355         -
3356           name: information_source
3357           in: query
3358           description: 'The information source for the immunization.'
3359           required: false
3360           schema:
3361             type: string
3362         -
3363           name: refusal_reason
3364           in: query
3365           description: 'The refusal reason for the immunization.'
3366           required: false
3367           schema:
3368             type: string
3369         -
3370           name: ordering_provider
3371           in: query
3372           description: 'The ordering provider for the immunization.'
3373           required: false
3374           schema:
3375             type: string
3376       responses:
3377         '200':
3378           $ref: '#/components/responses/standard'
3379         '400':
3380           $ref: '#/components/responses/badrequest'
3381         '401':
3382           $ref: '#/components/responses/unauthorized'
3383       security:
3384         -
3385           openemr_auth: []
3386   '/api/immunization/{uuid}':
3387     get:
3388       tags:
3389         - standard
3390       description: 'Retrieves a immunization'
3391       parameters:
3392         -
3393           name: uuid
3394           in: path
3395           description: 'The uuid for the immunization.'
3396           required: true
3397           schema:
3398             type: string
3399       responses:
3400         '200':
3401           $ref: '#/components/responses/standard'
3402         '400':
3403           $ref: '#/components/responses/badrequest'
3404         '401':
3405           $ref: '#/components/responses/unauthorized'
3406       security:
3407         -
3408           openemr_auth: []
3409   /api/procedure:
3410     get:
3411       tags:
3412         - standard
3413       description: 'Retrieves a list of all procedures'
3414       responses:
3415         '200':
3416           $ref: '#/components/responses/standard'
3417         '400':
3418           $ref: '#/components/responses/badrequest'
3419         '401':
3420           $ref: '#/components/responses/unauthorized'
3421       security:
3422         -
3423           openemr_auth: []
3424   '/api/procedure/{uuid}':
3425     get:
3426       tags:
3427         - standard
3428       description: 'Retrieves a procedure'
3429       parameters:
3430         -
3431           name: uuid
3432           in: path
3433           description: 'The uuid for the procedure.'
3434           required: true
3435           schema:
3436             type: string
3437       responses:
3438         '200':
3439           $ref: '#/components/responses/standard'
3440         '400':
3441           $ref: '#/components/responses/badrequest'
3442         '401':
3443           $ref: '#/components/responses/unauthorized'
3444       security:
3445         -
3446           openemr_auth: []
3447   /api/drug:
3448     get:
3449       tags:
3450         - standard
3451       description: 'Retrieves a list of all drugs'
3452       responses:
3453         '200':
3454           $ref: '#/components/responses/standard'
3455         '400':
3456           $ref: '#/components/responses/badrequest'
3457         '401':
3458           $ref: '#/components/responses/unauthorized'
3459       security:
3460         -
3461           openemr_auth: []
3462   '/api/drug/{uuid}':
3463     get:
3464       tags:
3465         - standard
3466       description: 'Retrieves a drug'
3467       parameters:
3468         -
3469           name: uuid
3470           in: path
3471           description: 'The uuid for the drug.'
3472           required: true
3473           schema:
3474             type: string
3475       responses:
3476         '200':
3477           $ref: '#/components/responses/standard'
3478         '400':
3479           $ref: '#/components/responses/badrequest'
3480         '401':
3481           $ref: '#/components/responses/unauthorized'
3482       security:
3483         -
3484           openemr_auth: []
3485   /api/prescription:
3486     get:
3487       tags:
3488         - standard
3489       description: 'Retrieves a list of all prescriptions'
3490       responses:
3491         '200':
3492           $ref: '#/components/responses/standard'
3493         '400':
3494           $ref: '#/components/responses/badrequest'
3495         '401':
3496           $ref: '#/components/responses/unauthorized'
3497       security:
3498         -
3499           openemr_auth: []
3500   '/api/prescription/{uuid}':
3501     get:
3502       tags:
3503         - standard
3504       description: 'Retrieves a prescription'
3505       parameters:
3506         -
3507           name: uuid
3508           in: path
3509           description: 'The uuid for the prescription.'
3510           required: true
3511           schema:
3512             type: string
3513       responses:
3514         '200':
3515           $ref: '#/components/responses/standard'
3516         '400':
3517           $ref: '#/components/responses/badrequest'
3518         '401':
3519           $ref: '#/components/responses/unauthorized'
3520       security:
3521         -
3522           openemr_auth: []
3523   /fhir/AllergyIntolerance:
3524     get:
3525       tags:
3526         - fhir
3527       description: 'Returns a list of AllergyIntolerance resources.'
3528       parameters:
3529         -
3530           name: _id
3531           in: query
3532           description: 'The uuid for the AllergyIntolerance resource.'
3533           required: false
3534           schema:
3535             type: string
3536         -
3537           name: patient
3538           in: query
3539           description: 'The uuid for the patient.'
3540           required: false
3541           schema:
3542             type: string
3543       responses:
3544         '200':
3545           description: 'Standard Response'
3546           content:
3547             application/json:
3548               schema:
3549                 properties:
3550                   'json object': { description: 'FHIR Json object.', type: object }
3551                 type: object
3552                 example:
3553                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3554                   resourceType: Bundle
3555                   type: collection
3556                   total: 0
3557                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3558         '400':
3559           $ref: '#/components/responses/badrequest'
3560         '401':
3561           $ref: '#/components/responses/unauthorized'
3562       security:
3563         -
3564           openemr_auth: []
3565   '/fhir/AllergyIntolerance/{uuid}':
3566     get:
3567       tags:
3568         - fhir
3569       description: 'Returns a single AllergyIntolerance resource.'
3570       parameters:
3571         -
3572           name: uuid
3573           in: path
3574           description: 'The uuid for the AllergyIntolerance resource.'
3575           required: true
3576           schema:
3577             type: string
3578       responses:
3579         '200':
3580           description: 'Standard Response'
3581           content:
3582             application/json:
3583               schema:
3584                 properties:
3585                   'json object': { description: 'FHIR Json object.', type: object }
3586                 type: object
3587                 example:
3588                   id: 94682fe5-f383-4885-9505-64b02e34906f
3589                   meta: { versionId: '1', lastUpdated: '2021-09-16T00:27:32+00:00' }
3590                   resourceType: AllergyIntolerance
3591                   text: { status: additional, div: '<div xmlns=''http://www.w3.org/1999/xhtml''>penicillin</div>' }
3592                   clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical', code: active, display: Active }] }
3593                   verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification', code: confirmed, display: Confirmed }] }
3594                   category: [medication]
3595                   criticality: low
3596                   code: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
3597                   patient: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92 }
3598                   reaction: [{ manifestation: [{ coding: [{ system: 'http://snomed.info/sct', code: '422587007', display: Nausea }], text: Nausea }] }]
3599         '400':
3600           $ref: '#/components/responses/badrequest'
3601         '401':
3602           $ref: '#/components/responses/unauthorized'
3603         '404':
3604           $ref: '#/components/responses/uuidnotfound'
3605       security:
3606         -
3607           openemr_auth: []
3608   /fhir/Appointment:
3609     get:
3610       tags:
3611         - fhir
3612       description: 'Returns a list of Appointment resources.'
3613       parameters:
3614         -
3615           name: _id
3616           in: query
3617           description: 'The uuid for the Appointment resource.'
3618           required: false
3619           schema:
3620             type: string
3621         -
3622           name: patient
3623           in: query
3624           description: 'The uuid for the patient.'
3625           required: false
3626           schema:
3627             type: string
3628       responses:
3629         '200':
3630           description: 'Standard Response'
3631           content:
3632             application/json:
3633               schema:
3634                 properties:
3635                   'json object': { description: 'FHIR Json object.', type: object }
3636                 type: object
3637                 example:
3638                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3639                   resourceType: Bundle
3640                   type: collection
3641                   total: 0
3642                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/AllergyIntolerance' }]
3643         '400':
3644           $ref: '#/components/responses/badrequest'
3645         '401':
3646           $ref: '#/components/responses/unauthorized'
3647       security:
3648         -
3649           openemr_auth: []
3650   '/fhir/Appointment/{uuid}':
3651     get:
3652       tags:
3653         - fhir
3654       description: 'Returns a single Appointment resource.'
3655       parameters:
3656         -
3657           name: uuid
3658           in: path
3659           description: 'The uuid for the Appointment resource.'
3660           required: true
3661           schema:
3662             type: string
3663       responses:
3664         '200':
3665           description: 'Standard Response'
3666           content:
3667             application/json:
3668               schema:
3669                 properties:
3670                   'json object': { description: 'FHIR Json object.', type: object }
3671                 type: object
3672                 example: []
3673         '400':
3674           $ref: '#/components/responses/badrequest'
3675         '401':
3676           $ref: '#/components/responses/unauthorized'
3677         '404':
3678           $ref: '#/components/responses/uuidnotfound'
3679       security:
3680         -
3681           openemr_auth: []
3682   /fhir/CarePlan:
3683     get:
3684       tags:
3685         - fhir
3686       description: 'Returns a list of CarePlan resources.'
3687       parameters:
3688         -
3689           name: _id
3690           in: query
3691           description: 'The uuid for the CarePlan resource.'
3692           required: false
3693           schema:
3694             type: string
3695         -
3696           name: patient
3697           in: query
3698           description: 'The uuid for the patient.'
3699           required: false
3700           schema:
3701             type: string
3702         -
3703           name: category
3704           in: query
3705           description: 'The category of the CarePlan resource.'
3706           required: false
3707           schema:
3708             type: string
3709       responses:
3710         '200':
3711           description: 'Standard Response'
3712           content:
3713             application/json:
3714               schema:
3715                 properties:
3716                   'json object': { description: 'FHIR Json object.', type: object }
3717                 type: object
3718                 example:
3719                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3720                   resourceType: Bundle
3721                   type: collection
3722                   total: 0
3723                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CarePlan' }]
3724         '400':
3725           $ref: '#/components/responses/badrequest'
3726         '401':
3727           $ref: '#/components/responses/unauthorized'
3728       security:
3729         -
3730           openemr_auth: []
3731   '/fhir/CarePlan/{uuid}':
3732     get:
3733       tags:
3734         - fhir
3735       description: 'Returns a single CarePlan resource.'
3736       parameters:
3737         -
3738           name: uuid
3739           in: path
3740           description: 'The uuid for the CarePlan resource.'
3741           required: true
3742           schema:
3743             type: string
3744       responses:
3745         '200':
3746           description: 'Standard Response'
3747           content:
3748             application/json:
3749               schema:
3750                 properties:
3751                   'json object': { description: 'FHIR Json object.', type: object }
3752                 type: object
3753                 example:
3754                   id: 94682f08-8fbc-451e-b1ec-f922d765c38f_1
3755                   meta: { versionId: '1', lastUpdated: '2021-09-16T00:54:18+00:00' }
3756                   resourceType: CarePlan
3757                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"><p>Treat flu.</p></div>' }
3758                   status: active
3759                   intent: plan
3760                   category: [{ coding: [{ system: 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', code: assess-plan }] }]
3761                   description: 'Treat flu.'
3762                   subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
3763         '400':
3764           $ref: '#/components/responses/badrequest'
3765         '401':
3766           $ref: '#/components/responses/unauthorized'
3767         '404':
3768           $ref: '#/components/responses/uuidnotfound'
3769       security:
3770         -
3771           openemr_auth: []
3772   /fhir/CareTeam:
3773     get:
3774       tags:
3775         - fhir
3776       description: 'Returns a list of CareTeam resources.'
3777       parameters:
3778         -
3779           name: _id
3780           in: query
3781           description: 'The uuid for the CareTeam resource.'
3782           required: false
3783           schema:
3784             type: string
3785         -
3786           name: patient
3787           in: query
3788           description: 'The uuid for the patient.'
3789           required: false
3790           schema:
3791             type: string
3792         -
3793           name: status
3794           in: query
3795           description: 'The status of the CarePlan resource.'
3796           required: false
3797           schema:
3798             type: string
3799       responses:
3800         '200':
3801           description: 'Standard Response'
3802           content:
3803             application/json:
3804               schema:
3805                 properties:
3806                   'json object': { description: 'FHIR Json object.', type: object }
3807                 type: object
3808                 example:
3809                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3810                   resourceType: Bundle
3811                   type: collection
3812                   total: 0
3813                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CareTeam' }]
3814         '400':
3815           $ref: '#/components/responses/badrequest'
3816         '401':
3817           $ref: '#/components/responses/unauthorized'
3818       security:
3819         -
3820           openemr_auth: []
3821   '/fhir/CareTeam/{uuid}':
3822     get:
3823       tags:
3824         - fhir
3825       description: 'Returns a single CareTeam resource.'
3826       parameters:
3827         -
3828           name: uuid
3829           in: path
3830           description: 'The uuid for the CareTeam resource.'
3831           required: true
3832           schema:
3833             type: string
3834       responses:
3835         '200':
3836           description: 'Standard Response'
3837           content:
3838             application/json:
3839               schema:
3840                 properties:
3841                   'json object': { description: 'FHIR Json object.', type: object }
3842                 type: object
3843                 example:
3844                   id: 94682f09-69fe-4ada-8ea6-753a52bd1516
3845                   meta: { versionId: '1', lastUpdated: '2021-09-16T01:07:22+00:00' }
3846                   resourceType: CareTeam
3847                   status: active
3848                   subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
3849                   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 } }]
3850         '400':
3851           $ref: '#/components/responses/badrequest'
3852         '401':
3853           $ref: '#/components/responses/unauthorized'
3854         '404':
3855           $ref: '#/components/responses/uuidnotfound'
3856       security:
3857         -
3858           openemr_auth: []
3859   /fhir/Condition:
3860     get:
3861       tags:
3862         - fhir
3863       description: 'Returns a list of Condition resources.'
3864       parameters:
3865         -
3866           name: _id
3867           in: query
3868           description: 'The uuid for the Condition resource.'
3869           required: false
3870           schema:
3871             type: string
3872         -
3873           name: patient
3874           in: query
3875           description: 'The uuid for the patient.'
3876           required: false
3877           schema:
3878             type: string
3879       responses:
3880         '200':
3881           description: 'Standard Response'
3882           content:
3883             application/json:
3884               schema:
3885                 properties:
3886                   'json object': { description: 'FHIR Json object.', type: object }
3887                 type: object
3888                 example:
3889                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3890                   resourceType: Bundle
3891                   type: collection
3892                   total: 0
3893                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Condition' }]
3894         '400':
3895           $ref: '#/components/responses/badrequest'
3896         '401':
3897           $ref: '#/components/responses/unauthorized'
3898       security:
3899         -
3900           openemr_auth: []
3901   '/fhir/Condition/{uuid}':
3902     get:
3903       tags:
3904         - fhir
3905       description: 'Returns a single Condition resource.'
3906       parameters:
3907         -
3908           name: uuid
3909           in: path
3910           description: 'The uuid for the Condition resource.'
3911           required: true
3912           schema:
3913             type: string
3914       responses:
3915         '200':
3916           description: 'Standard Response'
3917           content:
3918             application/json:
3919               schema:
3920                 properties:
3921                   'json object': { description: 'FHIR Json object.', type: object }
3922                 type: object
3923                 example:
3924                   id: 94682c68-e5bb-4c5c-859a-cebaa5a1e582
3925                   meta: { versionId: '1', lastUpdated: '2021-09-16T02:41:53+00:00' }
3926                   resourceType: Condition
3927                   clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-clinical', code: inactive, display: Inactive }] }
3928                   verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-ver-status', code: unconfirmed, display: Unconfirmed }] }
3929                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-category', code: problem-list-item, display: 'Problem List Item' }] }]
3930                   code: { coding: [{ system: 'http://snomed.info/sct', code: '444814009', display: '' }] }
3931                   subject: { reference: Patient/94682c62-d37e-48b5-8018-c5f6f3566609 }
3932         '400':
3933           $ref: '#/components/responses/badrequest'
3934         '401':
3935           $ref: '#/components/responses/unauthorized'
3936         '404':
3937           $ref: '#/components/responses/uuidnotfound'
3938       security:
3939         -
3940           openemr_auth: []
3941   /fhir/Coverage:
3942     get:
3943       tags:
3944         - fhir
3945       description: 'Returns a list of Coverage resources.'
3946       parameters:
3947         -
3948           name: _id
3949           in: query
3950           description: 'The uuid for the Coverage resource.'
3951           required: false
3952           schema:
3953             type: string
3954         -
3955           name: patient
3956           in: query
3957           description: 'The uuid for the patient.'
3958           required: false
3959           schema:
3960             type: string
3961         -
3962           name: payor
3963           in: query
3964           description: 'The payor of the Coverage resource.'
3965           required: false
3966           schema:
3967             type: string
3968       responses:
3969         '200':
3970           description: 'Standard Response'
3971           content:
3972             application/json:
3973               schema:
3974                 properties:
3975                   'json object': { description: 'FHIR Json object.', type: object }
3976                 type: object
3977                 example:
3978                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3979                   resourceType: Bundle
3980                   type: collection
3981                   total: 0
3982                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Coverage' }]
3983         '400':
3984           $ref: '#/components/responses/badrequest'
3985         '401':
3986           $ref: '#/components/responses/unauthorized'
3987       security:
3988         -
3989           openemr_auth: []
3990   '/fhir/Coverage/{uuid}':
3991     get:
3992       tags:
3993         - fhir
3994       description: 'Returns a single Coverage resource.'
3995       parameters:
3996         -
3997           name: uuid
3998           in: path
3999           description: 'The uuid for the Coverage resource.'
4000           required: true
4001           schema:
4002             type: string
4003       responses:
4004         '200':
4005           description: 'Standard Response'
4006           content:
4007             application/json:
4008               schema:
4009                 properties:
4010                   'json object': { description: 'FHIR Json object.', type: object }
4011                 type: object
4012                 example:
4013                   id: 960d5f10-edc6-4c65-a6d4-39a1e1da87a8
4014                   meta: { versionId: '1', lastUpdated: '2022-04-14T07:58:45+00:00' }
4015                   resourceType: Coverage
4016                   status: active
4017                   beneficiary: { reference: Patient/960d5f08-9fdf-4bdc-9108-84a149e28bac }
4018                   relationship: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/subscriber-relationship', code: '' }] }
4019         '400':
4020           $ref: '#/components/responses/badrequest'
4021         '401':
4022           $ref: '#/components/responses/unauthorized'
4023         '404':
4024           $ref: '#/components/responses/uuidnotfound'
4025       security:
4026         -
4027           openemr_auth: []
4028   /fhir/Device:
4029     get:
4030       tags:
4031         - fhir
4032       description: 'Returns a list of Device resources.'
4033       parameters:
4034         -
4035           name: _id
4036           in: query
4037           description: 'The uuid for the Device resource.'
4038           required: false
4039           schema:
4040             type: string
4041         -
4042           name: patient
4043           in: query
4044           description: 'The uuid for the patient.'
4045           required: false
4046           schema:
4047             type: string
4048       responses:
4049         '200':
4050           description: 'Standard Response'
4051           content:
4052             application/json:
4053               schema:
4054                 properties:
4055                   'json object': { description: 'FHIR Json object.', type: object }
4056                 type: object
4057                 example:
4058                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4059                   resourceType: Bundle
4060                   type: collection
4061                   total: 0
4062                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Device' }]
4063         '400':
4064           $ref: '#/components/responses/badrequest'
4065         '401':
4066           $ref: '#/components/responses/unauthorized'
4067       security:
4068         -
4069           openemr_auth: []
4070   '/fhir/Device/{uuid}':
4071     get:
4072       tags:
4073         - fhir
4074       description: 'Returns a single Device resource.'
4075       parameters:
4076         -
4077           name: uuid
4078           in: path
4079           description: 'The uuid for the Device resource.'
4080           required: true
4081           schema:
4082             type: string
4083       responses:
4084         '200':
4085           description: 'Standard Response'
4086           content:
4087             application/json:
4088               schema:
4089                 properties:
4090                   'json object': { description: 'FHIR Json object.', type: object }
4091                 type: object
4092                 example:
4093                   id: 946dce19-c80a-402c-862a-eadf3f2377f0
4094                   meta: { versionId: '1', lastUpdated: '2021-09-18T19:28:59+00:00' }
4095                   resourceType: Device
4096                   udiCarrier: [{ deviceIdentifier: '08717648200274', carrierHRF: '=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123' }]
4097                   distinctIdentifier: A99971312345600
4098                   manufactureDate: '2013-02-01'
4099                   expirationDate: '2014-02-01'
4100                   lotNumber: 000000000000XYZ123
4101                   serialNumber: '000025'
4102                   type: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }
4103                   patient: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4104         '400':
4105           $ref: '#/components/responses/badrequest'
4106         '401':
4107           $ref: '#/components/responses/unauthorized'
4108         '404':
4109           $ref: '#/components/responses/uuidnotfound'
4110       security:
4111         -
4112           openemr_auth: []
4113   /fhir/DiagnosticReport:
4114     get:
4115       tags:
4116         - fhir
4117       description: 'Returns a list of DiagnosticReport resources.'
4118       parameters:
4119         -
4120           name: _id
4121           in: query
4122           description: 'The uuid for the DiagnosticReport resource.'
4123           required: false
4124           schema:
4125             type: string
4126         -
4127           name: patient
4128           in: query
4129           description: 'The uuid for the patient.'
4130           required: false
4131           schema:
4132             type: string
4133         -
4134           name: code
4135           in: query
4136           description: 'The code of the DiagnosticReport resource.'
4137           required: false
4138           schema:
4139             type: string
4140         -
4141           name: category
4142           in: query
4143           description: 'The category of the DiagnosticReport resource.'
4144           required: false
4145           schema:
4146             type: string
4147         -
4148           name: date
4149           in: query
4150           description: 'The datetime of the DiagnosticReport resource.'
4151           required: false
4152           schema:
4153             type: string
4154       responses:
4155         '200':
4156           description: 'Standard Response'
4157           content:
4158             application/json:
4159               schema:
4160                 properties:
4161                   'json object': { description: 'FHIR Json object.', type: object }
4162                 type: object
4163                 example:
4164                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4165                   resourceType: Bundle
4166                   type: collection
4167                   total: 0
4168                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DiagnosticReport' }]
4169         '400':
4170           $ref: '#/components/responses/badrequest'
4171         '401':
4172           $ref: '#/components/responses/unauthorized'
4173       security:
4174         -
4175           openemr_auth: []
4176   '/fhir/DiagnosticReport/{uuid}':
4177     get:
4178       tags:
4179         - fhir
4180       description: 'Returns a single DiagnosticReport resource.'
4181       parameters:
4182         -
4183           name: uuid
4184           in: path
4185           description: 'The uuid for the DiagnosticReport resource.'
4186           required: true
4187           schema:
4188             type: string
4189       responses:
4190         '200':
4191           description: 'Standard Response'
4192           content:
4193             application/json:
4194               schema:
4195                 properties:
4196                   'json object': { description: 'FHIR Json object.', type: object }
4197                 type: object
4198                 example:
4199                   id: 93fb2d6a-77ac-48ca-a12d-1a17e40007e3
4200                   meta: { versionId: '1', lastUpdated: '2021-09-18T20:52:34+00:00' }
4201                   resourceType: DiagnosticReport
4202                   status: final
4203                   category: [{ coding: [{ system: 'http://loinc.org', code: LP7839-6, display: Pathology }] }]
4204                   code: { coding: [{ system: 'http://loinc.org', code: 11502-2, display: 'Laboratory report' }] }
4205                   subject: { reference: Patient/9353b8f5-0a87-4e2a-afd4-25341fdb0fbc, type: Patient }
4206                   encounter: { reference: Encounter/93540818-cb5f-49df-b73b-83901bb793b6, type: Encounter }
4207                   effectiveDateTime: '2015-06-22T00:00:00+00:00'
4208                   issued: '2015-06-22T00:00:00+00:00'
4209                   performer: [{ reference: Organization/935249b5-0ba6-4b5b-8863-a7a27d4c6350, type: Organization }]
4210                   presentedForm: [{ contentType: text/plain, data: TXMgQWxpY2UgTmV3bWFuIHdhcyB0ZXN0ZWQgZm9yIHRoZSBVcmluYW5hbHlzaXMgbWFjcm8gcGFuZWwgYW5kIHRoZSByZXN1bHRzIGhhdmUgYmVlbiBmb3VuZCB0byBiZSANCm5vcm1hbC4= }]
4211         '400':
4212           $ref: '#/components/responses/badrequest'
4213         '401':
4214           $ref: '#/components/responses/unauthorized'
4215         '404':
4216           $ref: '#/components/responses/uuidnotfound'
4217       security:
4218         -
4219           openemr_auth: []
4220   /fhir/DocumentReference:
4221     get:
4222       tags:
4223         - fhir
4224       description: 'Returns a list of DocumentReference resources.'
4225       parameters:
4226         -
4227           name: _id
4228           in: query
4229           description: 'The uuid for the DocumentReference resource.'
4230           required: false
4231           schema:
4232             type: string
4233         -
4234           name: patient
4235           in: query
4236           description: 'The uuid for the patient.'
4237           required: false
4238           schema:
4239             type: string
4240         -
4241           name: type
4242           in: query
4243           description: 'The type of the DocumentReference resource.'
4244           required: false
4245           schema:
4246             type: string
4247         -
4248           name: category
4249           in: query
4250           description: 'The category of the DocumentReference resource.'
4251           required: false
4252           schema:
4253             type: string
4254         -
4255           name: date
4256           in: query
4257           description: 'The datetime of the DocumentReference resource.'
4258           required: false
4259           schema:
4260             type: string
4261       responses:
4262         '200':
4263           description: 'Standard Response'
4264           content:
4265             application/json:
4266               schema:
4267                 properties:
4268                   'json object': { description: 'FHIR Json object.', type: object }
4269                 type: object
4270                 example:
4271                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4272                   resourceType: Bundle
4273                   type: collection
4274                   total: 0
4275                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DocumentReference' }]
4276         '400':
4277           $ref: '#/components/responses/badrequest'
4278         '401':
4279           $ref: '#/components/responses/unauthorized'
4280       security:
4281         -
4282           openemr_auth: []
4283   /fhir/DocumentReference/$docref:
4284     post:
4285       tags:
4286         - fhir
4287       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.'
4288       externalDocs:
4289         description: 'Detailed documentation on this operation'
4290         url: 'https://www.open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#API'
4291       parameters:
4292         -
4293           name: patient
4294           in: query
4295           description: 'The uuid for the patient.'
4296           required: true
4297           schema:
4298             type: string
4299         -
4300           name: start
4301           in: query
4302           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.'
4303           required: false
4304           schema:
4305             type: string
4306         -
4307           name: end
4308           in: query
4309           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.'
4310           required: false
4311           schema:
4312             type: string
4313         -
4314           name: type
4315           in: query
4316           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).'
4317           required: false
4318           schema:
4319             type: string
4320       responses:
4321         '200':
4322           description: 'A search bundle of DocumentReferences is returned'
4323         '400':
4324           $ref: '#/components/responses/badrequest'
4325         '401':
4326           $ref: '#/components/responses/unauthorized'
4327       security:
4328         -
4329           openemr_auth: []
4330   '/fhir/DocumentReference/{uuid}':
4331     get:
4332       tags:
4333         - fhir
4334       description: 'Returns a single DocumentReference resource.'
4335       parameters:
4336         -
4337           name: uuid
4338           in: path
4339           description: 'The uuid for the DocumentReference resource.'
4340           required: true
4341           schema:
4342             type: string
4343       responses:
4344         '200':
4345           description: 'Standard Response'
4346           content:
4347             application/json:
4348               schema:
4349                 properties:
4350                   'json object': { description: 'FHIR Json object.', type: object }
4351                 type: object
4352                 example:
4353                   id: 946e7553-1aaa-49f8-8f81-ae15ccaa9165
4354                   meta: { versionId: '1', lastUpdated: '2021-09-19T03:17:51+00:00' }
4355                   resourceType: DocumentReference
4356                   identifier: [{ value: 946e7553-1aaa-49f8-8f81-ae15ccaa9165 }]
4357                   status: current
4358                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: unknown }] }
4359                   category: [{ coding: [{ system: 'https://localhost:9300/apis/default/fhir/ValueSet/openemr-document-types', code: openemr-document, display: 'OpenEMR Document' }] }]
4360                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4361                   date: '2021-09-19T03:15:56+00:00'
4362                   author: [null]
4363                   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' } }]
4364         '400':
4365           $ref: '#/components/responses/badrequest'
4366         '401':
4367           $ref: '#/components/responses/unauthorized'
4368         '404':
4369           $ref: '#/components/responses/uuidnotfound'
4370       security:
4371         -
4372           openemr_auth: []
4373   '/fhir/Binary/{id}':
4374     get:
4375       tags:
4376         - fhir
4377       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>'
4378       parameters:
4379         -
4380           name: id
4381           in: path
4382           description: 'The id for the Document.'
4383           required: true
4384           schema:
4385             type: string
4386       responses:
4387         '200':
4388           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>'
4389         '400':
4390           $ref: '#/components/responses/badrequest'
4391         '401':
4392           $ref: '#/components/responses/unauthorized'
4393       security:
4394         -
4395           openemr_auth: []
4396   /fhir/Encounter:
4397     get:
4398       tags:
4399         - fhir
4400       description: 'Returns a list of Encounter resources.'
4401       parameters:
4402         -
4403           name: _id
4404           in: query
4405           description: 'The uuid for the Encounter resource.'
4406           required: false
4407           schema:
4408             type: string
4409         -
4410           name: patient
4411           in: query
4412           description: 'The uuid for the patient.'
4413           required: false
4414           schema:
4415             type: string
4416         -
4417           name: date
4418           in: query
4419           description: 'The datetime of the Encounter resource.'
4420           required: false
4421           schema:
4422             type: string
4423       responses:
4424         '200':
4425           description: 'Standard Response'
4426           content:
4427             application/json:
4428               schema:
4429                 properties:
4430                   'json object': { description: 'FHIR Json object.', type: object }
4431                 type: object
4432                 example:
4433                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4434                   resourceType: Bundle
4435                   type: collection
4436                   total: 0
4437                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Encounter' }]
4438         '400':
4439           $ref: '#/components/responses/badrequest'
4440         '401':
4441           $ref: '#/components/responses/unauthorized'
4442       security:
4443         -
4444           openemr_auth: []
4445   '/fhir/Encounter/{uuid}':
4446     get:
4447       tags:
4448         - fhir
4449       description: 'Returns a single Encounter resource.'
4450       parameters:
4451         -
4452           name: uuid
4453           in: path
4454           description: 'The uuid for the Encounter resource.'
4455           required: true
4456           schema:
4457             type: string
4458       responses:
4459         '200':
4460           description: 'Standard Response'
4461           content:
4462             application/json:
4463               schema:
4464                 properties:
4465                   'json object': { description: 'FHIR Json object.', type: object }
4466                 type: object
4467                 example:
4468                   id: 946da61d-6b95-4f8e-abe5-534a25913b71
4469                   meta: { versionId: '1', lastUpdated: '2021-09-19T06:27:41+00:00' }
4470                   resourceType: Encounter
4471                   identifier: [{ system: 'urn:ietf:rfc:3986', value: 946da61d-6b95-4f8e-abe5-534a25913b71 }]
4472                   status: finished
4473                   class: { system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode', code: AMB, display: ambulatory }
4474                   type: [{ coding: [{ system: 'http://snomed.info/sct', code: '185349003', display: 'Encounter for check up (procedure)' }] }]
4475                   subject: { reference: Patient/946da61b-626b-4f88-81e2-adfb88f4f0fe, type: Patient }
4476                   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 } }]
4477                   period: { start: '2012-08-13T00:00:00+00:00' }
4478         '400':
4479           $ref: '#/components/responses/badrequest'
4480         '401':
4481           $ref: '#/components/responses/unauthorized'
4482         '404':
4483           $ref: '#/components/responses/uuidnotfound'
4484       security:
4485         -
4486           openemr_auth: []
4487   /fhir/Goal:
4488     get:
4489       tags:
4490         - fhir
4491       description: 'Returns a list of Condition resources.'
4492       parameters:
4493         -
4494           name: _id
4495           in: query
4496           description: 'The uuid for the Goal resource.'
4497           required: false
4498           schema:
4499             type: string
4500         -
4501           name: patient
4502           in: query
4503           description: 'The uuid for the patient.'
4504           required: false
4505           schema:
4506             type: string
4507       responses:
4508         '200':
4509           description: 'Standard Response'
4510           content:
4511             application/json:
4512               schema:
4513                 properties:
4514                   'json object': { description: 'FHIR Json object.', type: object }
4515                 type: object
4516                 example:
4517                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4518                   resourceType: Bundle
4519                   type: collection
4520                   total: 0
4521                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Goal' }]
4522         '400':
4523           $ref: '#/components/responses/badrequest'
4524         '401':
4525           $ref: '#/components/responses/unauthorized'
4526       security:
4527         -
4528           openemr_auth: []
4529   '/fhir/Goal/{uuid}':
4530     get:
4531       tags:
4532         - fhir
4533       description: 'Returns a single Goal resource.'
4534       parameters:
4535         -
4536           name: uuid
4537           in: path
4538           description: 'The uuid for the Goal resource.'
4539           required: true
4540           schema:
4541             type: string
4542       responses:
4543         '200':
4544           description: 'Standard Response'
4545           content:
4546             application/json:
4547               schema:
4548                 properties:
4549                   'json object': { description: 'FHIR Json object.', type: object }
4550                 type: object
4551                 example:
4552                   id: 946da61d-6b88-4d54-bdd6-4029e2ad9e3f_1
4553                   meta: { versionId: '1', lastUpdated: '2021-09-19T06:45:58+00:00' }
4554                   resourceType: Goal
4555                   lifecycleStatus: active
4556                   description: { text: 'Eating more vegetables.' }
4557                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4558                   target: [{ measure: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }, detailString: 'Eating more vegetables.', dueDate: '2021-09-09' }]
4559         '400':
4560           $ref: '#/components/responses/badrequest'
4561         '401':
4562           $ref: '#/components/responses/unauthorized'
4563         '404':
4564           $ref: '#/components/responses/uuidnotfound'
4565       security:
4566         -
4567           openemr_auth: []
4568   /fhir/Group:
4569     get:
4570       tags:
4571         - fhir
4572       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>'
4573       parameters:
4574         -
4575           name: _id
4576           in: query
4577           description: 'The uuid for the Group resource.'
4578           required: false
4579           schema:
4580             type: string
4581         -
4582           name: patient
4583           in: query
4584           description: 'The uuid for the patient.'
4585           required: false
4586           schema:
4587             type: string
4588       responses:
4589         '200':
4590           description: 'Standard Response'
4591           content:
4592             application/json:
4593               schema:
4594                 properties:
4595                   'json object': { description: 'FHIR Json object.', type: object }
4596                 type: object
4597                 example:
4598                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4599                   resourceType: Bundle
4600                   type: collection
4601                   total: 0
4602                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Group' }]
4603         '400':
4604           $ref: '#/components/responses/badrequest'
4605         '401':
4606           $ref: '#/components/responses/unauthorized'
4607       security:
4608         -
4609           openemr_auth: []
4610   '/fhir/Group/{uuid}':
4611     get:
4612       tags:
4613         - fhir
4614       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>'
4615       parameters:
4616         -
4617           name: uuid
4618           in: path
4619           description: 'The uuid for the Group resource.'
4620           required: true
4621           schema:
4622             type: string
4623       responses:
4624         '200':
4625           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>'
4626         '400':
4627           $ref: '#/components/responses/badrequest'
4628         '401':
4629           $ref: '#/components/responses/unauthorized'
4630         '404':
4631           $ref: '#/components/responses/uuidnotfound'
4632       security:
4633         -
4634           openemr_auth: []
4635   '/fhir/Group/{id}/$export':
4636     get:
4637       tags:
4638         - fhir
4639       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>'
4640       responses:
4641         '200':
4642           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>'
4643         '400':
4644           $ref: '#/components/responses/badrequest'
4645         '401':
4646           $ref: '#/components/responses/unauthorized'
4647       security:
4648         -
4649           openemr_auth: []
4650   /fhir/Immunization:
4651     get:
4652       tags:
4653         - fhir
4654       description: 'Returns a list of Immunization resources.'
4655       parameters:
4656         -
4657           name: _id
4658           in: query
4659           description: 'The uuid for the Immunization resource.'
4660           required: false
4661           schema:
4662             type: string
4663         -
4664           name: patient
4665           in: query
4666           description: 'The uuid for the patient.'
4667           required: false
4668           schema:
4669             type: string
4670       responses:
4671         '200':
4672           description: 'Standard Response'
4673           content:
4674             application/json:
4675               schema:
4676                 properties:
4677                   'json object': { description: 'FHIR Json object.', type: object }
4678                 type: object
4679                 example:
4680                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4681                   resourceType: Bundle
4682                   type: collection
4683                   total: 0
4684                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Immunization' }]
4685         '400':
4686           $ref: '#/components/responses/badrequest'
4687         '401':
4688           $ref: '#/components/responses/unauthorized'
4689       security:
4690         -
4691           openemr_auth: []
4692   '/fhir/Immunization/{uuid}':
4693     get:
4694       tags:
4695         - fhir
4696       description: 'Returns a single Immunization resource.'
4697       parameters:
4698         -
4699           name: uuid
4700           in: path
4701           description: 'The uuid for the Immunization resource.'
4702           required: true
4703           schema:
4704             type: string
4705       responses:
4706         '200':
4707           description: 'Standard Response'
4708           content:
4709             application/json:
4710               schema:
4711                 properties:
4712                   'json object': { description: 'FHIR Json object.', type: object }
4713                 type: object
4714                 example:
4715                   id: 95e8d8b7-e3e2-4e03-8eb1-31e1d9097d8f
4716                   meta: { versionId: '1', lastUpdated: '2022-03-26T05:42:59+00:00' }
4717                   resourceType: Immunization
4718                   status: completed
4719                   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' }] }
4720                   patient: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf }
4721                   occurrenceDateTime: '2022-03-26T05:35:00+00:00'
4722                   recorded: '2022-03-26T05:42:26+00:00'
4723                   primarySource: false
4724         '400':
4725           $ref: '#/components/responses/badrequest'
4726         '401':
4727           $ref: '#/components/responses/unauthorized'
4728         '404':
4729           $ref: '#/components/responses/uuidnotfound'
4730       security:
4731         -
4732           openemr_auth: []
4733   /fhir/Location:
4734     get:
4735       tags:
4736         - fhir
4737       description: 'Returns a list of Location resources.'
4738       parameters:
4739         -
4740           name: _id
4741           in: query
4742           description: 'The uuid for the Location resource.'
4743           required: false
4744           schema:
4745             type: string
4746       responses:
4747         '200':
4748           description: 'Standard Response'
4749           content:
4750             application/json:
4751               schema:
4752                 properties:
4753                   'json object': { description: 'FHIR Json object.', type: object }
4754                 type: object
4755                 example:
4756                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4757                   resourceType: Bundle
4758                   type: collection
4759                   total: 0
4760                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Location' }]
4761         '400':
4762           $ref: '#/components/responses/badrequest'
4763         '401':
4764           $ref: '#/components/responses/unauthorized'
4765       security:
4766         -
4767           openemr_auth: []
4768   '/fhir/Location/{uuid}':
4769     get:
4770       tags:
4771         - fhir
4772       description: 'Returns a single Location resource.'
4773       parameters:
4774         -
4775           name: uuid
4776           in: path
4777           description: 'The uuid for the Location resource.'
4778           required: true
4779           schema:
4780             type: string
4781       responses:
4782         '200':
4783           description: 'Standard Response'
4784           content:
4785             application/json:
4786               schema:
4787                 properties:
4788                   'json object': { description: 'FHIR Json object.', type: object }
4789                 type: object
4790                 example:
4791                   id: 946da61d-c4f2-4f03-a2a7-b571f6a24b65
4792                   meta: { versionId: '1', lastUpdated: '2021-09-19T08:14:58+00:00' }
4793                   resourceType: Location
4794                   status: active
4795                   name: 'Your Clinic Name Here'
4796                   telecom: [{ system: phone, value: 000-000-0000 }, { system: fax, value: 000-000-0000 }]
4797         '400':
4798           $ref: '#/components/responses/badrequest'
4799         '401':
4800           $ref: '#/components/responses/unauthorized'
4801         '404':
4802           $ref: '#/components/responses/uuidnotfound'
4803       security:
4804         -
4805           openemr_auth: []
4806   /fhir/Medication:
4807     get:
4808       tags:
4809         - fhir
4810       description: 'Returns a list of Medication resources.'
4811       responses:
4812         '200':
4813           description: 'Standard Response'
4814           content:
4815             application/json:
4816               schema:
4817                 properties:
4818                   'json object': { description: 'FHIR Json object.', type: object }
4819                 type: object
4820                 example:
4821                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4822                   resourceType: Bundle
4823                   type: collection
4824                   total: 0
4825                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Medication' }]
4826         '400':
4827           $ref: '#/components/responses/badrequest'
4828         '401':
4829           $ref: '#/components/responses/unauthorized'
4830       security:
4831         -
4832           openemr_auth: []
4833   '/fhir/Medication/{uuid}':
4834     get:
4835       tags:
4836         - fhir
4837       description: 'Returns a single Medication resource.'
4838       parameters:
4839         -
4840           name: uuid
4841           in: path
4842           description: 'The uuid for the Medication resource.'
4843           required: true
4844           schema:
4845             type: string
4846       responses:
4847         '200':
4848           description: 'Standard Response'
4849           content:
4850             application/json:
4851               schema:
4852                 properties:
4853                   'json object': { description: 'FHIR Json object.', type: object }
4854                 type: object
4855                 example:
4856                   id: 961aa334-9348-4145-8252-de665e3c4afa
4857                   meta: { versionId: '1', lastUpdated: '2022-04-19T23:42:14+00:00' }
4858                   resourceType: Medication
4859                   code: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: 153165 }] }
4860                   status: active
4861                   batch: { lotNumber: '132', expirationDate: '0000-00-00' }
4862         '400':
4863           $ref: '#/components/responses/badrequest'
4864         '401':
4865           $ref: '#/components/responses/unauthorized'
4866         '404':
4867           $ref: '#/components/responses/uuidnotfound'
4868       security:
4869         -
4870           openemr_auth: []
4871   /fhir/MedicationRequest:
4872     get:
4873       tags:
4874         - fhir
4875       description: 'Returns a list of MedicationRequest resources.'
4876       parameters:
4877         -
4878           name: _id
4879           in: query
4880           description: 'The uuid for the MedicationRequest resource.'
4881           required: false
4882           schema:
4883             type: string
4884         -
4885           name: patient
4886           in: query
4887           description: 'The uuid for the patient.'
4888           required: false
4889           schema:
4890             type: string
4891         -
4892           name: intent
4893           in: query
4894           description: 'The intent of the MedicationRequest resource.'
4895           required: false
4896           schema:
4897             type: string
4898         -
4899           name: status
4900           in: query
4901           description: 'The status of the MedicationRequest resource.'
4902           required: false
4903           schema:
4904             type: string
4905       responses:
4906         '200':
4907           description: 'Standard Response'
4908           content:
4909             application/json:
4910               schema:
4911                 properties:
4912                   'json object': { description: 'FHIR Json object.', type: object }
4913                 type: object
4914                 example:
4915                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4916                   resourceType: Bundle
4917                   type: collection
4918                   total: 0
4919                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/MedicationRequest' }]
4920         '400':
4921           $ref: '#/components/responses/badrequest'
4922         '401':
4923           $ref: '#/components/responses/unauthorized'
4924       security:
4925         -
4926           openemr_auth: []
4927   '/fhir/MedicationRequest/{uuid}':
4928     get:
4929       tags:
4930         - fhir
4931       description: 'Returns a single MedicationRequest resource.'
4932       parameters:
4933         -
4934           name: uuid
4935           in: path
4936           description: 'The uuid for the MedicationRequest resource.'
4937           required: true
4938           schema:
4939             type: string
4940       responses:
4941         '200':
4942           description: 'Standard Response'
4943           content:
4944             application/json:
4945               schema:
4946                 properties:
4947                   'json object': { description: 'FHIR Json object.', type: object }
4948                 type: object
4949                 example:
4950                   id: 946da61d-9cff-4416-8d27-805f19f9d7d8
4951                   meta: { versionId: '1', lastUpdated: '2021-09-20T04:03:14+00:00' }
4952                   resourceType: MedicationRequest
4953                   status: active
4954                   intent: order
4955                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/medicationrequest-category', code: community, display: Home/Community }] }]
4956                   reportedBoolean: false
4957                   medicationCodeableConcept: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: '1738139', display: 'Acetaminophen 325 MG Oral Tablet' }] }
4958                   subject: { reference: Patient/946da617-1a4a-4b2c-ae66-93b84377cb1e, type: Patient }
4959                   authoredOn: '2021-09-18T00:00:00+00:00'
4960                   requester: { reference: Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b, type: Practitioner }
4961         '400':
4962           $ref: '#/components/responses/badrequest'
4963         '401':
4964           $ref: '#/components/responses/unauthorized'
4965         '404':
4966           $ref: '#/components/responses/uuidnotfound'
4967       security:
4968         -
4969           openemr_auth: []
4970   /fhir/Observation:
4971     get:
4972       tags:
4973         - fhir
4974       description: 'Returns a list of Observation resources.'
4975       parameters:
4976         -
4977           name: _id
4978           in: query
4979           description: 'The uuid for the Observation resource.'
4980           required: false
4981           schema:
4982             type: string
4983         -
4984           name: patient
4985           in: query
4986           description: 'The uuid for the patient.'
4987           required: false
4988           schema:
4989             type: string
4990         -
4991           name: code
4992           in: query
4993           description: 'The code of the Observation resource.'
4994           required: false
4995           schema:
4996             type: string
4997         -
4998           name: category
4999           in: query
5000           description: 'The category of the Observation resource.'
5001           required: false
5002           schema:
5003             type: string
5004         -
5005           name: date
5006           in: query
5007           description: 'The datetime of the Observation resource.'
5008           required: false
5009           schema:
5010             type: string
5011       responses:
5012         '200':
5013           description: 'Standard Response'
5014           content:
5015             application/json:
5016               schema:
5017                 properties:
5018                   'json object': { description: 'FHIR Json object.', type: object }
5019                 type: object
5020                 example:
5021                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5022                   resourceType: Bundle
5023                   type: collection
5024                   total: 0
5025                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Observation' }]
5026         '400':
5027           $ref: '#/components/responses/badrequest'
5028         '401':
5029           $ref: '#/components/responses/unauthorized'
5030       security:
5031         -
5032           openemr_auth: []
5033   '/fhir/Observation/{uuid}':
5034     get:
5035       tags:
5036         - fhir
5037       description: 'Returns a single Observation resource.'
5038       parameters:
5039         -
5040           name: uuid
5041           in: path
5042           description: 'The uuid for the Observation resource.'
5043           required: true
5044           schema:
5045             type: string
5046       responses:
5047         '200':
5048           description: 'Standard Response'
5049           content:
5050             application/json:
5051               schema:
5052                 properties:
5053                   'json object': { description: 'FHIR Json object.', type: object }
5054                 type: object
5055                 example:
5056                   id: 946da61e-0597-485e-9dfd-a87205ea56b3
5057                   meta: { versionId: '1', lastUpdated: '2021-09-20T04:12:16+00:00' }
5058                   resourceType: Observation
5059                   status: final
5060                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/observation-category', code: vital-signs }] }]
5061                   code: { coding: [{ system: 'http://loinc.org', code: 85354-9, display: 'Blood pressure systolic and diastolic' }] }
5062                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
5063                   effectiveDateTime: '2015-08-31T00:00:00+00:00'
5064                   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]' } }]
5065         '400':
5066           $ref: '#/components/responses/badrequest'
5067         '401':
5068           $ref: '#/components/responses/unauthorized'
5069         '404':
5070           $ref: '#/components/responses/uuidnotfound'
5071       security:
5072         -
5073           openemr_auth: []
5074   /fhir/Organization:
5075     get:
5076       tags:
5077         - fhir
5078       description: 'Returns a list of Organization resources.'
5079       parameters:
5080         -
5081           name: _id
5082           in: query
5083           description: 'The uuid for the Organization resource.'
5084           required: false
5085           schema:
5086             type: string
5087         -
5088           name: name
5089           in: query
5090           description: 'The name of the Organization resource.'
5091           required: false
5092           schema:
5093             type: string
5094         -
5095           name: email
5096           in: query
5097           description: 'The email of the Organization resource.'
5098           required: false
5099           schema:
5100             type: string
5101         -
5102           name: phone
5103           in: query
5104           description: 'The phone of the Organization resource.'
5105           required: false
5106           schema:
5107             type: string
5108         -
5109           name: telecom
5110           in: query
5111           description: 'The telecom of the Organization resource.'
5112           required: false
5113           schema:
5114             type: string
5115         -
5116           name: address
5117           in: query
5118           description: 'The address of the Organization resource.'
5119           required: false
5120           schema:
5121             type: string
5122         -
5123           name: address-city
5124           in: query
5125           description: 'The address-city of the Organization resource.'
5126           required: false
5127           schema:
5128             type: string
5129         -
5130           name: address-postalcode
5131           in: query
5132           description: 'The address-postalcode of the Organization resource.'
5133           required: false
5134           schema:
5135             type: string
5136         -
5137           name: address-state
5138           in: query
5139           description: 'The address-state of the Organization resource.'
5140           required: false
5141           schema:
5142             type: string
5143       responses:
5144         '200':
5145           description: 'Standard Response'
5146           content:
5147             application/json:
5148               schema:
5149                 properties:
5150                   'json object': { description: 'FHIR Json object.', type: object }
5151                 type: object
5152                 example:
5153                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5154                   resourceType: Bundle
5155                   type: collection
5156                   total: 0
5157                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Organization' }]
5158         '400':
5159           $ref: '#/components/responses/badrequest'
5160         '401':
5161           $ref: '#/components/responses/unauthorized'
5162       security:
5163         -
5164           openemr_auth: []
5165     post:
5166       tags:
5167         - fhir
5168       description: 'Adds a Organization resource.'
5169       requestBody:
5170         required: true
5171         content:
5172           application/json:
5173             schema:
5174               description: 'The json object for the Organization resource.'
5175               type: object
5176             example:
5177               id: 95f0e672-be37-4c73-95c9-649c2d200018
5178               meta:
5179                 versionId: '1'
5180                 lastUpdated: '2022-03-30T07:43:23+00:00'
5181               resourceType: Organization
5182               text:
5183                 status: generated
5184                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5185               identifier:
5186                 -
5187                   system: 'http://hl7.org/fhir/sid/us-npi'
5188                   value: '1234567890'
5189               active: true
5190               type:
5191                 -
5192                   coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5193               name: 'Your Clinic Name Here Hey'
5194               telecom:
5195                 -
5196                   system: phone
5197                   value: 000-000-0000
5198                   use: work
5199                 -
5200                   system: fax
5201                   value: 000-000-0000
5202                   use: work
5203               address:
5204                 - null
5205       responses:
5206         '200':
5207           description: 'Standard Response'
5208           content:
5209             application/json:
5210               schema:
5211                 properties:
5212                   'json object': { description: 'FHIR Json object.', type: object }
5213                 type: object
5214                 example:
5215                   id: 95f0e672-be37-4c73-95c9-649c2d200018
5216                   meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5217                   resourceType: Organization
5218                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5219                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5220                   active: true
5221                   type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5222                   name: 'Your Clinic Name Here Now'
5223                   telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5224                   address: [null]
5225         '400':
5226           $ref: '#/components/responses/badrequest'
5227         '401':
5228           $ref: '#/components/responses/unauthorized'
5229       security:
5230         -
5231           openemr_auth: []
5232   '/fhir/Organization/{uuid}':
5233     get:
5234       tags:
5235         - fhir
5236       description: 'Returns a single Organization resource.'
5237       parameters:
5238         -
5239           name: uuid
5240           in: path
5241           description: 'The uuid for the Organization resource.'
5242           required: true
5243           schema:
5244             type: string
5245       responses:
5246         '200':
5247           description: 'Standard Response'
5248           content:
5249             application/json:
5250               schema:
5251                 properties:
5252                   'json object': { description: 'FHIR Json object.', type: object }
5253                 type: object
5254                 example:
5255                   id: 95f0e672-be37-4c73-95c9-649c2d200018
5256                   meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5257                   resourceType: Organization
5258                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5259                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5260                   active: true
5261                   type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5262                   name: 'Your Clinic Name Here'
5263                   telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5264                   address: [null]
5265         '400':
5266           $ref: '#/components/responses/badrequest'
5267         '401':
5268           $ref: '#/components/responses/unauthorized'
5269         '404':
5270           $ref: '#/components/responses/uuidnotfound'
5271       security:
5272         -
5273           openemr_auth: []
5274     put:
5275       tags:
5276         - fhir
5277       description: 'Modifies a Organization resource.'
5278       parameters:
5279         -
5280           name: uuid
5281           in: path
5282           description: 'The uuid for the organization.'
5283           required: true
5284           schema:
5285             type: string
5286       requestBody:
5287         required: true
5288         content:
5289           application/json:
5290             schema:
5291               description: 'The json object for the Organization resource.'
5292               type: object
5293             example:
5294               id: 95f0e672-be37-4c73-95c9-649c2d200018
5295               meta:
5296                 versionId: '1'
5297                 lastUpdated: '2022-03-30T07:43:23+00:00'
5298               resourceType: Organization
5299               text:
5300                 status: generated
5301                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5302               identifier:
5303                 -
5304                   system: 'http://hl7.org/fhir/sid/us-npi'
5305                   value: '1234567890'
5306               active: true
5307               type:
5308                 -
5309                   coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5310               name: 'Your Clinic Name Here'
5311               telecom:
5312                 -
5313                   system: phone
5314                   value: 000-000-0000
5315                   use: work
5316                 -
5317                   system: fax
5318                   value: 000-000-0000
5319                   use: work
5320               address:
5321                 - null
5322       responses:
5323         '201':
5324           description: 'Standard Response'
5325           content:
5326             application/json:
5327               schema:
5328                 example:
5329                   id: 14
5330                   uuid: 95f217c1-258c-44ca-bf11-909dce369574
5331         '400':
5332           $ref: '#/components/responses/badrequest'
5333         '401':
5334           $ref: '#/components/responses/unauthorized'
5335       security:
5336         -
5337           openemr_auth: []
5338   /fhir/Patient:
5339     get:
5340       tags:
5341         - fhir
5342       description: 'Returns a list of Patient resources.'
5343       parameters:
5344         -
5345           name: _id
5346           in: query
5347           description: 'The uuid for the Patient resource.'
5348           required: false
5349           schema:
5350             type: string
5351         -
5352           name: identifier
5353           in: query
5354           description: 'The identifier of the Patient resource.'
5355           required: false
5356           schema:
5357             type: string
5358         -
5359           name: name
5360           in: query
5361           description: 'The name of the Patient resource.'
5362           required: false
5363           schema:
5364             type: string
5365         -
5366           name: birthdate
5367           in: query
5368           description: 'The birthdate of the Patient resource.'
5369           required: false
5370           schema:
5371             type: string
5372         -
5373           name: gender
5374           in: query
5375           description: 'The gender of the Patient resource.'
5376           required: false
5377           schema:
5378             type: string
5379         -
5380           name: address
5381           in: query
5382           description: 'The address of the Patient resource.'
5383           required: false
5384           schema:
5385             type: string
5386         -
5387           name: address-city
5388           in: query
5389           description: 'The address-city of the Patient resource.'
5390           required: false
5391           schema:
5392             type: string
5393         -
5394           name: address-postalcode
5395           in: query
5396           description: 'The address-postalcode of the Patient resource.'
5397           required: false
5398           schema:
5399             type: string
5400         -
5401           name: address-state
5402           in: query
5403           description: 'The address-state of the Patient resource.'
5404           required: false
5405           schema:
5406             type: string
5407         -
5408           name: email
5409           in: query
5410           description: 'The email of the Patient resource.'
5411           required: false
5412           schema:
5413             type: string
5414         -
5415           name: family
5416           in: query
5417           description: 'The family name of the Patient resource.'
5418           required: false
5419           schema:
5420             type: string
5421         -
5422           name: given
5423           in: query
5424           description: 'The given name of the Patient resource.'
5425           required: false
5426           schema:
5427             type: string
5428         -
5429           name: phone
5430           in: query
5431           description: 'The phone number of the Patient resource.'
5432           required: false
5433           schema:
5434             type: string
5435         -
5436           name: telecom
5437           in: query
5438           description: 'The fax number of the Patient resource.'
5439           required: false
5440           schema:
5441             type: string
5442       responses:
5443         '200':
5444           description: 'Standard Response'
5445           content:
5446             application/json:
5447               schema:
5448                 properties:
5449                   'json object': { description: 'FHIR Json object.', type: object }
5450                 type: object
5451                 example:
5452                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5453                   resourceType: Bundle
5454                   type: collection
5455                   total: 0
5456                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Patient' }]
5457         '400':
5458           $ref: '#/components/responses/badrequest'
5459         '401':
5460           $ref: '#/components/responses/unauthorized'
5461       security:
5462         -
5463           openemr_auth: []
5464     post:
5465       tags:
5466         - fhir
5467       description: 'Adds a Patient resource.'
5468       requestBody:
5469         required: true
5470         content:
5471           application/json:
5472             schema:
5473               description: 'The json object for the Patient resource.'
5474               type: object
5475             example:
5476               id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5477               meta:
5478                 versionId: '1'
5479                 lastUpdated: '2022-03-31T02:48:28+00:00'
5480               resourceType: Patient
5481               text:
5482                 status: generated
5483                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5484               extension:
5485                 -
5486                   valueCode: F
5487                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5488                 -
5489                   extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5490                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5491               identifier:
5492                 -
5493                   use: official
5494                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5495                   system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5496                   value: '1'
5497               active: true
5498               name:
5499                 -
5500                   use: official
5501                   family: Smith
5502                   given: [Brenda]
5503               gender: female
5504               birthDate: '2017-03-10'
5505               communication:
5506                 -
5507                   language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5508       responses:
5509         '200':
5510           description: 'Standard Response'
5511           content:
5512             application/json:
5513               schema:
5514                 properties:
5515                   'json object': { description: 'FHIR Json object.', type: object }
5516                 type: object
5517                 example:
5518                   id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5519                   meta: { versionId: '1', lastUpdated: '2022-03-31T02:48:28+00:00' }
5520                   resourceType: Patient
5521                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>' }
5522                   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' }]
5523                   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' }]
5524                   active: true
5525                   name: [{ use: official, family: Smith, given: [Brenda] }]
5526                   gender: female
5527                   birthDate: '2017-03-10'
5528                   communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5529         '400':
5530           $ref: '#/components/responses/badrequest'
5531         '401':
5532           $ref: '#/components/responses/unauthorized'
5533       security:
5534         -
5535           openemr_auth: []
5536   '/fhir/Patient/{uuid}':
5537     get:
5538       tags:
5539         - fhir
5540       description: 'Returns a single Patient resource.'
5541       parameters:
5542         -
5543           name: uuid
5544           in: path
5545           description: 'The uuid for the Patient resource.'
5546           required: true
5547           schema:
5548             type: string
5549       responses:
5550         '200':
5551           description: 'Standard Response'
5552           content:
5553             application/json:
5554               schema:
5555                 properties:
5556                   'json object': { description: 'FHIR Json object.', type: object }
5557                 type: object
5558                 example:
5559                   id: 946da617-1a4a-4b2c-ae66-93b84377cb1e
5560                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:08:03+00:00' }
5561                   resourceType: Patient
5562                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Aurore252 Von197</p></div>' }
5563                   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' }]
5564                   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' }]
5565                   active: true
5566                   name: [{ use: official, family: Von197, given: [Aurore252] }]
5567                   gender: female
5568                   birthDate: '1970-07-03'
5569                   address: [{ line: ['245 Crona Wall'], city: Boston, state: Massachusetts, postalCode: '02215', period: { start: '2020-09-21T17:08:03.532+00:00' } }]
5570                   communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5571         '400':
5572           $ref: '#/components/responses/badrequest'
5573         '401':
5574           $ref: '#/components/responses/unauthorized'
5575         '404':
5576           $ref: '#/components/responses/uuidnotfound'
5577       security:
5578         -
5579           openemr_auth: []
5580     put:
5581       tags:
5582         - fhir
5583       description: 'Modifies a Patient resource.'
5584       parameters:
5585         -
5586           name: uuid
5587           in: path
5588           description: 'The uuid for the Patient resource.'
5589           required: true
5590           schema:
5591             type: string
5592       requestBody:
5593         required: true
5594         content:
5595           application/json:
5596             schema:
5597               description: 'The json object for the Patient resource.'
5598               type: object
5599             example:
5600               id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5601               meta:
5602                 versionId: '1'
5603                 lastUpdated: '2022-03-31T02:48:28+00:00'
5604               resourceType: Patient
5605               text:
5606                 status: generated
5607                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5608               extension:
5609                 -
5610                   valueCode: F
5611                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5612                 -
5613                   extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5614                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5615               identifier:
5616                 -
5617                   use: official
5618                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5619                   system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5620                   value: '1'
5621               active: true
5622               name:
5623                 -
5624                   use: official
5625                   family: Smith
5626                   given: [Brenda]
5627               gender: female
5628               birthDate: '2017-03-10'
5629               communication:
5630                 -
5631                   language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5632       responses:
5633         '201':
5634           description: 'Standard Response'
5635           content:
5636             application/json:
5637               schema:
5638                 example:
5639                   id: 2
5640                   uuid: 95f2ad04-5834-4243-8838-e396a7faadbf
5641         '400':
5642           $ref: '#/components/responses/badrequest'
5643         '401':
5644           $ref: '#/components/responses/unauthorized'
5645       security:
5646         -
5647           openemr_auth: []
5648   /fhir/Patient/$export:
5649     get:
5650       tags:
5651         - fhir
5652       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>'
5653       responses:
5654         '200':
5655           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>'
5656         '400':
5657           $ref: '#/components/responses/badrequest'
5658         '401':
5659           $ref: '#/components/responses/unauthorized'
5660       security:
5661         -
5662           openemr_auth: []
5663   /fhir/Person:
5664     get:
5665       tags:
5666         - fhir
5667       description: 'Returns a list of Person resources.'
5668       parameters:
5669         -
5670           name: name
5671           in: query
5672           description: 'The name of the Person resource.'
5673           required: false
5674           schema:
5675             type: string
5676         -
5677           name: active
5678           in: query
5679           description: 'The active status of the Person resource.'
5680           required: false
5681           schema:
5682             type: string
5683         -
5684           name: address
5685           in: query
5686           description: 'The address of the Person resource.'
5687           required: false
5688           schema:
5689             type: string
5690         -
5691           name: address-city
5692           in: query
5693           description: 'The address-city of the Person resource.'
5694           required: false
5695           schema:
5696             type: string
5697         -
5698           name: address-postalcode
5699           in: query
5700           description: 'The address-postalcode of the Person resource.'
5701           required: false
5702           schema:
5703             type: string
5704         -
5705           name: address-state
5706           in: query
5707           description: 'The address-state of the Person resource.'
5708           required: false
5709           schema:
5710             type: string
5711         -
5712           name: email
5713           in: query
5714           description: 'The email of the Person resource.'
5715           required: false
5716           schema:
5717             type: string
5718         -
5719           name: family
5720           in: query
5721           description: 'The family name of the Person resource.'
5722           required: false
5723           schema:
5724             type: string
5725         -
5726           name: given
5727           in: query
5728           description: 'The given name of the Person resource.'
5729           required: false
5730           schema:
5731             type: string
5732         -
5733           name: phone
5734           in: query
5735           description: 'The phone number of the Person resource.'
5736           required: false
5737           schema:
5738             type: string
5739         -
5740           name: telecom
5741           in: query
5742           description: 'The fax number of the Person resource.'
5743           required: false
5744           schema:
5745             type: string
5746       responses:
5747         '200':
5748           description: 'Standard Response'
5749           content:
5750             application/json:
5751               schema:
5752                 properties:
5753                   'json object': { description: 'FHIR Json object.', type: object }
5754                 type: object
5755                 example:
5756                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5757                   resourceType: Bundle
5758                   type: collection
5759                   total: 0
5760                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Person' }]
5761         '400':
5762           $ref: '#/components/responses/badrequest'
5763         '401':
5764           $ref: '#/components/responses/unauthorized'
5765       security:
5766         -
5767           openemr_auth: []
5768   '/fhir/Person/{uuid}':
5769     get:
5770       tags:
5771         - fhir
5772       description: 'Returns a single Person resource.'
5773       parameters:
5774         -
5775           name: uuid
5776           in: path
5777           description: 'The uuid for the Person resource.'
5778           required: true
5779           schema:
5780             type: string
5781       responses:
5782         '200':
5783           description: 'Standard Response'
5784           content:
5785             application/json:
5786               schema:
5787                 properties:
5788                   'json object': { description: 'FHIR Json object.', type: object }
5789                 type: object
5790                 example:
5791                   id: 960c7cd6-187a-4119-8cd4-85389d80efb9
5792                   meta: { versionId: '1', lastUpdated: '2022-04-13T08:57:32+00:00' }
5793                   resourceType: Person
5794                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Administrator Administrator</p></div>' }
5795                   name: [{ use: official, family: Administrator, given: [Administrator, Larry] }]
5796                   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 }]
5797                   address: [{ line: ['123 Lane Street'], city: Bellevue, state: WA, period: { start: '2021-04-13T08:57:32.146+00:00' } }]
5798                   active: true
5799         '400':
5800           $ref: '#/components/responses/badrequest'
5801         '401':
5802           $ref: '#/components/responses/unauthorized'
5803         '404':
5804           $ref: '#/components/responses/uuidnotfound'
5805       security:
5806         -
5807           openemr_auth: []
5808   /fhir/Practitioner:
5809     get:
5810       tags:
5811         - fhir
5812       description: 'Returns a list of Practitioner resources.'
5813       parameters:
5814         -
5815           name: _id
5816           in: query
5817           description: 'The uuid for the Practitioner resource.'
5818           required: false
5819           schema:
5820             type: string
5821         -
5822           name: name
5823           in: query
5824           description: 'The name of the Practitioner resource.'
5825           required: false
5826           schema:
5827             type: string
5828         -
5829           name: active
5830           in: query
5831           description: 'The active status of the Practitioner resource.'
5832           required: false
5833           schema:
5834             type: string
5835         -
5836           name: address
5837           in: query
5838           description: 'The address of the Practitioner resource.'
5839           required: false
5840           schema:
5841             type: string
5842         -
5843           name: address-city
5844           in: query
5845           description: 'The address-city of the Practitioner resource.'
5846           required: false
5847           schema:
5848             type: string
5849         -
5850           name: address-postalcode
5851           in: query
5852           description: 'The address-postalcode of the Practitioner resource.'
5853           required: false
5854           schema:
5855             type: string
5856         -
5857           name: address-state
5858           in: query
5859           description: 'The address-state of the Practitioner resource.'
5860           required: false
5861           schema:
5862             type: string
5863         -
5864           name: email
5865           in: query
5866           description: 'The email of the Practitioner resource.'
5867           required: false
5868           schema:
5869             type: string
5870         -
5871           name: family
5872           in: query
5873           description: 'The family name of the Practitioner resource.'
5874           required: false
5875           schema:
5876             type: string
5877         -
5878           name: given
5879           in: query
5880           description: 'The given name of the Practitioner resource.'
5881           required: false
5882           schema:
5883             type: string
5884         -
5885           name: phone
5886           in: query
5887           description: 'The phone number of the Practitioner resource.'
5888           required: false
5889           schema:
5890             type: string
5891         -
5892           name: telecom
5893           in: query
5894           description: 'The fax number of the Practitioner resource.'
5895           required: false
5896           schema:
5897             type: string
5898       responses:
5899         '200':
5900           description: 'Standard Response'
5901           content:
5902             application/json:
5903               schema:
5904                 properties:
5905                   'json object': { description: 'FHIR Json object.', type: object }
5906                 type: object
5907                 example:
5908                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5909                   resourceType: Bundle
5910                   type: collection
5911                   total: 0
5912                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Practitioner' }]
5913         '400':
5914           $ref: '#/components/responses/badrequest'
5915         '401':
5916           $ref: '#/components/responses/unauthorized'
5917       security:
5918         -
5919           openemr_auth: []
5920     post:
5921       tags:
5922         - fhir
5923       description: 'Adds a Practitioner resources.'
5924       requestBody:
5925         required: true
5926         content:
5927           application/json:
5928             schema:
5929               description: 'The json object for the Practitioner resource.'
5930               type: object
5931             example:
5932               id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5933               meta:
5934                 versionId: '1'
5935                 lastUpdated: '2021-09-21T17:41:57+00:00'
5936               resourceType: Practitioner
5937               text:
5938                 status: generated
5939                 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
5940               identifier:
5941                 -
5942                   system: 'http://hl7.org/fhir/sid/us-npi'
5943                   value: '11223344554543'
5944               active: true
5945               name:
5946                 -
5947                   use: official
5948                   family: Smith
5949                   given: [Danny]
5950       responses:
5951         '200':
5952           description: 'Standard Response'
5953           content:
5954             application/json:
5955               schema:
5956                 properties:
5957                   'json object': { description: 'FHIR Json object.', type: object }
5958                 type: object
5959                 example:
5960                   id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5961                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
5962                   resourceType: Practitioner
5963                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
5964                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
5965                   active: true
5966                   name: [{ use: official, family: Smith, given: [Danny] }]
5967         '400':
5968           $ref: '#/components/responses/badrequest'
5969         '401':
5970           $ref: '#/components/responses/unauthorized'
5971       security:
5972         -
5973           openemr_auth: []
5974   '/fhir/Practitioner/{uuid}':
5975     get:
5976       tags:
5977         - fhir
5978       description: 'Returns a single Practitioner resource.'
5979       parameters:
5980         -
5981           name: uuid
5982           in: path
5983           description: 'The uuid for the Practitioner resource.'
5984           required: true
5985           schema:
5986             type: string
5987       responses:
5988         '200':
5989           description: 'Standard Response'
5990           content:
5991             application/json:
5992               schema:
5993                 properties:
5994                   'json object': { description: 'FHIR Json object.', type: object }
5995                 type: object
5996                 example:
5997                   id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5998                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
5999                   resourceType: Practitioner
6000                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
6001                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
6002                   active: true
6003                   name: [{ use: official, family: Smith, given: [Billy] }]
6004         '400':
6005           $ref: '#/components/responses/badrequest'
6006         '401':
6007           $ref: '#/components/responses/unauthorized'
6008         '404':
6009           $ref: '#/components/responses/uuidnotfound'
6010       security:
6011         -
6012           openemr_auth: []
6013     put:
6014       tags:
6015         - fhir
6016       description: 'Modify a Practitioner resource.'
6017       parameters:
6018         -
6019           name: uuid
6020           in: path
6021           description: 'The uuid for the Practitioner resource.'
6022           required: true
6023           schema:
6024             type: string
6025       requestBody:
6026         required: true
6027         content:
6028           application/json:
6029             schema:
6030               description: 'The json object for the Practitioner resource.'
6031               type: object
6032             example:
6033               id: 9473b0cf-e969-4eaa-8044-51037767fa4f
6034               meta:
6035                 versionId: '1'
6036                 lastUpdated: '2021-09-21T17:41:57+00:00'
6037               resourceType: Practitioner
6038               text:
6039                 status: generated
6040                 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
6041               identifier:
6042                 -
6043                   system: 'http://hl7.org/fhir/sid/us-npi'
6044                   value: '11223344554543'
6045               active: true
6046               name:
6047                 -
6048                   use: official
6049                   family: Smith
6050                   given: [Billy]
6051       responses:
6052         '201':
6053           description: 'Standard Response'
6054           content:
6055             application/json:
6056               schema:
6057                 example:
6058                   id: 5
6059                   uuid: 95f294d7-e14c-441d-81a6-309fe369ee21
6060         '400':
6061           $ref: '#/components/responses/badrequest'
6062         '401':
6063           $ref: '#/components/responses/unauthorized'
6064       security:
6065         -
6066           openemr_auth: []
6067   /fhir/PractitionerRole:
6068     get:
6069       tags:
6070         - fhir
6071       description: 'Returns a list of PractitionerRole resources.'
6072       parameters:
6073         -
6074           name: specialty
6075           in: query
6076           description: 'The specialty of the PractitionerRole resource.'
6077           required: false
6078           schema:
6079             type: string
6080         -
6081           name: practitioner
6082           in: query
6083           description: 'The practitioner of the PractitionerRole resource.'
6084           required: false
6085           schema:
6086             type: string
6087       responses:
6088         '200':
6089           description: 'Standard Response'
6090           content:
6091             application/json:
6092               schema:
6093                 properties:
6094                   'json object': { description: 'FHIR Json object.', type: object }
6095                 type: object
6096                 example:
6097                   meta: { lastUpdated: '2021-09-14T09:13:51' }
6098                   resourceType: Bundle
6099                   type: collection
6100                   total: 0
6101                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/PractitionerRole' }]
6102         '400':
6103           $ref: '#/components/responses/badrequest'
6104         '401':
6105           $ref: '#/components/responses/unauthorized'
6106       security:
6107         -
6108           openemr_auth: []
6109   '/fhir/PractitionerRole/{uuid}':
6110     get:
6111       tags:
6112         - fhir
6113       description: 'Returns a single PractitionerRole resource.'
6114       parameters:
6115         -
6116           name: uuid
6117           in: path
6118           description: 'The uuid for the PractitionerRole resource.'
6119           required: true
6120           schema:
6121             type: string
6122       responses:
6123         '200':
6124           description: 'Standard Response'
6125           content:
6126             application/json:
6127               schema:
6128                 properties:
6129                   'json object': { description: 'FHIR Json object.', type: object }
6130                 type: object
6131                 example:
6132                   id: 960c806f-9463-482e-b228-67b5be1fed55
6133                   meta: { versionId: '1', lastUpdated: '2022-04-13T06:18:17+00:00' }
6134                   resourceType: PractitionerRole
6135                   practitioner: { reference: Practitioner/960c7cd6-187a-4119-8cd4-85389d80efb9, display: 'Administrator Administrator' }
6136                   organization: { reference: Organization/960c7cc6-b4ae-49bc-877b-1a2913271c43, display: 'Your Clinic Name Here' }
6137                   code: [{ coding: [102L00000X], text: Psychoanalyst }, { coding: [101Y00000X], text: Counselor }]
6138         '400':
6139           $ref: '#/components/responses/badrequest'
6140         '401':
6141           $ref: '#/components/responses/unauthorized'
6142         '404':
6143           $ref: '#/components/responses/uuidnotfound'
6144       security:
6145         -
6146           openemr_auth: []
6147   /fhir/Procedure:
6148     get:
6149       tags:
6150         - fhir
6151       description: 'Returns a list of Procedure resources.'
6152       parameters:
6153         -
6154           name: _id
6155           in: query
6156           description: 'The uuid for the Procedure resource.'
6157           required: false
6158           schema:
6159             type: string
6160         -
6161           name: patient
6162           in: query
6163           description: 'The uuid for the patient.'
6164           required: false
6165           schema:
6166             type: string
6167         -
6168           name: date
6169           in: query
6170           description: 'The datetime of the Procedure resource.'
6171           required: false
6172           schema:
6173             type: string
6174       responses:
6175         '200':
6176           description: 'Standard Response'
6177           content:
6178             application/json:
6179               schema:
6180                 properties:
6181                   'json object': { description: 'FHIR Json object.', type: object }
6182                 type: object
6183                 example:
6184                   meta: { lastUpdated: '2021-09-14T09:13:51' }
6185                   resourceType: Bundle
6186                   type: collection
6187                   total: 0
6188                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Procedure' }]
6189         '400':
6190           $ref: '#/components/responses/badrequest'
6191         '401':
6192           $ref: '#/components/responses/unauthorized'
6193       security:
6194         -
6195           openemr_auth: []
6196   '/fhir/Procedure/{uuid}':
6197     get:
6198       tags:
6199         - fhir
6200       description: 'Returns a single Procedure resource.'
6201       parameters:
6202         -
6203           name: uuid
6204           in: path
6205           description: 'The uuid for the Procedure resource.'
6206           required: true
6207           schema:
6208             type: string
6209       responses:
6210         '200':
6211           description: 'Standard Response'
6212           content:
6213             application/json:
6214               schema:
6215                 properties:
6216                   'json object': { description: 'FHIR Json object.', type: object }
6217                 type: object
6218                 example:
6219                   id: 95e9d3fb-fe7b-448a-aa60-d40b11b486a5
6220                   meta: { versionId: '1', lastUpdated: '2022-03-26T17:20:14+00:00' }
6221                   resourceType: Procedure
6222                   status: in-progress
6223                   subject: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf, type: Patient }
6224         '400':
6225           $ref: '#/components/responses/badrequest'
6226         '401':
6227           $ref: '#/components/responses/unauthorized'
6228         '404':
6229           $ref: '#/components/responses/uuidnotfound'
6230       security:
6231         -
6232           openemr_auth: []
6233   '/fhir/Provenance/{uuid}':
6234     get:
6235       tags:
6236         - fhir
6237       description: 'Returns a single Provenance resource.'
6238       parameters:
6239         -
6240           name: uuid
6241           in: path
6242           description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6243           required: true
6244           schema:
6245             type: string
6246       responses:
6247         '200':
6248           description: 'Standard Response'
6249           content:
6250             application/json:
6251               schema:
6252                 properties:
6253                   'json object': { description: 'FHIR Json object.', type: object }
6254                 type: object
6255                 example:
6256                   id: 'AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145'
6257                   resourceType: Provenance
6258                   target: [{ reference: AllergyIntolerance/95ea43f3-1066-4bc7-b224-6c23b985f145, type: AllergyIntolerance }]
6259                   recorded: '2022-03-26T22:43:30+00:00'
6260                   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 } }
6261         '400':
6262           $ref: '#/components/responses/badrequest'
6263         '401':
6264           $ref: '#/components/responses/unauthorized'
6265         '404':
6266           $ref: '#/components/responses/uuidnotfound'
6267       security:
6268         -
6269           openemr_auth: []
6270   /fhir/Provenance:
6271     get:
6272       tags:
6273         - fhir
6274       description: 'Returns a list of Provenance resources.'
6275       parameters:
6276         -
6277           name: _id
6278           in: query
6279           description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6280           required: false
6281           schema:
6282             type: string
6283       responses:
6284         '200':
6285           description: 'Standard Response'
6286           content:
6287             application/json:
6288               schema:
6289                 properties:
6290                   'json object': { description: 'FHIR Json object.', type: object }
6291                 type: object
6292                 example:
6293                   meta: { lastUpdated: '2021-09-14T09:13:51' }
6294                   resourceType: Bundle
6295                   type: collection
6296                   total: 0
6297                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Provenance' }]
6298         '400':
6299           $ref: '#/components/responses/badrequest'
6300         '401':
6301           $ref: '#/components/responses/unauthorized'
6302       security:
6303         -
6304           openemr_auth: []
6305   /fhir/metadata:
6306     get:
6307       tags:
6308         - fhir
6309       description: 'Returns metadata (ie. CapabilityStatement resource) of the fhir server.'
6310       responses:
6311         '200':
6312           description: 'Return CapabilityStatement resource of the fhir server'
6313   /fhir/.well-known/smart-configuration:
6314     get:
6315       tags:
6316         - fhir
6317       description: 'Returns smart configuration of the fhir server.'
6318       responses:
6319         '200':
6320           description: 'Return smart configuration of the fhir server'
6321   /fhir/OperationDefinition:
6322     get:
6323       tags:
6324         - fhir
6325       description: 'Returns a list of the OperationDefinition resources that are specific to this OpenEMR installation'
6326       responses:
6327         '200':
6328           description: 'Return list of OperationDefinition resources'
6329   '/fhir/OperationDefinition/{operation}':
6330     get:
6331       tags:
6332         - fhir
6333       description: 'Returns a single OperationDefinition resource that is specific to this OpenEMR installation'
6334       parameters:
6335         -
6336           name: operation
6337           in: path
6338           description: 'The name of the operation to query. For example $bulkdata-status'
6339           required: true
6340           schema:
6341             type: string
6342       responses:
6343         '200':
6344           description: 'Standard Response'
6345           content:
6346             application/json:
6347               schema:
6348                 properties:
6349                   'json object': { description: 'FHIR Json object.', type: object }
6350                 type: object
6351                 example:
6352                   resourceType: OperationDefinition
6353                   name: $bulkdata-status
6354                   status: active
6355                   kind: operation
6356                   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 } }]
6357   /fhir/$export:
6358     get:
6359       tags:
6360         - fhir
6361       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>'
6362       responses:
6363         '200':
6364           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>'
6365         '400':
6366           $ref: '#/components/responses/badrequest'
6367         '401':
6368           $ref: '#/components/responses/unauthorized'
6369       security:
6370         -
6371           openemr_auth: []
6372   /fhir/$bulkdata-status:
6373     get:
6374       tags:
6375         - fhir
6376       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>'
6377       responses:
6378         '200':
6379           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>'
6380         '400':
6381           $ref: '#/components/responses/badrequest'
6382         '401':
6383           $ref: '#/components/responses/unauthorized'
6384       security:
6385         -
6386           openemr_auth: []
6387     delete:
6388       tags:
6389         - fhir
6390       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>'
6391       responses:
6392         '200':
6393           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>'
6394         '400':
6395           $ref: '#/components/responses/badrequest'
6396         '401':
6397           $ref: '#/components/responses/unauthorized'
6398       security:
6399         -
6400           openemr_auth: []
6401   /portal/patient:
6402     get:
6403       tags:
6404         - standard-patient
6405       description: 'Returns the patient.'
6406       responses:
6407         '200':
6408           description: 'Standard response'
6409           content:
6410             application/json:
6411               schema:
6412                 $ref: '#/components/schemas/api_patient_response'
6413         '401':
6414           $ref: '#/components/responses/unauthorized'
6415       security:
6416         -
6417           openemr_auth: []
6418   /portal/patient/encounter:
6419     get:
6420       tags:
6421         - standard-patient
6422       description: 'Returns encounters for the patient.'
6423       responses:
6424         '200':
6425           $ref: '#/components/responses/standard'
6426         '400':
6427           $ref: '#/components/responses/badrequest'
6428         '401':
6429           $ref: '#/components/responses/unauthorized'
6430       security:
6431         -
6432           openemr_auth: []
6433   '/portal/patient/encounter/{euuid}':
6434     get:
6435       tags:
6436         - standard-patient
6437       description: 'Returns a selected encounter by its uuid.'
6438       parameters:
6439         -
6440           name: euuid
6441           in: path
6442           description: 'The uuid for the encounter.'
6443           required: true
6444           schema:
6445             type: string
6446       responses:
6447         '200':
6448           $ref: '#/components/responses/standard'
6449         '400':
6450           $ref: '#/components/responses/badrequest'
6451         '401':
6452           $ref: '#/components/responses/unauthorized'
6453       security:
6454         -
6455           openemr_auth: []
6456   /portal/patient/appointment:
6457     get:
6458       tags:
6459         - standard-patient
6460       description: 'Retrieves all appointments for a patient'
6461       responses:
6462         '200':
6463           $ref: '#/components/responses/standard'
6464         '400':
6465           $ref: '#/components/responses/badrequest'
6466         '401':
6467           $ref: '#/components/responses/unauthorized'
6468       security:
6469         -
6470           openemr_auth: []
6471   '/portal/patient/appointment/{auuid}':
6472     get:
6473       tags:
6474         - standard-patient
6475       description: 'Returns a selected appointment by its uuid.'
6476       parameters:
6477         -
6478           name: auuid
6479           in: path
6480           description: 'The uuid for the appointment.'
6481           required: true
6482           schema:
6483             type: string
6484       responses:
6485         '200':
6486           $ref: '#/components/responses/standard'
6487         '400':
6488           $ref: '#/components/responses/badrequest'
6489         '401':
6490           $ref: '#/components/responses/unauthorized'
6491       security:
6492         -
6493           openemr_auth: []
6494 components:
6495   schemas:
6496     api_patient_request:
6497       description: 'Schema for the patient request'
6498       required:
6499         - fname
6500         - lname
6501         - DOB
6502         - sex
6503       properties:
6504         title:
6505           description: 'The title of patient.'
6506           type: string
6507         fname:
6508           description: 'The fname of patient.'
6509           type: string
6510         mname:
6511           description: 'The mname of patient.'
6512           type: string
6513         lname:
6514           description: 'The lname of patient.'
6515           type: string
6516         street:
6517           description: 'The street address of patient.'
6518           type: string
6519         postal_code:
6520           description: 'The postal code of patient.'
6521           type: string
6522         city:
6523           description: 'The city of patient.'
6524           type: string
6525         state:
6526           description: 'The state of patient.'
6527           type: string
6528         country_code:
6529           description: 'The country code of patient.'
6530           type: string
6531         phone_contact:
6532           description: 'The phone contact of patient.'
6533           type: string
6534         DOB:
6535           description: 'The DOB of patient.'
6536           type: string
6537         sex:
6538           description: 'The lname of patient.'
6539           type: string
6540         race:
6541           description: 'The race of patient.'
6542           type: string
6543         ethnicity:
6544           description: 'The ethnicity of patient.'
6545           type: string
6546       type: object
6547       example:
6548         title: Mr
6549         fname: Foo
6550         mname: ''
6551         lname: Bar
6552         street: '456 Tree Lane'
6553         postal_code: '08642'
6554         city: FooTown
6555         state: FL
6556         country_code: US
6557         phone_contact: 123-456-7890
6558         DOB: '1992-02-02'
6559         sex: Male
6560         race: ''
6561         ethnicity: ''
6562     api_patient_response:
6563       description: 'Schema for the patient response'
6564       properties:
6565         validationErrors:
6566           description: 'Validation errors.'
6567           type: array
6568           items:
6569             type: object
6570         internalErrors:
6571           description: 'Internal errors.'
6572           type: array
6573           items:
6574             type: object
6575         data:
6576           description: 'Returned data.'
6577           type: array
6578           items:
6579             properties:
6580               id:
6581                 description: 'patient id'
6582                 type: string
6583               pid:
6584                 description: 'patient pid'
6585                 type: string
6586               pubpid:
6587                 description: 'patient public id'
6588                 type: string
6589               title:
6590                 description: 'patient title'
6591                 type: string
6592               fname:
6593                 description: 'patient first name'
6594                 type: string
6595               mname:
6596                 description: 'patient middle name'
6597                 type: string
6598               lname:
6599                 description: 'patient last name'
6600                 type: string
6601               ss:
6602                 description: 'patient social security number'
6603                 type: string
6604               street:
6605                 description: 'patient street address'
6606                 type: string
6607               postal_code:
6608                 description: 'patient postal code'
6609                 type: string
6610               city:
6611                 description: 'patient city'
6612                 type: string
6613               state:
6614                 description: 'patient state'
6615                 type: string
6616               county:
6617                 description: 'patient county'
6618                 type: string
6619               country_code:
6620                 description: 'patient country code'
6621                 type: string
6622               drivers_license:
6623                 description: 'patient drivers license id'
6624                 type: string
6625               contact_relationship:
6626                 description: 'patient contact relationship'
6627                 type: string
6628               phone_contact:
6629                 description: 'patient phone contact'
6630                 type: string
6631               phone_home:
6632                 description: 'patient home phone'
6633                 type: string
6634               phone_biz:
6635                 description: 'patient work phone'
6636                 type: string
6637               phone_cell:
6638                 description: 'patient mobile phone'
6639                 type: string
6640               email:
6641                 description: 'patient email'
6642                 type: string
6643               DOB:
6644                 description: 'patient DOB'
6645                 type: string
6646               sex:
6647                 description: 'patient sex (gender)'
6648                 type: string
6649               race:
6650                 description: 'patient race'
6651                 type: string
6652               ethnicity:
6653                 description: 'patient ethnicity'
6654                 type: string
6655               status:
6656                 description: 'patient status'
6657                 type: string
6658             type: object
6659       type: object
6660       example:
6661         validationErrors: []
6662         error_description: []
6663         data:
6664           id: '193'
6665           pid: '1'
6666           pubpid: ''
6667           title: Mr
6668           fname: Baz
6669           mname: ''
6670           lname: Bop
6671           ss: ''
6672           street: '456 Tree Lane'
6673           postal_code: '08642'
6674           city: FooTown
6675           state: FL
6676           county: ''
6677           country_code: US
6678           drivers_license: ''
6679           contact_relationship: ''
6680           phone_contact: 123-456-7890
6681           phone_home: ''
6682           phone_biz: ''
6683           phone_cell: ''
6684           email: ''
6685           DOB: '1992-02-03'
6686           sex: Male
6687           race: ''
6688           ethnicity: ''
6689           status: ''
6690     api_encounter_request:
6691       description: 'Schema for the encounter request'
6692       required:
6693         - pc_catid
6694         - class_code
6695       properties:
6696         date:
6697           description: 'The date of encounter.'
6698           type: string
6699         onset_date:
6700           description: 'The onset date of encounter.'
6701           type: string
6702         reason:
6703           description: 'The reason of encounter.'
6704           type: string
6705         facility:
6706           description: 'The facility of encounter.'
6707           type: string
6708         pc_catid:
6709           description: 'The pc_catid of encounter.'
6710           type: string
6711         facility_id:
6712           description: 'The facility id of encounter.'
6713           type: string
6714         billing_facility:
6715           description: 'The billing facility id of encounter.'
6716           type: string
6717         sensitivity:
6718           description: 'The sensitivity of encounter.'
6719           type: string
6720         referral_source:
6721           description: 'The referral source of encounter.'
6722           type: string
6723         pos_code:
6724           description: 'The pos_code of encounter.'
6725           type: string
6726         external_id:
6727           description: 'The external id of encounter.'
6728           type: string
6729         provider_id:
6730           description: 'The provider id of encounter.'
6731           type: string
6732         class_code:
6733           description: 'The class_code of encounter.'
6734           type: string
6735       type: object
6736       example:
6737         date: '2020-11-10'
6738         onset_date: ''
6739         reason: 'Pregnancy Test'
6740         facility: 'Owerri General Hospital'
6741         pc_catid: '5'
6742         facility_id: '3'
6743         billing_facility: '3'
6744         sensitivity: normal
6745         referral_source: ''
6746         pos_code: '0'
6747         external_id: ''
6748         provider_id: '1'
6749         class_code: AMB
6750     api_encounter_response:
6751       description: 'Schema for the encounter response'
6752       properties:
6753         validationErrors:
6754           description: 'Validation errors.'
6755           type: array
6756           items:
6757             type: object
6758         internalErrors:
6759           description: 'Internal errors.'
6760           type: array
6761           items:
6762             type: object
6763         data:
6764           description: 'Returned data.'
6765           type: array
6766           items:
6767             properties:
6768               id:
6769                 description: 'encounter id'
6770                 type: string
6771               uuid:
6772                 description: 'encounter uuid'
6773                 type: string
6774               date:
6775                 description: 'encounter date'
6776                 type: string
6777               reason:
6778                 description: 'encounter reason'
6779                 type: string
6780               facility:
6781                 description: 'encounter facility name'
6782                 type: string
6783               facility_id:
6784                 description: 'encounter facility id name'
6785                 type: string
6786               pid:
6787                 description: 'encounter for patient pid'
6788                 type: string
6789               onset_date:
6790                 description: 'encounter onset date'
6791                 type: string
6792               sensitivity:
6793                 description: 'encounter sensitivity'
6794                 type: string
6795               billing_note:
6796                 description: 'encounter billing note'
6797                 type: string
6798               pc_catid:
6799                 description: 'encounter pc_catid'
6800                 type: string
6801               last_level_billed:
6802                 description: 'encounter last_level_billed'
6803                 type: string
6804               last_level_closed:
6805                 description: 'encounter last_level_closed'
6806                 type: string
6807               last_stmt_date:
6808                 description: 'encounter last_stmt_date'
6809                 type: string
6810               stmt_count:
6811                 description: 'encounter stmt_count'
6812                 type: string
6813               provider_id:
6814                 description: 'provider id'
6815                 type: string
6816               supervisor_id:
6817                 description: 'encounter supervisor id'
6818                 type: string
6819               invoice_refno:
6820                 description: 'encounter invoice_refno'
6821                 type: string
6822               referral_source:
6823                 description: 'encounter referral source'
6824                 type: string
6825               billing_facility:
6826                 description: 'encounter billing facility id'
6827                 type: string
6828               external_id:
6829                 description: 'encounter external id'
6830                 type: string
6831               pos_code:
6832                 description: 'encounter pos_code'
6833                 type: string
6834               class_code:
6835                 description: 'encounter class_code'
6836                 type: string
6837               class_title:
6838                 description: 'encounter class_title'
6839                 type: string
6840               pc_catname:
6841                 description: 'encounter pc_catname'
6842                 type: string
6843               billing_facility_name:
6844                 description: 'encounter billing facility name'
6845                 type: string
6846             type: object
6847       type: object
6848       example:
6849         validationErrors: []
6850         error_description: []
6851         data:
6852           id: '1'
6853           uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef
6854           date: '2019-09-14 00:00:00'
6855           reason: 'Pregnancy Test'
6856           facility: 'Owerri General Hospital'
6857           facility_id: '3'
6858           pid: '1'
6859           onset_date: '2019-04-20 00:00:00'
6860           sensitivity: normal
6861           billing_note: null
6862           pc_catid: '5'
6863           last_level_billed: '0'
6864           last_level_closed: '0'
6865           last_stmt_date: null
6866           stmt_count: '0'
6867           provider_id: '1'
6868           supervisor_id: '0'
6869           invoice_refno: ''
6870           referral_source: ''
6871           billing_facility: '3'
6872           external_id: ''
6873           pos_code: '0'
6874           class_code: AMB
6875           class_title: ambulatory
6876           pc_catname: 'Office Visit'
6877           billing_facility_name: 'Owerri General Hospital'
6878     api_vital_request:
6879       description: 'Schema for the vital request'
6880       properties:
6881         bps:
6882           description: 'The bps of vitals.'
6883           type: string
6884         bpd:
6885           description: 'The bpd of vitals.'
6886           type: string
6887         weight:
6888           description: 'The weight of vitals. (unit is lb)'
6889           type: string
6890         height:
6891           description: 'The height of vitals. (unit is inches)'
6892           type: string
6893         temperature:
6894           description: 'The temperature of temperature. (unit is F)'
6895           type: string
6896         temp_method:
6897           description: 'The temp_method of vitals.'
6898           type: string
6899         pulse:
6900           description: 'The pulse of vitals.'
6901           type: string
6902         respiration:
6903           description: 'The respiration of vitals.'
6904           type: string
6905         note:
6906           description: 'The note (ie. comments) of vitals.'
6907           type: string
6908         waist_circ:
6909           description: 'The waist circumference of vitals. (unit is inches)'
6910           type: string
6911         head_circ:
6912           description: 'The head circumference of vitals. (unit is inches)'
6913           type: string
6914         oxygen_saturation:
6915           description: 'The oxygen_saturation of vitals.'
6916           type: string
6917       type: object
6918       example:
6919         bps: '130'
6920         bpd: '80'
6921         weight: '220'
6922         height: '70'
6923         temperature: '98'
6924         temp_method: Oral
6925         pulse: '60'
6926         respiration: '20'
6927         note: 'Patient with difficulty standing, which made weight measurement difficult.'
6928         waist_circ: '37'
6929         head_circ: '22.2'
6930         oxygen_saturation: '96'
6931     api_soap_note_request:
6932       description: 'Schema for the soap_note request'
6933       properties:
6934         subjective:
6935           description: 'The subjective of soap note.'
6936           type: string
6937         objective:
6938           description: 'The objective of soap note.'
6939           type: string
6940         assessment:
6941           description: 'The assessment of soap note.'
6942           type: string
6943         plan:
6944           description: 'The plan of soap note.'
6945           type: string
6946       type: object
6947       example:
6948         subjective: 'The patient with mechanical fall and cut finger.'
6949         objective: 'The patient with finger laceration on exam.'
6950         assessment: 'The patient with finger laceration requiring sutures.'
6951         plan: 'Sutured finger laceration.'
6952     api_medical_problem_request:
6953       description: 'Schema for the medical_problem request'
6954       required:
6955         - title
6956         - begdate
6957       properties:
6958         title:
6959           description: 'The title of medical problem.'
6960           type: string
6961         begdate:
6962           description: 'The beginning date of medical problem.'
6963           type: string
6964         enddate:
6965           description: 'The end date of medical problem.'
6966           type: string
6967         diagnosis:
6968           description: 'The diagnosis of medical problem. In format `<codetype>:<code>`'
6969           type: string
6970       type: object
6971       example:
6972         title: Dermatochalasis
6973         begdate: '2010-10-13'
6974         enddate: null
6975         diagnosis: 'ICD10:H02.839'
6976     api_allergy_request:
6977       description: 'Schema for the allergy request'
6978       required:
6979         - title
6980         - begdate
6981       properties:
6982         title:
6983           description: 'The title of allergy.'
6984           type: string
6985         begdate:
6986           description: 'The beginning date of allergy.'
6987           type: string
6988         enddate:
6989           description: 'The end date of allergy.'
6990           type: string
6991         diagnosis:
6992           description: 'The diagnosis of allergy. In format `<codetype>:<code>`'
6993           type: string
6994       type: object
6995       example:
6996         title: Iodine
6997         begdate: '2010-10-13'
6998         enddate: null
6999     api_medication_request:
7000       description: 'Schema for the medication request'
7001       required:
7002         - title
7003         - begdate
7004       properties:
7005         title:
7006           description: 'The title of medication.'
7007           type: string
7008         begdate:
7009           description: 'The beginning date of medication.'
7010           type: string
7011         enddate:
7012           description: 'The end date of medication.'
7013           type: string
7014         diagnosis:
7015           description: 'The diagnosis of medication. In format `<codetype>:<code>`'
7016           type: string
7017       type: object
7018       example:
7019         title: Norvasc
7020         begdate: '2013-04-13'
7021         enddate: null
7022     api_surgery_request:
7023       description: 'Schema for the surgery request'
7024       required:
7025         - title
7026         - begdate
7027       properties:
7028         title:
7029           description: 'The title of surgery.'
7030           type: string
7031         begdate:
7032           description: 'The beginning date of surgery.'
7033           type: string
7034         enddate:
7035           description: 'The end date of surgery.'
7036           type: string
7037         diagnosis:
7038           description: 'The diagnosis of surgery. In format `<codetype>:<code>`'
7039           type: string
7040       type: object
7041       example:
7042         title: Blepharoplasty
7043         begdate: '2013-10-14'
7044         enddate: null
7045         diagnosis: 'CPT4:15823-50'
7046     api_dental_issue_request:
7047       description: 'Schema for the dental_issue request'
7048       required:
7049         - title
7050         - begdate
7051       properties:
7052         title:
7053           description: 'The title of dental issue.'
7054           type: string
7055         begdate:
7056           description: 'The beginning date of dental issue.'
7057           type: string
7058         enddate:
7059           description: 'The end date of dental issue.'
7060           type: string
7061         diagnosis:
7062           description: 'The diagnosis of dental issue. In format `<codetype>:<code>`'
7063           type: string
7064       type: object
7065       example:
7066         title: Halitosis
7067         begdate: '2015-03-17'
7068         enddate: null
7069     api_insurance_company_request:
7070       description: 'Schema for the insurance_company request'
7071       required:
7072         - name
7073       properties:
7074         name:
7075           description: 'The name of insurance company.'
7076           type: string
7077         attn:
7078           description: 'The attn of insurance company.'
7079           type: string
7080         cms_id:
7081           description: 'The cms id of insurance company.'
7082           type: string
7083         ins_type_code:
7084           description: 'The insurance type code of insurance company. The insurance type code can be found by inspecting the route at (/api/insurance_type).'
7085           type: string
7086         x12_receiver_id:
7087           description: 'The x12 receiver id of insurance company.'
7088           type: string
7089         x12_default_partner_id:
7090           description: 'The x12 default partner id of insurance company.'
7091           type: string
7092         alt_cms_id:
7093           description: 'The alternate cms id of insurance company.'
7094           type: string
7095         line1:
7096           description: 'The line1 address of insurance company.'
7097           type: string
7098         line2:
7099           description: 'The line2 address of insurance company.'
7100           type: string
7101         city:
7102           description: 'The city of insurance company.'
7103           type: string
7104         state:
7105           description: 'The state of insurance company.'
7106           type: string
7107         zip:
7108           description: 'The zip of insurance company.'
7109           type: string
7110         country:
7111           description: 'The country of insurance company.'
7112           type: string
7113       type: object
7114       example:
7115         name: 'Cool Insurance Company'
7116         attn: null
7117         cms_id: null
7118         ins_type_code: '2'
7119         x12_receiver_id: null
7120         x12_default_partner_id: null
7121         alt_cms_id: ''
7122         line1: '123 Cool Lane'
7123         line2: 'Suite 123'
7124         city: Cooltown
7125         state: CA
7126         zip: '12245'
7127         country: USA
7128     api_insurance_request:
7129       description: 'Schema for the insurance request'
7130       required:
7131         - provider
7132         - plan_name
7133         - policy_number
7134         - group_number
7135         - subscriber_fname
7136         - subscriber_lname
7137         - subscriber_relationship
7138         - subscriber_ss
7139         - subscriber_DOB
7140         - subscriber_street
7141         - subscriber_postal_code
7142         - subscriber_city
7143         - subscriber_state
7144         - subscriber_country
7145         - subscriber_phone
7146         - subscriber_sex
7147         - accept_assignment
7148         - policy_type
7149       properties:
7150         provider:
7151           description: 'The insurance company id.'
7152           type: string
7153         plan_name:
7154           description: 'The plan name of insurance.'
7155           type: string
7156         policy_number:
7157           description: 'The policy number of insurance.'
7158           type: string
7159         group_number:
7160           description: 'The group number of insurance.'
7161           type: string
7162         subscriber_lname:
7163           description: 'The subscriber last name of insurance.'
7164           type: string
7165         subscriber_mname:
7166           description: 'The subscriber middle name of insurance.'
7167           type: string
7168         subscriber_fname:
7169           description: 'The subscriber first name of insurance.'
7170           type: string
7171         subscriber_relationship:
7172           description: 'The subscriber relationship of insurance.'
7173           type: string
7174         subscriber_ss:
7175           description: 'The subscriber ss number of insurance.'
7176           type: string
7177         subscriber_DOB:
7178           description: 'The subscriber DOB of insurance.'
7179           type: string
7180         subscriber_street:
7181           description: 'The subscriber street address of insurance.'
7182           type: string
7183         subscriber_postal_code:
7184           description: 'The subscriber postal code of insurance.'
7185           type: string
7186         subscriber_city:
7187           description: 'The subscriber city of insurance.'
7188           type: string
7189         subscriber_state:
7190           description: 'The subscriber state of insurance. `state` can be found by querying `resource=/api/list/state`'
7191           type: string
7192         subscriber_country:
7193           description: 'The subscriber country of insurance. `country` can be found by querying `resource=/api/list/country`'
7194           type: string
7195         subscriber_phone:
7196           description: 'The subscriber phone of insurance.'
7197           type: string
7198         subscriber_employer:
7199           description: 'The subscriber employer of insurance.'
7200           type: string
7201         subscriber_employer_street:
7202           description: 'The subscriber employer street of insurance.'
7203           type: string
7204         subscriber_employer_postal_code:
7205           description: 'The subscriber employer postal code of insurance.'
7206           type: string
7207         subscriber_employer_state:
7208           description: 'The subscriber employer state of insurance.'
7209           type: string
7210         subscriber_employer_country:
7211           description: 'The subscriber employer country of insurance.'
7212           type: string
7213         subscriber_employer_city:
7214           description: 'The subscriber employer city of insurance.'
7215           type: string
7216         copay:
7217           description: 'The copay of insurance.'
7218           type: string
7219         date:
7220           description: 'The date of insurance.'
7221           type: string
7222         subscriber_sex:
7223           description: 'The subscriber sex of insurance.'
7224           type: string
7225         accept_assignment:
7226           description: 'The accept_assignment of insurance.'
7227           type: string
7228         policy_type:
7229           description: 'The policy_type of insurance.'
7230           type: string
7231       type: object
7232       example:
7233         provider: '33'
7234         plan_name: 'Some Plan'
7235         policy_number: '12345'
7236         group_number: '252412'
7237         subscriber_lname: Tester
7238         subscriber_mname: Xi
7239         subscriber_fname: Foo
7240         subscriber_relationship: other
7241         subscriber_ss: '234231234'
7242         subscriber_DOB: '2018-10-03'
7243         subscriber_street: '183 Cool St'
7244         subscriber_postal_code: '23418'
7245         subscriber_city: Cooltown
7246         subscriber_state: AZ
7247         subscriber_country: USA
7248         subscriber_phone: 234-598-2123
7249         subscriber_employer: 'Some Employer'
7250         subscriber_employer_street: '123 Heather Lane'
7251         subscriber_employer_postal_code: '23415'
7252         subscriber_employer_state: AZ
7253         subscriber_employer_country: USA
7254         subscriber_employer_city: Cooltown
7255         copay: '35'
7256         date: '2018-10-15'
7257         subscriber_sex: Female
7258         accept_assignment: 'TRUE'
7259         policy_type: a
7260     api_message_request:
7261       description: 'Schema for the message request'
7262       required:
7263         - body
7264         - groupname
7265         - from
7266         - to
7267         - title
7268         - message_status
7269       properties:
7270         body:
7271           description: 'The body of message.'
7272           type: string
7273         groupname:
7274           description: 'The group name (usually is ''Default'').'
7275           type: string
7276         from:
7277           description: 'The sender of the message.'
7278           type: string
7279         to:
7280           description: 'The recipient of the message.'
7281           type: string
7282         title:
7283           description: 'use an option from resource=/api/list/note_type'
7284           type: string
7285         message_status:
7286           description: 'use an option from resource=/api/list/message_status'
7287           type: string
7288       type: object
7289       example:
7290         body: 'Test 456'
7291         groupname: Default
7292         from: Matthew
7293         to: admin
7294         title: Other
7295         message_status: New
7296     api_transaction_request:
7297       description: 'Schema for the transaction request'
7298       required:
7299         - message
7300         - groupname
7301         - title
7302       properties:
7303         message:
7304           description: 'The message of the transaction.'
7305           type: string
7306         type:
7307           description: 'The type of transaction. Use an option from resource=/api/transaction_type'
7308           type: string
7309         groupname:
7310           description: 'The group name (usually is ''Default'').'
7311           type: string
7312         referByNpi:
7313           description: 'NPI of the person creating the referral.'
7314           type: string
7315         referToNpi:
7316           description: 'NPI of the person getting the referral.'
7317           type: string
7318         referDiagnosis:
7319           description: 'The referral diagnosis.'
7320           type: string
7321         riskLevel:
7322           description: 'The risk level. (Low, Medium, High)'
7323           type: string
7324         includeVitals:
7325           description: 'Are vitals included (0,1)'
7326           type: string
7327         referralDate:
7328           description: 'The date of the referral'
7329           type: string
7330         authorization:
7331           description: 'The authorization for the referral'
7332           type: string
7333         visits:
7334           description: 'The number of vists for the referral'
7335           type: string
7336         validFrom:
7337           description: 'The date the referral is valid from'
7338           type: string
7339         validThrough:
7340           description: 'The date the referral is valid through'
7341           type: string
7342       type: object
7343       example:
7344         message: Message
7345         type: LBTref
7346         groupname: Default
7347         referByNpi: '9999999999'
7348         referToNpi: '9999999999'
7349         referDiagnosis: 'Diag 1'
7350         riskLevel: Low
7351         includeVitals: '1'
7352         referralDate: '2022-01-01'
7353         authorization: Auth_123
7354         visits: '1'
7355         validFrom: '2022-01-02'
7356         validThrough: '2022-01-03'
7357         body: 'Reason 1'
7358   responses:
7359     standard:
7360       description: 'Standard Response'
7361       content:
7362         application/json:
7363           schema:
7364             properties:
7365               validationErrors:
7366                 description: 'Validation errors.'
7367                 type: array
7368                 items:
7369                   type: object
7370               internalErrors:
7371                 description: 'Internal errors.'
7372                 type: array
7373                 items:
7374                   type: object
7375               data:
7376                 description: 'Returned data.'
7377                 type: array
7378                 items:
7379                   type: object
7380             type: object
7381             example:
7382               validationErrors: []
7383               error_description: []
7384               data: []
7385     badrequest:
7386       description: 'Bad Request'
7387       content:
7388         application/json:
7389           schema:
7390             properties:
7391               validationErrors:
7392                 description: 'Validation errors.'
7393                 type: object
7394             type: object
7395             example:
7396               validationErrors:
7397                 _id: 'The search field argument was invalid, improperly formatted, or could not be parsed.  Inner message: UUID columns must be a valid UUID string'
7398     unauthorized:
7399       description: Unauthorized
7400       content:
7401         application/json:
7402           schema:
7403             properties:
7404               error:
7405                 description: 'The error.'
7406                 type: string
7407               error_description:
7408                 description: 'The description of the error.'
7409                 type: string
7410               hint:
7411                 description: 'More specific information on the error.'
7412                 type: string
7413               message:
7414                 description: 'Message regarding the error.'
7415                 type: string
7416             type: object
7417             example:
7418               error: access_denied
7419               error_description: 'The resource owner or authorization server denied the request.'
7420               hint: 'Missing "Authorization" header'
7421               message: 'The resource owner or authorization server denied the request.'
7422     uuidnotfound:
7423       description: 'Not Found'
7424       content:
7425         application/json:
7426           schema:
7427             properties:
7428               empty:
7429                 description: empty
7430                 type: object
7431             type: object
7432             example: []
7433   securitySchemes:
7434     openemr_auth:
7435       type: oauth2
7436       flows:
7437         authorizationCode:
7438           authorizationUrl: /oauth2/default/authorize
7439           tokenUrl: /oauth2/default/token
7440           refreshUrl: /oauth2/default/token
7441           scopes:
7442             openid: 'Generic mandatory scope'
7443             offline_access: 'Will signal server to provide a refresh token'
7444             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)'
7445             'api:fhir': 'FHIR R4 API'
7446             patient/AllergyIntolerance.read: 'Read allergy intolerance resources for the current patient (api:fhir)'
7447             patient/Appointment.read: 'Read appointment resources for the current patient (api:fhir)'
7448             patient/Binary.read: 'Read binary document resources for the current patient (api:fhir)'
7449             patient/CarePlan.read: 'Read care plan resources for the current patient (api:fhir)'
7450             patient/CareTeam.read: 'Read care team resources for the current patient (api:fhir)'
7451             patient/Condition.read: 'Read condition resources for the current patient (api:fhir)'
7452             patient/Coverage.read: 'Read coverage resources for the current patient (api:fhir)'
7453             patient/Device.read: 'Read device resources for the current patient (api:fhir)'
7454             patient/DiagnosticReport.read: 'Read diagnostic report resources for the current patient (api:fhir)'
7455             patient/DocumentReference.read: 'Read document reference resources for the current patient (api:fhir)'
7456             patient/DocumentReference.$docref: 'Generate a document for the current patient or returns the most current Clinical Summary of Care Document (CCD)'
7457             patient/Encounter.read: 'Read encounter resources for the current patient (api:fhir)'
7458             patient/Goal.read: 'Read goal resources for the current patient (api:fhir)'
7459             patient/Immunization.read: 'Read immunization resources for the current patient (api:fhir)'
7460             patient/Location.read: 'Read location resources for the current patient (api:fhir)'
7461             patient/Medication.read: 'Read medication resources for the current patient (api:fhir)'
7462             patient/MedicationRequest.read: 'Read medication request resources for the current patient (api:fhir)'
7463             patient/Observation.read: 'Read observation resources for the current patient (api:fhir)'
7464             patient/Organization.read: 'Read organization resources for the current patient (api:fhir)'
7465             patient/Patient.read: 'Read patient resource for the current patient (api:fhir)'
7466             patient/Person.read: 'Read person resources for the current patient (api:fhir)'
7467             patient/Practitioner.read: 'Read practitioner resources for the current patient (api:fhir)'
7468             patient/Procedure.read: 'Read procedure resources for the current patient (api:fhir)'
7469             patient/Provenance.read: 'Read provenance resources for the current patient (api:fhir)'
7470             system/AllergyIntolerance.read: 'Read all allergy intolerance resources in the system (api:fhir)'
7471             system/Binary.read: 'Read all binary document resources in the system (api:fhir)'
7472             system/CarePlan.read: 'Read all care plan resources in the system (api:fhir)'
7473             system/CareTeam.read: 'Read all care team resources in the system (api:fhir)'
7474             system/Condition.read: 'Read all condition resources in the system (api:fhir)'
7475             system/Coverage.read: 'Read all coverage resources in the system (api:fhir)'
7476             system/Device.read: 'Read all device resources in the system (api:fhir)'
7477             system/DiagnosticReport.read: 'Read all diagnostic report resources in the system (api:fhir)'
7478             system/DocumentReference.read: 'Read all document reference resources in the system (api:fhir)'
7479             system/DocumentReference.$docref: 'Generate a document for any patient in the system or returns the most current Clinical Summary of Care Document (CCD)'
7480             system/Encounter.read: 'Read all encounter resources in the system (api:fhir)'
7481             system/Goal.read: 'Read all goal resources in the system (api:fhir)'
7482             system/Group.read: 'Read all group resources in the system (api:fhir)'
7483             system/Immunization.read: 'Read all immunization resources in the system (api:fhir)'
7484             system/Location.read: 'Read all location resources in the system (api:fhir)'
7485             system/Medication.read: 'Read all medication resources in the system (api:fhir)'
7486             system/MedicationRequest.read: 'Read all medication request resources in the system (api:fhir)'
7487             system/Observation.read: 'Read all observation resources in the system (api:fhir)'
7488             system/Organization.read: 'Read all organization resources in the system (api:fhir)'
7489             system/Patient.read: 'Read all patient resources in the system (api:fhir)'
7490             system/Person.read: 'Read all person resources in the system (api:fhir)'
7491             system/Practitioner.read: 'Read all practitioner resources in the system (api:fhir)'
7492             system/PractitionerRole.read: 'Read all practitioner role resources in the system (api:fhir)'
7493             system/Procedure.read: 'Read all procedure resources in the system (api:fhir)'
7494             system/Provenance.read: 'Read all provenance resources in the system (api:fhir)'
7495             user/AllergyIntolerance.read: 'Read all allergy intolerance resources the user has access to (api:fhir)'
7496             user/Binary.read: 'Read all binary documents the user has access to (api:fhir)'
7497             user/CarePlan.read: 'Read all care plan resources the user has access to (api:fhir)'
7498             user/CareTeam.read: 'Read all care team resources the user has access to (api:fhir)'
7499             user/Condition.read: 'Read all condition resources the user has access to (api:fhir)'
7500             user/Coverage.read: 'Read all coverage resources the user has access to (api:fhir)'
7501             user/Device.read: 'Read all device resources the user has access to (api:fhir)'
7502             user/DiagnosticReport.read: 'Read all diagnostic report resources the user has access to (api:fhir)'
7503             user/DocumentReference.read: 'Read all document reference resources the user has access to (api:fhir)'
7504             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)'
7505             user/Encounter.read: 'Read all encounter resources the user has access to (api:fhir)'
7506             user/Goal.read: 'Read all goal resources the user has access to (api:fhir)'
7507             user/Immunization.read: 'Read all immunization resources the user has access to (api:fhir)'
7508             user/Location.read: 'Read all location resources the user has access to (api:fhir)'
7509             user/Medication.read: 'Read all medication resources the user has access to (api:fhir)'
7510             user/MedicationRequest.read: 'Read all medication request resources the user has access to (api:fhir)'
7511             user/Observation.read: 'Read all observation resources the user has access to (api:fhir)'
7512             user/Organization.read: 'Read all organization resources the user has access to (api:fhir)'
7513             user/Organization.write: 'Write all organization resources the user has access to (api:fhir)'
7514             user/Patient.read: 'Read all patient resources the user has access to (api:fhir)'
7515             user/Patient.write: 'Write all patient resources the user has access to (api:fhir)'
7516             user/Person.read: 'Read all person resources the user has access to (api:fhir)'
7517             user/Practitioner.read: 'Read all practitioner resources the user has access to (api:fhir)'
7518             user/Practitioner.write: 'Write all practitioner resources the user has access to (api:fhir)'
7519             user/PractitionerRole.read: 'Read all practitioner role resources the user has access to (api:fhir)'
7520             user/Procedure.read: 'Read all procedure resources the user has access to (api:fhir)'
7521             user/Provenance.read: 'Read all provenance resources the user has access to (api:fhir)'
7522             'api:oemr': 'Standard OpenEMR API'
7523             user/allergy.read: 'Read allergies the user has access to (api:oemr)'
7524             user/allergy.write: 'Write allergies the user has access to for (api:oemr)'
7525             user/appointment.read: 'Read appointments the user has access to (api:oemr)'
7526             user/appointment.write: 'Write appointments the user has access to for (api:oemr)'
7527             user/dental_issue.read: 'Read dental issues the user has access to (api:oemr)'
7528             user/dental_issue.write: 'Write dental issues the user has access to (api:oemr)'
7529             user/document.read: 'Read documents the user has access to (api:oemr)'
7530             user/document.write: 'Write documents the user has access to (api:oemr)'
7531             user/drug.read: 'Read drugs the user has access to (api:oemr)'
7532             user/encounter.read: 'Read encounters the user has access to (api:oemr)'
7533             user/encounter.write: 'Write encounters the user has access to (api:oemr)'
7534             user/facility.read: 'Read facilities the user has access to (api:oemr)'
7535             user/facility.write: 'Write facilities the user has access to (api:oemr)'
7536             user/immunization.read: 'Read immunizations the user has access to (api:oemr)'
7537             user/insurance.read: 'Read insurances the user has access to (api:oemr)'
7538             user/insurance.write: 'Write insurances the user has access to (api:oemr)'
7539             user/insurance_company.read: 'Read insurance companies the user has access to (api:oemr)'
7540             user/insurance_company.write: 'Write insurance companies the user has access to (api:oemr)'
7541             user/insurance_type.read: 'Read insurance types the user has access to (api:oemr)'
7542             user/list.read: 'Read lists the user has access to (api:oemr)'
7543             user/medical_problem.read: 'Read medical problems the user has access to (api:oemr)'
7544             user/medical_problem.write: 'Write medical problems the user has access to (api:oemr)'
7545             user/medication.read: 'Read medications the user has access to (api:oemr)'
7546             user/medication.write: 'Write medications the user has access to (api:oemr)'
7547             user/message.write: 'Read messages the user has access to (api:oemr)'
7548             user/patient.read: 'Read patients the user has access to (api:oemr)'
7549             user/patient.write: 'Write patients the user has access to (api:oemr)'
7550             user/practitioner.read: 'Read practitioners the user has access to (api:oemr)'
7551             user/practitioner.write: 'Write practitioners the user has access to (api:oemr)'
7552             user/prescription.read: 'Read prescriptions the user has access to (api:oemr)'
7553             user/procedure.read: 'Read procedures the user has access to (api:oemr)'
7554             user/soap_note.read: 'Read soap notes the user has access to (api:oemr)'
7555             user/soap_note.write: 'Write soap notes the user has access to (api:oemr)'
7556             user/surgery.read: 'Read surgeries the user has access to (api:oemr)'
7557             user/surgery.write: 'Write surgeries the user has access to (api:oemr)'
7558             user/transaction.read: 'Read transactions the user has access to (api:oemr)'
7559             user/transaction.write: 'Write transactions the user has access to (api:oemr)'
7560             user/vital.read: 'Read vitals the user has access to (api:oemr)'
7561             user/vital.write: 'Write vitals the user has access to (api:oemr)'
7562             'api:port': 'Standard Patient Portal OpenEMR API'
7563             patient/encounter.read: 'Read encounters the patient has access to (api:port)'
7564             patient/patient.read: 'Write encounters the patient has access to (api:port)'
7565             patient/appointment.read: 'Read appointments the patient has access to (api:port)'
7566 tags:
7567   -
7568     name: fhir
7569     description: 'FHIR R4 API'
7570   -
7571     name: standard
7572     description: 'Standard OpenEMR API'
7573   -
7574     name: standard-patient
7575     description: 'Standard Patient Portal OpenEMR API'