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/CarePlan:
3609     get:
3610       tags:
3611         - fhir
3612       description: 'Returns a list of CarePlan resources.'
3613       parameters:
3614         -
3615           name: _id
3616           in: query
3617           description: 'The uuid for the CarePlan 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         -
3629           name: category
3630           in: query
3631           description: 'The category of the CarePlan resource.'
3632           required: false
3633           schema:
3634             type: string
3635       responses:
3636         '200':
3637           description: 'Standard Response'
3638           content:
3639             application/json:
3640               schema:
3641                 properties:
3642                   'json object': { description: 'FHIR Json object.', type: object }
3643                 type: object
3644                 example:
3645                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3646                   resourceType: Bundle
3647                   type: collection
3648                   total: 0
3649                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CarePlan' }]
3650         '400':
3651           $ref: '#/components/responses/badrequest'
3652         '401':
3653           $ref: '#/components/responses/unauthorized'
3654       security:
3655         -
3656           openemr_auth: []
3657   '/fhir/CarePlan/{uuid}':
3658     get:
3659       tags:
3660         - fhir
3661       description: 'Returns a single CarePlan resource.'
3662       parameters:
3663         -
3664           name: uuid
3665           in: path
3666           description: 'The uuid for the CarePlan resource.'
3667           required: true
3668           schema:
3669             type: string
3670       responses:
3671         '200':
3672           description: 'Standard Response'
3673           content:
3674             application/json:
3675               schema:
3676                 properties:
3677                   'json object': { description: 'FHIR Json object.', type: object }
3678                 type: object
3679                 example:
3680                   id: 94682f08-8fbc-451e-b1ec-f922d765c38f_1
3681                   meta: { versionId: '1', lastUpdated: '2021-09-16T00:54:18+00:00' }
3682                   resourceType: CarePlan
3683                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"><p>Treat flu.</p></div>' }
3684                   status: active
3685                   intent: plan
3686                   category: [{ coding: [{ system: 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category', code: assess-plan }] }]
3687                   description: 'Treat flu.'
3688                   subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
3689         '400':
3690           $ref: '#/components/responses/badrequest'
3691         '401':
3692           $ref: '#/components/responses/unauthorized'
3693         '404':
3694           $ref: '#/components/responses/uuidnotfound'
3695       security:
3696         -
3697           openemr_auth: []
3698   /fhir/CareTeam:
3699     get:
3700       tags:
3701         - fhir
3702       description: 'Returns a list of CareTeam resources.'
3703       parameters:
3704         -
3705           name: _id
3706           in: query
3707           description: 'The uuid for the CareTeam resource.'
3708           required: false
3709           schema:
3710             type: string
3711         -
3712           name: patient
3713           in: query
3714           description: 'The uuid for the patient.'
3715           required: false
3716           schema:
3717             type: string
3718         -
3719           name: status
3720           in: query
3721           description: 'The status of the CarePlan resource.'
3722           required: false
3723           schema:
3724             type: string
3725       responses:
3726         '200':
3727           description: 'Standard Response'
3728           content:
3729             application/json:
3730               schema:
3731                 properties:
3732                   'json object': { description: 'FHIR Json object.', type: object }
3733                 type: object
3734                 example:
3735                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3736                   resourceType: Bundle
3737                   type: collection
3738                   total: 0
3739                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/CareTeam' }]
3740         '400':
3741           $ref: '#/components/responses/badrequest'
3742         '401':
3743           $ref: '#/components/responses/unauthorized'
3744       security:
3745         -
3746           openemr_auth: []
3747   '/fhir/CareTeam/{uuid}':
3748     get:
3749       tags:
3750         - fhir
3751       description: 'Returns a single CareTeam resource.'
3752       parameters:
3753         -
3754           name: uuid
3755           in: path
3756           description: 'The uuid for the CareTeam resource.'
3757           required: true
3758           schema:
3759             type: string
3760       responses:
3761         '200':
3762           description: 'Standard Response'
3763           content:
3764             application/json:
3765               schema:
3766                 properties:
3767                   'json object': { description: 'FHIR Json object.', type: object }
3768                 type: object
3769                 example:
3770                   id: 94682f09-69fe-4ada-8ea6-753a52bd1516
3771                   meta: { versionId: '1', lastUpdated: '2021-09-16T01:07:22+00:00' }
3772                   resourceType: CareTeam
3773                   status: active
3774                   subject: { reference: Patient/94682ef5-b0e3-4289-b19a-11b9592e9c92, type: Patient }
3775                   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 } }]
3776         '400':
3777           $ref: '#/components/responses/badrequest'
3778         '401':
3779           $ref: '#/components/responses/unauthorized'
3780         '404':
3781           $ref: '#/components/responses/uuidnotfound'
3782       security:
3783         -
3784           openemr_auth: []
3785   /fhir/Condition:
3786     get:
3787       tags:
3788         - fhir
3789       description: 'Returns a list of Condition resources.'
3790       parameters:
3791         -
3792           name: _id
3793           in: query
3794           description: 'The uuid for the Condition resource.'
3795           required: false
3796           schema:
3797             type: string
3798         -
3799           name: patient
3800           in: query
3801           description: 'The uuid for the patient.'
3802           required: false
3803           schema:
3804             type: string
3805       responses:
3806         '200':
3807           description: 'Standard Response'
3808           content:
3809             application/json:
3810               schema:
3811                 properties:
3812                   'json object': { description: 'FHIR Json object.', type: object }
3813                 type: object
3814                 example:
3815                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3816                   resourceType: Bundle
3817                   type: collection
3818                   total: 0
3819                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Condition' }]
3820         '400':
3821           $ref: '#/components/responses/badrequest'
3822         '401':
3823           $ref: '#/components/responses/unauthorized'
3824       security:
3825         -
3826           openemr_auth: []
3827   '/fhir/Condition/{uuid}':
3828     get:
3829       tags:
3830         - fhir
3831       description: 'Returns a single Condition resource.'
3832       parameters:
3833         -
3834           name: uuid
3835           in: path
3836           description: 'The uuid for the Condition resource.'
3837           required: true
3838           schema:
3839             type: string
3840       responses:
3841         '200':
3842           description: 'Standard Response'
3843           content:
3844             application/json:
3845               schema:
3846                 properties:
3847                   'json object': { description: 'FHIR Json object.', type: object }
3848                 type: object
3849                 example:
3850                   id: 94682c68-e5bb-4c5c-859a-cebaa5a1e582
3851                   meta: { versionId: '1', lastUpdated: '2021-09-16T02:41:53+00:00' }
3852                   resourceType: Condition
3853                   clinicalStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-clinical', code: inactive, display: Inactive }] }
3854                   verificationStatus: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-ver-status', code: unconfirmed, display: Unconfirmed }] }
3855                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/condition-category', code: problem-list-item, display: 'Problem List Item' }] }]
3856                   code: { coding: [{ system: 'http://snomed.info/sct', code: '444814009', display: '' }] }
3857                   subject: { reference: Patient/94682c62-d37e-48b5-8018-c5f6f3566609 }
3858         '400':
3859           $ref: '#/components/responses/badrequest'
3860         '401':
3861           $ref: '#/components/responses/unauthorized'
3862         '404':
3863           $ref: '#/components/responses/uuidnotfound'
3864       security:
3865         -
3866           openemr_auth: []
3867   /fhir/Coverage:
3868     get:
3869       tags:
3870         - fhir
3871       description: 'Returns a list of Coverage resources.'
3872       parameters:
3873         -
3874           name: _id
3875           in: query
3876           description: 'The uuid for the Coverage resource.'
3877           required: false
3878           schema:
3879             type: string
3880         -
3881           name: patient
3882           in: query
3883           description: 'The uuid for the patient.'
3884           required: false
3885           schema:
3886             type: string
3887         -
3888           name: payor
3889           in: query
3890           description: 'The payor of the Coverage resource.'
3891           required: false
3892           schema:
3893             type: string
3894       responses:
3895         '200':
3896           description: 'Standard Response'
3897           content:
3898             application/json:
3899               schema:
3900                 properties:
3901                   'json object': { description: 'FHIR Json object.', type: object }
3902                 type: object
3903                 example:
3904                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3905                   resourceType: Bundle
3906                   type: collection
3907                   total: 0
3908                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Coverage' }]
3909         '400':
3910           $ref: '#/components/responses/badrequest'
3911         '401':
3912           $ref: '#/components/responses/unauthorized'
3913       security:
3914         -
3915           openemr_auth: []
3916   '/fhir/Coverage/{uuid}':
3917     get:
3918       tags:
3919         - fhir
3920       description: 'Returns a single Coverage resource.'
3921       parameters:
3922         -
3923           name: uuid
3924           in: path
3925           description: 'The uuid for the Coverage resource.'
3926           required: true
3927           schema:
3928             type: string
3929       responses:
3930         '200':
3931           description: 'Standard Response'
3932           content:
3933             application/json:
3934               schema:
3935                 properties:
3936                   'json object': { description: 'FHIR Json object.', type: object }
3937                 type: object
3938                 example:
3939                   id: 960d5f10-edc6-4c65-a6d4-39a1e1da87a8
3940                   meta: { versionId: '1', lastUpdated: '2022-04-14T07:58:45+00:00' }
3941                   resourceType: Coverage
3942                   status: active
3943                   beneficiary: { reference: Patient/960d5f08-9fdf-4bdc-9108-84a149e28bac }
3944                   relationship: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/subscriber-relationship', code: '' }] }
3945         '400':
3946           $ref: '#/components/responses/badrequest'
3947         '401':
3948           $ref: '#/components/responses/unauthorized'
3949         '404':
3950           $ref: '#/components/responses/uuidnotfound'
3951       security:
3952         -
3953           openemr_auth: []
3954   /fhir/Device:
3955     get:
3956       tags:
3957         - fhir
3958       description: 'Returns a list of Device resources.'
3959       parameters:
3960         -
3961           name: _id
3962           in: query
3963           description: 'The uuid for the Device resource.'
3964           required: false
3965           schema:
3966             type: string
3967         -
3968           name: patient
3969           in: query
3970           description: 'The uuid for the patient.'
3971           required: false
3972           schema:
3973             type: string
3974       responses:
3975         '200':
3976           description: 'Standard Response'
3977           content:
3978             application/json:
3979               schema:
3980                 properties:
3981                   'json object': { description: 'FHIR Json object.', type: object }
3982                 type: object
3983                 example:
3984                   meta: { lastUpdated: '2021-09-14T09:13:51' }
3985                   resourceType: Bundle
3986                   type: collection
3987                   total: 0
3988                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Device' }]
3989         '400':
3990           $ref: '#/components/responses/badrequest'
3991         '401':
3992           $ref: '#/components/responses/unauthorized'
3993       security:
3994         -
3995           openemr_auth: []
3996   '/fhir/Device/{uuid}':
3997     get:
3998       tags:
3999         - fhir
4000       description: 'Returns a single Device resource.'
4001       parameters:
4002         -
4003           name: uuid
4004           in: path
4005           description: 'The uuid for the Device resource.'
4006           required: true
4007           schema:
4008             type: string
4009       responses:
4010         '200':
4011           description: 'Standard Response'
4012           content:
4013             application/json:
4014               schema:
4015                 properties:
4016                   'json object': { description: 'FHIR Json object.', type: object }
4017                 type: object
4018                 example:
4019                   id: 946dce19-c80a-402c-862a-eadf3f2377f0
4020                   meta: { versionId: '1', lastUpdated: '2021-09-18T19:28:59+00:00' }
4021                   resourceType: Device
4022                   udiCarrier: [{ deviceIdentifier: '08717648200274', carrierHRF: '=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123' }]
4023                   distinctIdentifier: A99971312345600
4024                   manufactureDate: '2013-02-01'
4025                   expirationDate: '2014-02-01'
4026                   lotNumber: 000000000000XYZ123
4027                   serialNumber: '000025'
4028                   type: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }
4029                   patient: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4030         '400':
4031           $ref: '#/components/responses/badrequest'
4032         '401':
4033           $ref: '#/components/responses/unauthorized'
4034         '404':
4035           $ref: '#/components/responses/uuidnotfound'
4036       security:
4037         -
4038           openemr_auth: []
4039   /fhir/DiagnosticReport:
4040     get:
4041       tags:
4042         - fhir
4043       description: 'Returns a list of DiagnosticReport resources.'
4044       parameters:
4045         -
4046           name: _id
4047           in: query
4048           description: 'The uuid for the DiagnosticReport resource.'
4049           required: false
4050           schema:
4051             type: string
4052         -
4053           name: patient
4054           in: query
4055           description: 'The uuid for the patient.'
4056           required: false
4057           schema:
4058             type: string
4059         -
4060           name: code
4061           in: query
4062           description: 'The code of the DiagnosticReport resource.'
4063           required: false
4064           schema:
4065             type: string
4066         -
4067           name: category
4068           in: query
4069           description: 'The category of the DiagnosticReport resource.'
4070           required: false
4071           schema:
4072             type: string
4073         -
4074           name: date
4075           in: query
4076           description: 'The datetime of the DiagnosticReport resource.'
4077           required: false
4078           schema:
4079             type: string
4080       responses:
4081         '200':
4082           description: 'Standard Response'
4083           content:
4084             application/json:
4085               schema:
4086                 properties:
4087                   'json object': { description: 'FHIR Json object.', type: object }
4088                 type: object
4089                 example:
4090                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4091                   resourceType: Bundle
4092                   type: collection
4093                   total: 0
4094                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DiagnosticReport' }]
4095         '400':
4096           $ref: '#/components/responses/badrequest'
4097         '401':
4098           $ref: '#/components/responses/unauthorized'
4099       security:
4100         -
4101           openemr_auth: []
4102   '/fhir/DiagnosticReport/{uuid}':
4103     get:
4104       tags:
4105         - fhir
4106       description: 'Returns a single DiagnosticReport resource.'
4107       parameters:
4108         -
4109           name: uuid
4110           in: path
4111           description: 'The uuid for the DiagnosticReport resource.'
4112           required: true
4113           schema:
4114             type: string
4115       responses:
4116         '200':
4117           description: 'Standard Response'
4118           content:
4119             application/json:
4120               schema:
4121                 properties:
4122                   'json object': { description: 'FHIR Json object.', type: object }
4123                 type: object
4124                 example:
4125                   id: 93fb2d6a-77ac-48ca-a12d-1a17e40007e3
4126                   meta: { versionId: '1', lastUpdated: '2021-09-18T20:52:34+00:00' }
4127                   resourceType: DiagnosticReport
4128                   status: final
4129                   category: [{ coding: [{ system: 'http://loinc.org', code: LP7839-6, display: Pathology }] }]
4130                   code: { coding: [{ system: 'http://loinc.org', code: 11502-2, display: 'Laboratory report' }] }
4131                   subject: { reference: Patient/9353b8f5-0a87-4e2a-afd4-25341fdb0fbc, type: Patient }
4132                   encounter: { reference: Encounter/93540818-cb5f-49df-b73b-83901bb793b6, type: Encounter }
4133                   effectiveDateTime: '2015-06-22T00:00:00+00:00'
4134                   issued: '2015-06-22T00:00:00+00:00'
4135                   performer: [{ reference: Organization/935249b5-0ba6-4b5b-8863-a7a27d4c6350, type: Organization }]
4136                   presentedForm: [{ contentType: text/plain, data: TXMgQWxpY2UgTmV3bWFuIHdhcyB0ZXN0ZWQgZm9yIHRoZSBVcmluYW5hbHlzaXMgbWFjcm8gcGFuZWwgYW5kIHRoZSByZXN1bHRzIGhhdmUgYmVlbiBmb3VuZCB0byBiZSANCm5vcm1hbC4= }]
4137         '400':
4138           $ref: '#/components/responses/badrequest'
4139         '401':
4140           $ref: '#/components/responses/unauthorized'
4141         '404':
4142           $ref: '#/components/responses/uuidnotfound'
4143       security:
4144         -
4145           openemr_auth: []
4146   /fhir/DocumentReference:
4147     get:
4148       tags:
4149         - fhir
4150       description: 'Returns a list of DocumentReference resources.'
4151       parameters:
4152         -
4153           name: _id
4154           in: query
4155           description: 'The uuid for the DocumentReference resource.'
4156           required: false
4157           schema:
4158             type: string
4159         -
4160           name: patient
4161           in: query
4162           description: 'The uuid for the patient.'
4163           required: false
4164           schema:
4165             type: string
4166         -
4167           name: type
4168           in: query
4169           description: 'The type of the DocumentReference resource.'
4170           required: false
4171           schema:
4172             type: string
4173         -
4174           name: category
4175           in: query
4176           description: 'The category of the DocumentReference resource.'
4177           required: false
4178           schema:
4179             type: string
4180         -
4181           name: date
4182           in: query
4183           description: 'The datetime of the DocumentReference resource.'
4184           required: false
4185           schema:
4186             type: string
4187       responses:
4188         '200':
4189           description: 'Standard Response'
4190           content:
4191             application/json:
4192               schema:
4193                 properties:
4194                   'json object': { description: 'FHIR Json object.', type: object }
4195                 type: object
4196                 example:
4197                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4198                   resourceType: Bundle
4199                   type: collection
4200                   total: 0
4201                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/DocumentReference' }]
4202         '400':
4203           $ref: '#/components/responses/badrequest'
4204         '401':
4205           $ref: '#/components/responses/unauthorized'
4206       security:
4207         -
4208           openemr_auth: []
4209   '/fhir/DocumentReference/{uuid}':
4210     get:
4211       tags:
4212         - fhir
4213       description: 'Returns a single DocumentReference resource.'
4214       parameters:
4215         -
4216           name: uuid
4217           in: path
4218           description: 'The uuid for the DocumentReference resource.'
4219           required: true
4220           schema:
4221             type: string
4222       responses:
4223         '200':
4224           description: 'Standard Response'
4225           content:
4226             application/json:
4227               schema:
4228                 properties:
4229                   'json object': { description: 'FHIR Json object.', type: object }
4230                 type: object
4231                 example:
4232                   id: 946e7553-1aaa-49f8-8f81-ae15ccaa9165
4233                   meta: { versionId: '1', lastUpdated: '2021-09-19T03:17:51+00:00' }
4234                   resourceType: DocumentReference
4235                   identifier: [{ value: 946e7553-1aaa-49f8-8f81-ae15ccaa9165 }]
4236                   status: current
4237                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: unknown }] }
4238                   category: [{ coding: [{ system: 'https://localhost:9300/apis/default/fhir/ValueSet/openemr-document-types', code: openemr-document, display: 'OpenEMR Document' }] }]
4239                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4240                   date: '2021-09-19T03:15:56+00:00'
4241                   author: [null]
4242                   content: [{ attachment: { contentType: image/gif, url: 'https://localhost:9300/apis/default/fhir/Document/7/Binary' }, format: { system: 'http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem', code: 'urn:ihe:iti:xds:2017:mimeTypeSufficient', display: 'mimeType Sufficient' } }]
4243         '400':
4244           $ref: '#/components/responses/badrequest'
4245         '401':
4246           $ref: '#/components/responses/unauthorized'
4247         '404':
4248           $ref: '#/components/responses/uuidnotfound'
4249       security:
4250         -
4251           openemr_auth: []
4252   '/fhir/Document/{id}/Binary':
4253     get:
4254       tags:
4255         - fhir
4256       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>'
4257       parameters:
4258         -
4259           name: id
4260           in: path
4261           description: 'The id for the Document.'
4262           required: true
4263           schema:
4264             type: string
4265       responses:
4266         '200':
4267           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>'
4268         '400':
4269           $ref: '#/components/responses/badrequest'
4270         '401':
4271           $ref: '#/components/responses/unauthorized'
4272       security:
4273         -
4274           openemr_auth: []
4275   /fhir/Encounter:
4276     get:
4277       tags:
4278         - fhir
4279       description: 'Returns a list of Encounter resources.'
4280       parameters:
4281         -
4282           name: _id
4283           in: query
4284           description: 'The uuid for the Encounter resource.'
4285           required: false
4286           schema:
4287             type: string
4288         -
4289           name: patient
4290           in: query
4291           description: 'The uuid for the patient.'
4292           required: false
4293           schema:
4294             type: string
4295         -
4296           name: date
4297           in: query
4298           description: 'The datetime of the Encounter resource.'
4299           required: false
4300           schema:
4301             type: string
4302       responses:
4303         '200':
4304           description: 'Standard Response'
4305           content:
4306             application/json:
4307               schema:
4308                 properties:
4309                   'json object': { description: 'FHIR Json object.', type: object }
4310                 type: object
4311                 example:
4312                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4313                   resourceType: Bundle
4314                   type: collection
4315                   total: 0
4316                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Encounter' }]
4317         '400':
4318           $ref: '#/components/responses/badrequest'
4319         '401':
4320           $ref: '#/components/responses/unauthorized'
4321       security:
4322         -
4323           openemr_auth: []
4324   '/fhir/Encounter/{uuid}':
4325     get:
4326       tags:
4327         - fhir
4328       description: 'Returns a single Encounter resource.'
4329       parameters:
4330         -
4331           name: uuid
4332           in: path
4333           description: 'The uuid for the Encounter resource.'
4334           required: true
4335           schema:
4336             type: string
4337       responses:
4338         '200':
4339           description: 'Standard Response'
4340           content:
4341             application/json:
4342               schema:
4343                 properties:
4344                   'json object': { description: 'FHIR Json object.', type: object }
4345                 type: object
4346                 example:
4347                   id: 946da61d-6b95-4f8e-abe5-534a25913b71
4348                   meta: { versionId: '1', lastUpdated: '2021-09-19T06:27:41+00:00' }
4349                   resourceType: Encounter
4350                   identifier: [{ system: 'urn:ietf:rfc:3986', value: 946da61d-6b95-4f8e-abe5-534a25913b71 }]
4351                   status: finished
4352                   class: { system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode', code: AMB, display: ambulatory }
4353                   type: [{ coding: [{ system: 'http://snomed.info/sct', code: '185349003', display: 'Encounter for check up (procedure)' }] }]
4354                   subject: { reference: Patient/946da61b-626b-4f88-81e2-adfb88f4f0fe, type: Patient }
4355                   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 } }]
4356                   period: { start: '2012-08-13T00:00:00+00:00' }
4357         '400':
4358           $ref: '#/components/responses/badrequest'
4359         '401':
4360           $ref: '#/components/responses/unauthorized'
4361         '404':
4362           $ref: '#/components/responses/uuidnotfound'
4363       security:
4364         -
4365           openemr_auth: []
4366   /fhir/Goal:
4367     get:
4368       tags:
4369         - fhir
4370       description: 'Returns a list of Condition resources.'
4371       parameters:
4372         -
4373           name: _id
4374           in: query
4375           description: 'The uuid for the Goal resource.'
4376           required: false
4377           schema:
4378             type: string
4379         -
4380           name: patient
4381           in: query
4382           description: 'The uuid for the patient.'
4383           required: false
4384           schema:
4385             type: string
4386       responses:
4387         '200':
4388           description: 'Standard Response'
4389           content:
4390             application/json:
4391               schema:
4392                 properties:
4393                   'json object': { description: 'FHIR Json object.', type: object }
4394                 type: object
4395                 example:
4396                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4397                   resourceType: Bundle
4398                   type: collection
4399                   total: 0
4400                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Goal' }]
4401         '400':
4402           $ref: '#/components/responses/badrequest'
4403         '401':
4404           $ref: '#/components/responses/unauthorized'
4405       security:
4406         -
4407           openemr_auth: []
4408   '/fhir/Goal/{uuid}':
4409     get:
4410       tags:
4411         - fhir
4412       description: 'Returns a single Goal resource.'
4413       parameters:
4414         -
4415           name: uuid
4416           in: path
4417           description: 'The uuid for the Goal resource.'
4418           required: true
4419           schema:
4420             type: string
4421       responses:
4422         '200':
4423           description: 'Standard Response'
4424           content:
4425             application/json:
4426               schema:
4427                 properties:
4428                   'json object': { description: 'FHIR Json object.', type: object }
4429                 type: object
4430                 example:
4431                   id: 946da61d-6b88-4d54-bdd6-4029e2ad9e3f_1
4432                   meta: { versionId: '1', lastUpdated: '2021-09-19T06:45:58+00:00' }
4433                   resourceType: Goal
4434                   lifecycleStatus: active
4435                   description: { text: 'Eating more vegetables.' }
4436                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4437                   target: [{ measure: { extension: [{ valueCode: unknown, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason' }] }, detailString: 'Eating more vegetables.', dueDate: '2021-09-09' }]
4438         '400':
4439           $ref: '#/components/responses/badrequest'
4440         '401':
4441           $ref: '#/components/responses/unauthorized'
4442         '404':
4443           $ref: '#/components/responses/uuidnotfound'
4444       security:
4445         -
4446           openemr_auth: []
4447   /fhir/Group:
4448     get:
4449       tags:
4450         - fhir
4451       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>'
4452       parameters:
4453         -
4454           name: _id
4455           in: query
4456           description: 'The uuid for the Group resource.'
4457           required: false
4458           schema:
4459             type: string
4460         -
4461           name: patient
4462           in: query
4463           description: 'The uuid for the patient.'
4464           required: false
4465           schema:
4466             type: string
4467       responses:
4468         '200':
4469           description: 'Standard Response'
4470           content:
4471             application/json:
4472               schema:
4473                 properties:
4474                   'json object': { description: 'FHIR Json object.', type: object }
4475                 type: object
4476                 example:
4477                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4478                   resourceType: Bundle
4479                   type: collection
4480                   total: 0
4481                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Group' }]
4482         '400':
4483           $ref: '#/components/responses/badrequest'
4484         '401':
4485           $ref: '#/components/responses/unauthorized'
4486       security:
4487         -
4488           openemr_auth: []
4489   '/fhir/Group/{uuid}':
4490     get:
4491       tags:
4492         - fhir
4493       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>'
4494       parameters:
4495         -
4496           name: uuid
4497           in: path
4498           description: 'The uuid for the Group resource.'
4499           required: true
4500           schema:
4501             type: string
4502       responses:
4503         '200':
4504           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>'
4505         '400':
4506           $ref: '#/components/responses/badrequest'
4507         '401':
4508           $ref: '#/components/responses/unauthorized'
4509         '404':
4510           $ref: '#/components/responses/uuidnotfound'
4511       security:
4512         -
4513           openemr_auth: []
4514   '/fhir/Group/{id}/$export':
4515     get:
4516       tags:
4517         - fhir
4518       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>'
4519       responses:
4520         '200':
4521           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>'
4522         '400':
4523           $ref: '#/components/responses/badrequest'
4524         '401':
4525           $ref: '#/components/responses/unauthorized'
4526       security:
4527         -
4528           openemr_auth: []
4529   /fhir/Immunization:
4530     get:
4531       tags:
4532         - fhir
4533       description: 'Returns a list of Immunization resources.'
4534       parameters:
4535         -
4536           name: _id
4537           in: query
4538           description: 'The uuid for the Immunization resource.'
4539           required: false
4540           schema:
4541             type: string
4542         -
4543           name: patient
4544           in: query
4545           description: 'The uuid for the patient.'
4546           required: false
4547           schema:
4548             type: string
4549       responses:
4550         '200':
4551           description: 'Standard Response'
4552           content:
4553             application/json:
4554               schema:
4555                 properties:
4556                   'json object': { description: 'FHIR Json object.', type: object }
4557                 type: object
4558                 example:
4559                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4560                   resourceType: Bundle
4561                   type: collection
4562                   total: 0
4563                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Immunization' }]
4564         '400':
4565           $ref: '#/components/responses/badrequest'
4566         '401':
4567           $ref: '#/components/responses/unauthorized'
4568       security:
4569         -
4570           openemr_auth: []
4571   '/fhir/Immunization/{uuid}':
4572     get:
4573       tags:
4574         - fhir
4575       description: 'Returns a single Immunization resource.'
4576       parameters:
4577         -
4578           name: uuid
4579           in: path
4580           description: 'The uuid for the Immunization resource.'
4581           required: true
4582           schema:
4583             type: string
4584       responses:
4585         '200':
4586           description: 'Standard Response'
4587           content:
4588             application/json:
4589               schema:
4590                 properties:
4591                   'json object': { description: 'FHIR Json object.', type: object }
4592                 type: object
4593                 example:
4594                   id: 95e8d8b7-e3e2-4e03-8eb1-31e1d9097d8f
4595                   meta: { versionId: '1', lastUpdated: '2022-03-26T05:42:59+00:00' }
4596                   resourceType: Immunization
4597                   status: completed
4598                   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' }] }
4599                   patient: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf }
4600                   occurrenceDateTime: '2022-03-26T05:35:00+00:00'
4601                   recorded: '2022-03-26T05:42:26+00:00'
4602                   primarySource: false
4603         '400':
4604           $ref: '#/components/responses/badrequest'
4605         '401':
4606           $ref: '#/components/responses/unauthorized'
4607         '404':
4608           $ref: '#/components/responses/uuidnotfound'
4609       security:
4610         -
4611           openemr_auth: []
4612   /fhir/Location:
4613     get:
4614       tags:
4615         - fhir
4616       description: 'Returns a list of Location resources.'
4617       parameters:
4618         -
4619           name: _id
4620           in: query
4621           description: 'The uuid for the Location resource.'
4622           required: false
4623           schema:
4624             type: string
4625       responses:
4626         '200':
4627           description: 'Standard Response'
4628           content:
4629             application/json:
4630               schema:
4631                 properties:
4632                   'json object': { description: 'FHIR Json object.', type: object }
4633                 type: object
4634                 example:
4635                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4636                   resourceType: Bundle
4637                   type: collection
4638                   total: 0
4639                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Location' }]
4640         '400':
4641           $ref: '#/components/responses/badrequest'
4642         '401':
4643           $ref: '#/components/responses/unauthorized'
4644       security:
4645         -
4646           openemr_auth: []
4647   '/fhir/Location/{uuid}':
4648     get:
4649       tags:
4650         - fhir
4651       description: 'Returns a single Location resource.'
4652       parameters:
4653         -
4654           name: uuid
4655           in: path
4656           description: 'The uuid for the Location resource.'
4657           required: true
4658           schema:
4659             type: string
4660       responses:
4661         '200':
4662           description: 'Standard Response'
4663           content:
4664             application/json:
4665               schema:
4666                 properties:
4667                   'json object': { description: 'FHIR Json object.', type: object }
4668                 type: object
4669                 example:
4670                   id: 946da61d-c4f2-4f03-a2a7-b571f6a24b65
4671                   meta: { versionId: '1', lastUpdated: '2021-09-19T08:14:58+00:00' }
4672                   resourceType: Location
4673                   status: active
4674                   name: 'Your Clinic Name Here'
4675                   telecom: [{ system: phone, value: 000-000-0000 }, { system: fax, value: 000-000-0000 }]
4676         '400':
4677           $ref: '#/components/responses/badrequest'
4678         '401':
4679           $ref: '#/components/responses/unauthorized'
4680         '404':
4681           $ref: '#/components/responses/uuidnotfound'
4682       security:
4683         -
4684           openemr_auth: []
4685   /fhir/MedicationRequest:
4686     get:
4687       tags:
4688         - fhir
4689       description: 'Returns a list of MedicationRequest resources.'
4690       parameters:
4691         -
4692           name: _id
4693           in: query
4694           description: 'The uuid for the MedicationRequest resource.'
4695           required: false
4696           schema:
4697             type: string
4698         -
4699           name: patient
4700           in: query
4701           description: 'The uuid for the patient.'
4702           required: false
4703           schema:
4704             type: string
4705         -
4706           name: intent
4707           in: query
4708           description: 'The intent of the MedicationRequest resource.'
4709           required: false
4710           schema:
4711             type: string
4712         -
4713           name: status
4714           in: query
4715           description: 'The status of the MedicationRequest resource.'
4716           required: false
4717           schema:
4718             type: string
4719       responses:
4720         '200':
4721           description: 'Standard Response'
4722           content:
4723             application/json:
4724               schema:
4725                 properties:
4726                   'json object': { description: 'FHIR Json object.', type: object }
4727                 type: object
4728                 example:
4729                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4730                   resourceType: Bundle
4731                   type: collection
4732                   total: 0
4733                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/MedicationRequest' }]
4734         '400':
4735           $ref: '#/components/responses/badrequest'
4736         '401':
4737           $ref: '#/components/responses/unauthorized'
4738       security:
4739         -
4740           openemr_auth: []
4741   '/fhir/MedicationRequest/{uuid}':
4742     get:
4743       tags:
4744         - fhir
4745       description: 'Returns a single MedicationRequest resource.'
4746       parameters:
4747         -
4748           name: uuid
4749           in: path
4750           description: 'The uuid for the MedicationRequest resource.'
4751           required: true
4752           schema:
4753             type: string
4754       responses:
4755         '200':
4756           description: 'Standard Response'
4757           content:
4758             application/json:
4759               schema:
4760                 properties:
4761                   'json object': { description: 'FHIR Json object.', type: object }
4762                 type: object
4763                 example:
4764                   id: 946da61d-9cff-4416-8d27-805f19f9d7d8
4765                   meta: { versionId: '1', lastUpdated: '2021-09-20T04:03:14+00:00' }
4766                   resourceType: MedicationRequest
4767                   status: active
4768                   intent: order
4769                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/medicationrequest-category', code: community, display: Home/Community }] }]
4770                   reportedBoolean: false
4771                   medicationCodeableConcept: { coding: [{ system: 'http://www.nlm.nih.gov/research/umls/rxnorm', code: '1738139', display: 'Acetaminophen 325 MG Oral Tablet' }] }
4772                   subject: { reference: Patient/946da617-1a4a-4b2c-ae66-93b84377cb1e, type: Patient }
4773                   authoredOn: '2021-09-18T00:00:00+00:00'
4774                   requester: { reference: Practitioner/946da61d-ac5f-4fdc-b3f2-7b58dc49976b, type: Practitioner }
4775         '400':
4776           $ref: '#/components/responses/badrequest'
4777         '401':
4778           $ref: '#/components/responses/unauthorized'
4779         '404':
4780           $ref: '#/components/responses/uuidnotfound'
4781       security:
4782         -
4783           openemr_auth: []
4784   /fhir/Observation:
4785     get:
4786       tags:
4787         - fhir
4788       description: 'Returns a list of Observation resources.'
4789       parameters:
4790         -
4791           name: _id
4792           in: query
4793           description: 'The uuid for the Observation resource.'
4794           required: false
4795           schema:
4796             type: string
4797         -
4798           name: patient
4799           in: query
4800           description: 'The uuid for the patient.'
4801           required: false
4802           schema:
4803             type: string
4804         -
4805           name: code
4806           in: query
4807           description: 'The code of the Observation resource.'
4808           required: false
4809           schema:
4810             type: string
4811         -
4812           name: category
4813           in: query
4814           description: 'The category of the Observation resource.'
4815           required: false
4816           schema:
4817             type: string
4818         -
4819           name: date
4820           in: query
4821           description: 'The datetime of the Observation resource.'
4822           required: false
4823           schema:
4824             type: string
4825       responses:
4826         '200':
4827           description: 'Standard Response'
4828           content:
4829             application/json:
4830               schema:
4831                 properties:
4832                   'json object': { description: 'FHIR Json object.', type: object }
4833                 type: object
4834                 example:
4835                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4836                   resourceType: Bundle
4837                   type: collection
4838                   total: 0
4839                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Observation' }]
4840         '400':
4841           $ref: '#/components/responses/badrequest'
4842         '401':
4843           $ref: '#/components/responses/unauthorized'
4844       security:
4845         -
4846           openemr_auth: []
4847   '/fhir/Observation/{uuid}':
4848     get:
4849       tags:
4850         - fhir
4851       description: 'Returns a single Observation resource.'
4852       parameters:
4853         -
4854           name: uuid
4855           in: path
4856           description: 'The uuid for the Observation resource.'
4857           required: true
4858           schema:
4859             type: string
4860       responses:
4861         '200':
4862           description: 'Standard Response'
4863           content:
4864             application/json:
4865               schema:
4866                 properties:
4867                   'json object': { description: 'FHIR Json object.', type: object }
4868                 type: object
4869                 example:
4870                   id: 946da61e-0597-485e-9dfd-a87205ea56b3
4871                   meta: { versionId: '1', lastUpdated: '2021-09-20T04:12:16+00:00' }
4872                   resourceType: Observation
4873                   status: final
4874                   category: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/observation-category', code: vital-signs }] }]
4875                   code: { coding: [{ system: 'http://loinc.org', code: 85354-9, display: 'Blood pressure systolic and diastolic' }] }
4876                   subject: { reference: Patient/946da619-c631-431a-a282-487cd6fb7802, type: Patient }
4877                   effectiveDateTime: '2015-08-31T00:00:00+00:00'
4878                   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]' } }]
4879         '400':
4880           $ref: '#/components/responses/badrequest'
4881         '401':
4882           $ref: '#/components/responses/unauthorized'
4883         '404':
4884           $ref: '#/components/responses/uuidnotfound'
4885       security:
4886         -
4887           openemr_auth: []
4888   /fhir/Organization:
4889     get:
4890       tags:
4891         - fhir
4892       description: 'Returns a list of Organization resources.'
4893       parameters:
4894         -
4895           name: _id
4896           in: query
4897           description: 'The uuid for the Organization resource.'
4898           required: false
4899           schema:
4900             type: string
4901         -
4902           name: name
4903           in: query
4904           description: 'The name of the Organization resource.'
4905           required: false
4906           schema:
4907             type: string
4908         -
4909           name: email
4910           in: query
4911           description: 'The email of the Organization resource.'
4912           required: false
4913           schema:
4914             type: string
4915         -
4916           name: phone
4917           in: query
4918           description: 'The phone of the Organization resource.'
4919           required: false
4920           schema:
4921             type: string
4922         -
4923           name: telecom
4924           in: query
4925           description: 'The telecom of the Organization resource.'
4926           required: false
4927           schema:
4928             type: string
4929         -
4930           name: address
4931           in: query
4932           description: 'The address of the Organization resource.'
4933           required: false
4934           schema:
4935             type: string
4936         -
4937           name: address-city
4938           in: query
4939           description: 'The address-city of the Organization resource.'
4940           required: false
4941           schema:
4942             type: string
4943         -
4944           name: address-postalcode
4945           in: query
4946           description: 'The address-postalcode of the Organization resource.'
4947           required: false
4948           schema:
4949             type: string
4950         -
4951           name: address-state
4952           in: query
4953           description: 'The address-state of the Organization resource.'
4954           required: false
4955           schema:
4956             type: string
4957       responses:
4958         '200':
4959           description: 'Standard Response'
4960           content:
4961             application/json:
4962               schema:
4963                 properties:
4964                   'json object': { description: 'FHIR Json object.', type: object }
4965                 type: object
4966                 example:
4967                   meta: { lastUpdated: '2021-09-14T09:13:51' }
4968                   resourceType: Bundle
4969                   type: collection
4970                   total: 0
4971                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Organization' }]
4972         '400':
4973           $ref: '#/components/responses/badrequest'
4974         '401':
4975           $ref: '#/components/responses/unauthorized'
4976       security:
4977         -
4978           openemr_auth: []
4979     post:
4980       tags:
4981         - fhir
4982       description: 'Adds a Organization resource.'
4983       requestBody:
4984         required: true
4985         content:
4986           application/json:
4987             schema:
4988               description: 'The json object for the Organization resource.'
4989               type: object
4990             example:
4991               id: 95f0e672-be37-4c73-95c9-649c2d200018
4992               meta:
4993                 versionId: '1'
4994                 lastUpdated: '2022-03-30T07:43:23+00:00'
4995               resourceType: Organization
4996               text:
4997                 status: generated
4998                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
4999               identifier:
5000                 -
5001                   system: 'http://hl7.org/fhir/sid/us-npi'
5002                   value: '1234567890'
5003               active: true
5004               type:
5005                 -
5006                   coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5007               name: 'Your Clinic Name Here Hey'
5008               telecom:
5009                 -
5010                   system: phone
5011                   value: 000-000-0000
5012                   use: work
5013                 -
5014                   system: fax
5015                   value: 000-000-0000
5016                   use: work
5017               address:
5018                 - null
5019       responses:
5020         '200':
5021           description: 'Standard Response'
5022           content:
5023             application/json:
5024               schema:
5025                 properties:
5026                   'json object': { description: 'FHIR Json object.', type: object }
5027                 type: object
5028                 example:
5029                   id: 95f0e672-be37-4c73-95c9-649c2d200018
5030                   meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5031                   resourceType: Organization
5032                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5033                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5034                   active: true
5035                   type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5036                   name: 'Your Clinic Name Here Now'
5037                   telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5038                   address: [null]
5039         '400':
5040           $ref: '#/components/responses/badrequest'
5041         '401':
5042           $ref: '#/components/responses/unauthorized'
5043       security:
5044         -
5045           openemr_auth: []
5046   '/fhir/Organization/{uuid}':
5047     get:
5048       tags:
5049         - fhir
5050       description: 'Returns a single Organization resource.'
5051       parameters:
5052         -
5053           name: uuid
5054           in: path
5055           description: 'The uuid for the Organization resource.'
5056           required: true
5057           schema:
5058             type: string
5059       responses:
5060         '200':
5061           description: 'Standard Response'
5062           content:
5063             application/json:
5064               schema:
5065                 properties:
5066                   'json object': { description: 'FHIR Json object.', type: object }
5067                 type: object
5068                 example:
5069                   id: 95f0e672-be37-4c73-95c9-649c2d200018
5070                   meta: { versionId: '1', lastUpdated: '2022-03-30T07:43:23+00:00' }
5071                   resourceType: Organization
5072                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>' }
5073                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '1234567890' }]
5074                   active: true
5075                   type: [{ coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }] }]
5076                   name: 'Your Clinic Name Here'
5077                   telecom: [{ system: phone, value: 000-000-0000, use: work }, { system: fax, value: 000-000-0000, use: work }]
5078                   address: [null]
5079         '400':
5080           $ref: '#/components/responses/badrequest'
5081         '401':
5082           $ref: '#/components/responses/unauthorized'
5083         '404':
5084           $ref: '#/components/responses/uuidnotfound'
5085       security:
5086         -
5087           openemr_auth: []
5088     put:
5089       tags:
5090         - fhir
5091       description: 'Modifies a Organization resource.'
5092       parameters:
5093         -
5094           name: uuid
5095           in: path
5096           description: 'The uuid for the organization.'
5097           required: true
5098           schema:
5099             type: string
5100       requestBody:
5101         required: true
5102         content:
5103           application/json:
5104             schema:
5105               description: 'The json object for the Organization resource.'
5106               type: object
5107             example:
5108               id: 95f0e672-be37-4c73-95c9-649c2d200018
5109               meta:
5110                 versionId: '1'
5111                 lastUpdated: '2022-03-30T07:43:23+00:00'
5112               resourceType: Organization
5113               text:
5114                 status: generated
5115                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Your Clinic Name Here</p></div>'
5116               identifier:
5117                 -
5118                   system: 'http://hl7.org/fhir/sid/us-npi'
5119                   value: '1234567890'
5120               active: true
5121               type:
5122                 -
5123                   coding: [{ system: 'http://terminology.hl7.org/CodeSystem/organization-type', code: prov, display: 'Healthcare Provider' }]
5124               name: 'Your Clinic Name Here'
5125               telecom:
5126                 -
5127                   system: phone
5128                   value: 000-000-0000
5129                   use: work
5130                 -
5131                   system: fax
5132                   value: 000-000-0000
5133                   use: work
5134               address:
5135                 - null
5136       responses:
5137         '201':
5138           description: 'Standard Response'
5139           content:
5140             application/json:
5141               schema:
5142                 example:
5143                   id: 14
5144                   uuid: 95f217c1-258c-44ca-bf11-909dce369574
5145         '400':
5146           $ref: '#/components/responses/badrequest'
5147         '401':
5148           $ref: '#/components/responses/unauthorized'
5149       security:
5150         -
5151           openemr_auth: []
5152   /fhir/Patient:
5153     get:
5154       tags:
5155         - fhir
5156       description: 'Returns a list of Patient resources.'
5157       parameters:
5158         -
5159           name: _id
5160           in: query
5161           description: 'The uuid for the Patient resource.'
5162           required: false
5163           schema:
5164             type: string
5165         -
5166           name: identifier
5167           in: query
5168           description: 'The identifier of the Patient resource.'
5169           required: false
5170           schema:
5171             type: string
5172         -
5173           name: name
5174           in: query
5175           description: 'The name of the Patient resource.'
5176           required: false
5177           schema:
5178             type: string
5179         -
5180           name: birthdate
5181           in: query
5182           description: 'The birthdate of the Patient resource.'
5183           required: false
5184           schema:
5185             type: string
5186         -
5187           name: gender
5188           in: query
5189           description: 'The gender of the Patient resource.'
5190           required: false
5191           schema:
5192             type: string
5193         -
5194           name: address
5195           in: query
5196           description: 'The address of the Patient resource.'
5197           required: false
5198           schema:
5199             type: string
5200         -
5201           name: address-city
5202           in: query
5203           description: 'The address-city of the Patient resource.'
5204           required: false
5205           schema:
5206             type: string
5207         -
5208           name: address-postalcode
5209           in: query
5210           description: 'The address-postalcode of the Patient resource.'
5211           required: false
5212           schema:
5213             type: string
5214         -
5215           name: address-state
5216           in: query
5217           description: 'The address-state of the Patient resource.'
5218           required: false
5219           schema:
5220             type: string
5221         -
5222           name: email
5223           in: query
5224           description: 'The email of the Patient resource.'
5225           required: false
5226           schema:
5227             type: string
5228         -
5229           name: family
5230           in: query
5231           description: 'The family name of the Patient resource.'
5232           required: false
5233           schema:
5234             type: string
5235         -
5236           name: given
5237           in: query
5238           description: 'The given name of the Patient resource.'
5239           required: false
5240           schema:
5241             type: string
5242         -
5243           name: phone
5244           in: query
5245           description: 'The phone number of the Patient resource.'
5246           required: false
5247           schema:
5248             type: string
5249         -
5250           name: telecom
5251           in: query
5252           description: 'The fax number of the Patient resource.'
5253           required: false
5254           schema:
5255             type: string
5256       responses:
5257         '200':
5258           description: 'Standard Response'
5259           content:
5260             application/json:
5261               schema:
5262                 properties:
5263                   'json object': { description: 'FHIR Json object.', type: object }
5264                 type: object
5265                 example:
5266                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5267                   resourceType: Bundle
5268                   type: collection
5269                   total: 0
5270                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Patient' }]
5271         '400':
5272           $ref: '#/components/responses/badrequest'
5273         '401':
5274           $ref: '#/components/responses/unauthorized'
5275       security:
5276         -
5277           openemr_auth: []
5278     post:
5279       tags:
5280         - fhir
5281       description: 'Adds a Patient resource.'
5282       requestBody:
5283         required: true
5284         content:
5285           application/json:
5286             schema:
5287               description: 'The json object for the Patient resource.'
5288               type: object
5289             example:
5290               id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5291               meta:
5292                 versionId: '1'
5293                 lastUpdated: '2022-03-31T02:48:28+00:00'
5294               resourceType: Patient
5295               text:
5296                 status: generated
5297                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5298               extension:
5299                 -
5300                   valueCode: F
5301                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5302                 -
5303                   extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5304                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5305               identifier:
5306                 -
5307                   use: official
5308                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5309                   system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5310                   value: '1'
5311               active: true
5312               name:
5313                 -
5314                   use: official
5315                   family: Smith
5316                   given: [Brenda]
5317               gender: female
5318               birthDate: '2017-03-10'
5319               communication:
5320                 -
5321                   language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5322       responses:
5323         '200':
5324           description: 'Standard Response'
5325           content:
5326             application/json:
5327               schema:
5328                 properties:
5329                   'json object': { description: 'FHIR Json object.', type: object }
5330                 type: object
5331                 example:
5332                   id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5333                   meta: { versionId: '1', lastUpdated: '2022-03-31T02:48:28+00:00' }
5334                   resourceType: Patient
5335                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>' }
5336                   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' }]
5337                   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' }]
5338                   active: true
5339                   name: [{ use: official, family: Smith, given: [Brenda] }]
5340                   gender: female
5341                   birthDate: '2017-03-10'
5342                   communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5343         '400':
5344           $ref: '#/components/responses/badrequest'
5345         '401':
5346           $ref: '#/components/responses/unauthorized'
5347       security:
5348         -
5349           openemr_auth: []
5350   '/fhir/Patient/{uuid}':
5351     get:
5352       tags:
5353         - fhir
5354       description: 'Returns a single Patient resource.'
5355       parameters:
5356         -
5357           name: uuid
5358           in: path
5359           description: 'The uuid for the Patient resource.'
5360           required: true
5361           schema:
5362             type: string
5363       responses:
5364         '200':
5365           description: 'Standard Response'
5366           content:
5367             application/json:
5368               schema:
5369                 properties:
5370                   'json object': { description: 'FHIR Json object.', type: object }
5371                 type: object
5372                 example:
5373                   id: 946da617-1a4a-4b2c-ae66-93b84377cb1e
5374                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:08:03+00:00' }
5375                   resourceType: Patient
5376                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Aurore252 Von197</p></div>' }
5377                   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' }]
5378                   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' }]
5379                   active: true
5380                   name: [{ use: official, family: Von197, given: [Aurore252] }]
5381                   gender: female
5382                   birthDate: '1970-07-03'
5383                   address: [{ line: ['245 Crona Wall'], city: Boston, state: Massachusetts, postalCode: '02215', period: { start: '2020-09-21T17:08:03.532+00:00' } }]
5384                   communication: [{ language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] } }]
5385         '400':
5386           $ref: '#/components/responses/badrequest'
5387         '401':
5388           $ref: '#/components/responses/unauthorized'
5389         '404':
5390           $ref: '#/components/responses/uuidnotfound'
5391       security:
5392         -
5393           openemr_auth: []
5394     put:
5395       tags:
5396         - fhir
5397       description: 'Modifies a Patient resource.'
5398       parameters:
5399         -
5400           name: uuid
5401           in: path
5402           description: 'The uuid for the Patient resource.'
5403           required: true
5404           schema:
5405             type: string
5406       requestBody:
5407         required: true
5408         content:
5409           application/json:
5410             schema:
5411               description: 'The json object for the Patient resource.'
5412               type: object
5413             example:
5414               id: 95f22ff4-dd25-4290-8b52-1dd2fedf8e54
5415               meta:
5416                 versionId: '1'
5417                 lastUpdated: '2022-03-31T02:48:28+00:00'
5418               resourceType: Patient
5419               text:
5420                 status: generated
5421                 div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Brenda Smith</p></div>'
5422               extension:
5423                 -
5424                   valueCode: F
5425                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex'
5426                 -
5427                   extension: [{ valueCoding: { system: 'http://terminology.hl7.org/CodeSystem/v3-NullFlavor', code: UNK, display: Unknown }, url: ombCategory }, { valueString: Unknown, url: text }]
5428                   url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-race'
5429               identifier:
5430                 -
5431                   use: official
5432                   type: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/v2-0203', code: PT }] }
5433                   system: 'http://terminology.hl7.org/CodeSystem/v2-0203'
5434                   value: '1'
5435               active: true
5436               name:
5437                 -
5438                   use: official
5439                   family: Smith
5440                   given: [Brenda]
5441               gender: female
5442               birthDate: '2017-03-10'
5443               communication:
5444                 -
5445                   language: { coding: [{ system: 'http://terminology.hl7.org/CodeSystem/data-absent-reason', code: unknown, display: Unknown }] }
5446       responses:
5447         '201':
5448           description: 'Standard Response'
5449           content:
5450             application/json:
5451               schema:
5452                 example:
5453                   id: 2
5454                   uuid: 95f2ad04-5834-4243-8838-e396a7faadbf
5455         '400':
5456           $ref: '#/components/responses/badrequest'
5457         '401':
5458           $ref: '#/components/responses/unauthorized'
5459       security:
5460         -
5461           openemr_auth: []
5462   /fhir/Patient/$export:
5463     get:
5464       tags:
5465         - fhir
5466       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>'
5467       responses:
5468         '200':
5469           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>'
5470         '400':
5471           $ref: '#/components/responses/badrequest'
5472         '401':
5473           $ref: '#/components/responses/unauthorized'
5474       security:
5475         -
5476           openemr_auth: []
5477   /fhir/Person:
5478     get:
5479       tags:
5480         - fhir
5481       description: 'Returns a list of Person resources.'
5482       parameters:
5483         -
5484           name: name
5485           in: query
5486           description: 'The name of the Person resource.'
5487           required: false
5488           schema:
5489             type: string
5490         -
5491           name: active
5492           in: query
5493           description: 'The active status of the Person resource.'
5494           required: false
5495           schema:
5496             type: string
5497         -
5498           name: address
5499           in: query
5500           description: 'The address of the Person resource.'
5501           required: false
5502           schema:
5503             type: string
5504         -
5505           name: address-city
5506           in: query
5507           description: 'The address-city of the Person resource.'
5508           required: false
5509           schema:
5510             type: string
5511         -
5512           name: address-postalcode
5513           in: query
5514           description: 'The address-postalcode of the Person resource.'
5515           required: false
5516           schema:
5517             type: string
5518         -
5519           name: address-state
5520           in: query
5521           description: 'The address-state of the Person resource.'
5522           required: false
5523           schema:
5524             type: string
5525         -
5526           name: email
5527           in: query
5528           description: 'The email of the Person resource.'
5529           required: false
5530           schema:
5531             type: string
5532         -
5533           name: family
5534           in: query
5535           description: 'The family name of the Person resource.'
5536           required: false
5537           schema:
5538             type: string
5539         -
5540           name: given
5541           in: query
5542           description: 'The given name of the Person resource.'
5543           required: false
5544           schema:
5545             type: string
5546         -
5547           name: phone
5548           in: query
5549           description: 'The phone number of the Person resource.'
5550           required: false
5551           schema:
5552             type: string
5553         -
5554           name: telecom
5555           in: query
5556           description: 'The fax number of the Person resource.'
5557           required: false
5558           schema:
5559             type: string
5560       responses:
5561         '200':
5562           description: 'Standard Response'
5563           content:
5564             application/json:
5565               schema:
5566                 properties:
5567                   'json object': { description: 'FHIR Json object.', type: object }
5568                 type: object
5569                 example:
5570                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5571                   resourceType: Bundle
5572                   type: collection
5573                   total: 0
5574                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Person' }]
5575         '400':
5576           $ref: '#/components/responses/badrequest'
5577         '401':
5578           $ref: '#/components/responses/unauthorized'
5579       security:
5580         -
5581           openemr_auth: []
5582   '/fhir/Person/{uuid}':
5583     get:
5584       tags:
5585         - fhir
5586       description: 'Returns a single Person resource.'
5587       parameters:
5588         -
5589           name: uuid
5590           in: path
5591           description: 'The uuid for the Person resource.'
5592           required: true
5593           schema:
5594             type: string
5595       responses:
5596         '200':
5597           description: 'Standard Response'
5598           content:
5599             application/json:
5600               schema:
5601                 properties:
5602                   'json object': { description: 'FHIR Json object.', type: object }
5603                 type: object
5604                 example:
5605                   id: 960c7cd6-187a-4119-8cd4-85389d80efb9
5606                   meta: { versionId: '1', lastUpdated: '2022-04-13T08:57:32+00:00' }
5607                   resourceType: Person
5608                   text: { status: generated, div: '<div xmlns=''http://www.w3.org/1999/xhtml''> <p>Administrator Administrator</p></div>' }
5609                   name: [{ use: official, family: Administrator, given: [Administrator, Larry] }]
5610                   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 }]
5611                   address: [{ line: ['123 Lane Street'], city: Bellevue, state: WA, period: { start: '2021-04-13T08:57:32.146+00:00' } }]
5612                   active: true
5613         '400':
5614           $ref: '#/components/responses/badrequest'
5615         '401':
5616           $ref: '#/components/responses/unauthorized'
5617         '404':
5618           $ref: '#/components/responses/uuidnotfound'
5619       security:
5620         -
5621           openemr_auth: []
5622   /fhir/Practitioner:
5623     get:
5624       tags:
5625         - fhir
5626       description: 'Returns a list of Practitioner resources.'
5627       parameters:
5628         -
5629           name: _id
5630           in: query
5631           description: 'The uuid for the Practitioner resource.'
5632           required: false
5633           schema:
5634             type: string
5635         -
5636           name: name
5637           in: query
5638           description: 'The name of the Practitioner resource.'
5639           required: false
5640           schema:
5641             type: string
5642         -
5643           name: active
5644           in: query
5645           description: 'The active status of the Practitioner resource.'
5646           required: false
5647           schema:
5648             type: string
5649         -
5650           name: address
5651           in: query
5652           description: 'The address of the Practitioner resource.'
5653           required: false
5654           schema:
5655             type: string
5656         -
5657           name: address-city
5658           in: query
5659           description: 'The address-city of the Practitioner resource.'
5660           required: false
5661           schema:
5662             type: string
5663         -
5664           name: address-postalcode
5665           in: query
5666           description: 'The address-postalcode of the Practitioner resource.'
5667           required: false
5668           schema:
5669             type: string
5670         -
5671           name: address-state
5672           in: query
5673           description: 'The address-state of the Practitioner resource.'
5674           required: false
5675           schema:
5676             type: string
5677         -
5678           name: email
5679           in: query
5680           description: 'The email of the Practitioner resource.'
5681           required: false
5682           schema:
5683             type: string
5684         -
5685           name: family
5686           in: query
5687           description: 'The family name of the Practitioner resource.'
5688           required: false
5689           schema:
5690             type: string
5691         -
5692           name: given
5693           in: query
5694           description: 'The given name of the Practitioner resource.'
5695           required: false
5696           schema:
5697             type: string
5698         -
5699           name: phone
5700           in: query
5701           description: 'The phone number of the Practitioner resource.'
5702           required: false
5703           schema:
5704             type: string
5705         -
5706           name: telecom
5707           in: query
5708           description: 'The fax number of the Practitioner resource.'
5709           required: false
5710           schema:
5711             type: string
5712       responses:
5713         '200':
5714           description: 'Standard Response'
5715           content:
5716             application/json:
5717               schema:
5718                 properties:
5719                   'json object': { description: 'FHIR Json object.', type: object }
5720                 type: object
5721                 example:
5722                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5723                   resourceType: Bundle
5724                   type: collection
5725                   total: 0
5726                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Practitioner' }]
5727         '400':
5728           $ref: '#/components/responses/badrequest'
5729         '401':
5730           $ref: '#/components/responses/unauthorized'
5731       security:
5732         -
5733           openemr_auth: []
5734     post:
5735       tags:
5736         - fhir
5737       description: 'Adds a Practitioner resources.'
5738       requestBody:
5739         required: true
5740         content:
5741           application/json:
5742             schema:
5743               description: 'The json object for the Practitioner resource.'
5744               type: object
5745             example:
5746               id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5747               meta:
5748                 versionId: '1'
5749                 lastUpdated: '2021-09-21T17:41:57+00:00'
5750               resourceType: Practitioner
5751               text:
5752                 status: generated
5753                 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
5754               identifier:
5755                 -
5756                   system: 'http://hl7.org/fhir/sid/us-npi'
5757                   value: '11223344554543'
5758               active: true
5759               name:
5760                 -
5761                   use: official
5762                   family: Smith
5763                   given: [Danny]
5764       responses:
5765         '200':
5766           description: 'Standard Response'
5767           content:
5768             application/json:
5769               schema:
5770                 properties:
5771                   'json object': { description: 'FHIR Json object.', type: object }
5772                 type: object
5773                 example:
5774                   id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5775                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
5776                   resourceType: Practitioner
5777                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
5778                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
5779                   active: true
5780                   name: [{ use: official, family: Smith, given: [Danny] }]
5781         '400':
5782           $ref: '#/components/responses/badrequest'
5783         '401':
5784           $ref: '#/components/responses/unauthorized'
5785       security:
5786         -
5787           openemr_auth: []
5788   '/fhir/Practitioner/{uuid}':
5789     get:
5790       tags:
5791         - fhir
5792       description: 'Returns a single Practitioner resource.'
5793       parameters:
5794         -
5795           name: uuid
5796           in: path
5797           description: 'The uuid for the Practitioner resource.'
5798           required: true
5799           schema:
5800             type: string
5801       responses:
5802         '200':
5803           description: 'Standard Response'
5804           content:
5805             application/json:
5806               schema:
5807                 properties:
5808                   'json object': { description: 'FHIR Json object.', type: object }
5809                 type: object
5810                 example:
5811                   id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5812                   meta: { versionId: '1', lastUpdated: '2021-09-21T17:41:57+00:00' }
5813                   resourceType: Practitioner
5814                   text: { status: generated, div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>' }
5815                   identifier: [{ system: 'http://hl7.org/fhir/sid/us-npi', value: '11223344554543' }]
5816                   active: true
5817                   name: [{ use: official, family: Smith, given: [Billy] }]
5818         '400':
5819           $ref: '#/components/responses/badrequest'
5820         '401':
5821           $ref: '#/components/responses/unauthorized'
5822         '404':
5823           $ref: '#/components/responses/uuidnotfound'
5824       security:
5825         -
5826           openemr_auth: []
5827     put:
5828       tags:
5829         - fhir
5830       description: 'Modify a Practitioner resource.'
5831       parameters:
5832         -
5833           name: uuid
5834           in: path
5835           description: 'The uuid for the Practitioner resource.'
5836           required: true
5837           schema:
5838             type: string
5839       requestBody:
5840         required: true
5841         content:
5842           application/json:
5843             schema:
5844               description: 'The json object for the Practitioner resource.'
5845               type: object
5846             example:
5847               id: 9473b0cf-e969-4eaa-8044-51037767fa4f
5848               meta:
5849                 versionId: '1'
5850                 lastUpdated: '2021-09-21T17:41:57+00:00'
5851               resourceType: Practitioner
5852               text:
5853                 status: generated
5854                 div: '<div xmlns="http://www.w3.org/1999/xhtml"> <p>Billy Smith</p></div>'
5855               identifier:
5856                 -
5857                   system: 'http://hl7.org/fhir/sid/us-npi'
5858                   value: '11223344554543'
5859               active: true
5860               name:
5861                 -
5862                   use: official
5863                   family: Smith
5864                   given: [Billy]
5865       responses:
5866         '201':
5867           description: 'Standard Response'
5868           content:
5869             application/json:
5870               schema:
5871                 example:
5872                   id: 5
5873                   uuid: 95f294d7-e14c-441d-81a6-309fe369ee21
5874         '400':
5875           $ref: '#/components/responses/badrequest'
5876         '401':
5877           $ref: '#/components/responses/unauthorized'
5878       security:
5879         -
5880           openemr_auth: []
5881   /fhir/PractitionerRole:
5882     get:
5883       tags:
5884         - fhir
5885       description: 'Returns a list of PractitionerRole resources.'
5886       parameters:
5887         -
5888           name: specialty
5889           in: query
5890           description: 'The specialty of the PractitionerRole resource.'
5891           required: false
5892           schema:
5893             type: string
5894         -
5895           name: practitioner
5896           in: query
5897           description: 'The practitioner of the PractitionerRole resource.'
5898           required: false
5899           schema:
5900             type: string
5901       responses:
5902         '200':
5903           description: 'Standard Response'
5904           content:
5905             application/json:
5906               schema:
5907                 properties:
5908                   'json object': { description: 'FHIR Json object.', type: object }
5909                 type: object
5910                 example:
5911                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5912                   resourceType: Bundle
5913                   type: collection
5914                   total: 0
5915                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/PractitionerRole' }]
5916         '400':
5917           $ref: '#/components/responses/badrequest'
5918         '401':
5919           $ref: '#/components/responses/unauthorized'
5920       security:
5921         -
5922           openemr_auth: []
5923   '/fhir/PractitionerRole/{uuid}':
5924     get:
5925       tags:
5926         - fhir
5927       description: 'Returns a single PractitionerRole resource.'
5928       parameters:
5929         -
5930           name: uuid
5931           in: path
5932           description: 'The uuid for the PractitionerRole resource.'
5933           required: true
5934           schema:
5935             type: string
5936       responses:
5937         '200':
5938           description: 'Standard Response'
5939           content:
5940             application/json:
5941               schema:
5942                 properties:
5943                   'json object': { description: 'FHIR Json object.', type: object }
5944                 type: object
5945                 example:
5946                   id: 960c806f-9463-482e-b228-67b5be1fed55
5947                   meta: { versionId: '1', lastUpdated: '2022-04-13T06:18:17+00:00' }
5948                   resourceType: PractitionerRole
5949                   practitioner: { reference: Practitioner/960c7cd6-187a-4119-8cd4-85389d80efb9, display: 'Administrator Administrator' }
5950                   organization: { reference: Organization/960c7cc6-b4ae-49bc-877b-1a2913271c43, display: 'Your Clinic Name Here' }
5951                   code: [{ coding: [102L00000X], text: Psychoanalyst }, { coding: [101Y00000X], text: Counselor }]
5952         '400':
5953           $ref: '#/components/responses/badrequest'
5954         '401':
5955           $ref: '#/components/responses/unauthorized'
5956         '404':
5957           $ref: '#/components/responses/uuidnotfound'
5958       security:
5959         -
5960           openemr_auth: []
5961   /fhir/Procedure:
5962     get:
5963       tags:
5964         - fhir
5965       description: 'Returns a list of Procedure resources.'
5966       parameters:
5967         -
5968           name: _id
5969           in: query
5970           description: 'The uuid for the Procedure resource.'
5971           required: false
5972           schema:
5973             type: string
5974         -
5975           name: patient
5976           in: query
5977           description: 'The uuid for the patient.'
5978           required: false
5979           schema:
5980             type: string
5981         -
5982           name: date
5983           in: query
5984           description: 'The datetime of the Procedure resource.'
5985           required: false
5986           schema:
5987             type: string
5988       responses:
5989         '200':
5990           description: 'Standard Response'
5991           content:
5992             application/json:
5993               schema:
5994                 properties:
5995                   'json object': { description: 'FHIR Json object.', type: object }
5996                 type: object
5997                 example:
5998                   meta: { lastUpdated: '2021-09-14T09:13:51' }
5999                   resourceType: Bundle
6000                   type: collection
6001                   total: 0
6002                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Procedure' }]
6003         '400':
6004           $ref: '#/components/responses/badrequest'
6005         '401':
6006           $ref: '#/components/responses/unauthorized'
6007       security:
6008         -
6009           openemr_auth: []
6010   '/fhir/Procedure/{uuid}':
6011     get:
6012       tags:
6013         - fhir
6014       description: 'Returns a single Procedure resource.'
6015       parameters:
6016         -
6017           name: uuid
6018           in: path
6019           description: 'The uuid for the Procedure resource.'
6020           required: true
6021           schema:
6022             type: string
6023       responses:
6024         '200':
6025           description: 'Standard Response'
6026           content:
6027             application/json:
6028               schema:
6029                 properties:
6030                   'json object': { description: 'FHIR Json object.', type: object }
6031                 type: object
6032                 example:
6033                   id: 95e9d3fb-fe7b-448a-aa60-d40b11b486a5
6034                   meta: { versionId: '1', lastUpdated: '2022-03-26T17:20:14+00:00' }
6035                   resourceType: Procedure
6036                   status: in-progress
6037                   subject: { reference: Patient/95e8d830-3068-48cf-930a-2fefb18c2bcf, type: Patient }
6038         '400':
6039           $ref: '#/components/responses/badrequest'
6040         '401':
6041           $ref: '#/components/responses/unauthorized'
6042         '404':
6043           $ref: '#/components/responses/uuidnotfound'
6044       security:
6045         -
6046           openemr_auth: []
6047   '/fhir/Provenance/{uuid}':
6048     get:
6049       tags:
6050         - fhir
6051       description: 'Returns a single Provenance resource.'
6052       parameters:
6053         -
6054           name: uuid
6055           in: path
6056           description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6057           required: true
6058           schema:
6059             type: string
6060       responses:
6061         '200':
6062           description: 'Standard Response'
6063           content:
6064             application/json:
6065               schema:
6066                 properties:
6067                   'json object': { description: 'FHIR Json object.', type: object }
6068                 type: object
6069                 example:
6070                   id: 'AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145'
6071                   resourceType: Provenance
6072                   target: [{ reference: AllergyIntolerance/95ea43f3-1066-4bc7-b224-6c23b985f145, type: AllergyIntolerance }]
6073                   recorded: '2022-03-26T22:43:30+00:00'
6074                   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 } }
6075         '400':
6076           $ref: '#/components/responses/badrequest'
6077         '401':
6078           $ref: '#/components/responses/unauthorized'
6079         '404':
6080           $ref: '#/components/responses/uuidnotfound'
6081       security:
6082         -
6083           openemr_auth: []
6084   /fhir/Provenance:
6085     get:
6086       tags:
6087         - fhir
6088       description: 'Returns a list of Provenance resources.'
6089       parameters:
6090         -
6091           name: _id
6092           in: query
6093           description: 'The id for the Provenance resource. Format is \<resource name\>:\<uuid\> (Example: AllergyIntolerance:95ea43f3-1066-4bc7-b224-6c23b985f145).'
6094           required: false
6095           schema:
6096             type: string
6097       responses:
6098         '200':
6099           description: 'Standard Response'
6100           content:
6101             application/json:
6102               schema:
6103                 properties:
6104                   'json object': { description: 'FHIR Json object.', type: object }
6105                 type: object
6106                 example:
6107                   meta: { lastUpdated: '2021-09-14T09:13:51' }
6108                   resourceType: Bundle
6109                   type: collection
6110                   total: 0
6111                   link: [{ relation: self, url: 'https://localhost:9300/apis/default/fhir/Provenance' }]
6112         '400':
6113           $ref: '#/components/responses/badrequest'
6114         '401':
6115           $ref: '#/components/responses/unauthorized'
6116       security:
6117         -
6118           openemr_auth: []
6119   /fhir/metadata:
6120     get:
6121       tags:
6122         - fhir
6123       description: 'Returns metadata (ie. CapabilityStatement resource) of the fhir server.'
6124       responses:
6125         '200':
6126           description: 'Return CapabilityStatement resource of the fhir server'
6127   /fhir/.well-known/smart-configuration:
6128     get:
6129       tags:
6130         - fhir
6131       description: 'Returns smart configuration of the fhir server.'
6132       responses:
6133         '200':
6134           description: 'Return smart configuration of the fhir server'
6135   /fhir/$export:
6136     get:
6137       tags:
6138         - fhir
6139       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>'
6140       responses:
6141         '200':
6142           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>'
6143         '400':
6144           $ref: '#/components/responses/badrequest'
6145         '401':
6146           $ref: '#/components/responses/unauthorized'
6147       security:
6148         -
6149           openemr_auth: []
6150   /fhir/$bulkdata-status:
6151     get:
6152       tags:
6153         - fhir
6154       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>'
6155       responses:
6156         '200':
6157           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>'
6158         '400':
6159           $ref: '#/components/responses/badrequest'
6160         '401':
6161           $ref: '#/components/responses/unauthorized'
6162       security:
6163         -
6164           openemr_auth: []
6165     delete:
6166       tags:
6167         - fhir
6168       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>'
6169       responses:
6170         '200':
6171           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>'
6172         '400':
6173           $ref: '#/components/responses/badrequest'
6174         '401':
6175           $ref: '#/components/responses/unauthorized'
6176       security:
6177         -
6178           openemr_auth: []
6179   /portal/patient:
6180     get:
6181       tags:
6182         - standard-patient
6183       description: 'Returns the patient.'
6184       responses:
6185         '200':
6186           description: 'Standard response'
6187           content:
6188             application/json:
6189               schema:
6190                 $ref: '#/components/schemas/api_patient_response'
6191         '401':
6192           $ref: '#/components/responses/unauthorized'
6193       security:
6194         -
6195           openemr_auth: []
6196   /portal/patient/encounter:
6197     get:
6198       tags:
6199         - standard-patient
6200       description: 'Returns encounters for the patient.'
6201       responses:
6202         '200':
6203           $ref: '#/components/responses/standard'
6204         '400':
6205           $ref: '#/components/responses/badrequest'
6206         '401':
6207           $ref: '#/components/responses/unauthorized'
6208       security:
6209         -
6210           openemr_auth: []
6211   '/portal/patient/encounter/{euuid}':
6212     get:
6213       tags:
6214         - standard-patient
6215       description: 'Returns a selected encounter by its uuid.'
6216       parameters:
6217         -
6218           name: euuid
6219           in: path
6220           description: 'The uuid for the encounter.'
6221           required: true
6222           schema:
6223             type: string
6224       responses:
6225         '200':
6226           $ref: '#/components/responses/standard'
6227         '400':
6228           $ref: '#/components/responses/badrequest'
6229         '401':
6230           $ref: '#/components/responses/unauthorized'
6231       security:
6232         -
6233           openemr_auth: []
6234 components:
6235   schemas:
6236     api_patient_request:
6237       description: 'Schema for the patient request'
6238       required:
6239         - fname
6240         - lname
6241         - DOB
6242         - sex
6243       properties:
6244         title:
6245           description: 'The title of patient.'
6246           type: string
6247         fname:
6248           description: 'The fname of patient.'
6249           type: string
6250         mname:
6251           description: 'The mname of patient.'
6252           type: string
6253         lname:
6254           description: 'The lname of patient.'
6255           type: string
6256         street:
6257           description: 'The street address of patient.'
6258           type: string
6259         postal_code:
6260           description: 'The postal code of patient.'
6261           type: string
6262         city:
6263           description: 'The city of patient.'
6264           type: string
6265         state:
6266           description: 'The state of patient.'
6267           type: string
6268         country_code:
6269           description: 'The country code of patient.'
6270           type: string
6271         phone_contact:
6272           description: 'The phone contact of patient.'
6273           type: string
6274         DOB:
6275           description: 'The DOB of patient.'
6276           type: string
6277         sex:
6278           description: 'The lname of patient.'
6279           type: string
6280         race:
6281           description: 'The race of patient.'
6282           type: string
6283         ethnicity:
6284           description: 'The ethnicity of patient.'
6285           type: string
6286       type: object
6287       example:
6288         title: Mr
6289         fname: Foo
6290         mname: ''
6291         lname: Bar
6292         street: '456 Tree Lane'
6293         postal_code: '08642'
6294         city: FooTown
6295         state: FL
6296         country_code: US
6297         phone_contact: 123-456-7890
6298         DOB: '1992-02-02'
6299         sex: Male
6300         race: ''
6301         ethnicity: ''
6302     api_patient_response:
6303       description: 'Schema for the patient response'
6304       properties:
6305         validationErrors:
6306           description: 'Validation errors.'
6307           type: array
6308           items:
6309             type: object
6310         internalErrors:
6311           description: 'Internal errors.'
6312           type: array
6313           items:
6314             type: object
6315         data:
6316           description: 'Returned data.'
6317           type: array
6318           items:
6319             properties:
6320               id:
6321                 description: 'patient id'
6322                 type: string
6323               pid:
6324                 description: 'patient pid'
6325                 type: string
6326               pubpid:
6327                 description: 'patient public id'
6328                 type: string
6329               title:
6330                 description: 'patient title'
6331                 type: string
6332               fname:
6333                 description: 'patient first name'
6334                 type: string
6335               mname:
6336                 description: 'patient middle name'
6337                 type: string
6338               lname:
6339                 description: 'patient last name'
6340                 type: string
6341               ss:
6342                 description: 'patient social security number'
6343                 type: string
6344               street:
6345                 description: 'patient street address'
6346                 type: string
6347               postal_code:
6348                 description: 'patient postal code'
6349                 type: string
6350               city:
6351                 description: 'patient city'
6352                 type: string
6353               state:
6354                 description: 'patient state'
6355                 type: string
6356               county:
6357                 description: 'patient county'
6358                 type: string
6359               country_code:
6360                 description: 'patient country code'
6361                 type: string
6362               drivers_license:
6363                 description: 'patient drivers license id'
6364                 type: string
6365               contact_relationship:
6366                 description: 'patient contact relationship'
6367                 type: string
6368               phone_contact:
6369                 description: 'patient phone contact'
6370                 type: string
6371               phone_home:
6372                 description: 'patient home phone'
6373                 type: string
6374               phone_biz:
6375                 description: 'patient work phone'
6376                 type: string
6377               phone_cell:
6378                 description: 'patient mobile phone'
6379                 type: string
6380               email:
6381                 description: 'patient email'
6382                 type: string
6383               DOB:
6384                 description: 'patient DOB'
6385                 type: string
6386               sex:
6387                 description: 'patient sex (gender)'
6388                 type: string
6389               race:
6390                 description: 'patient race'
6391                 type: string
6392               ethnicity:
6393                 description: 'patient ethnicity'
6394                 type: string
6395               status:
6396                 description: 'patient status'
6397                 type: string
6398             type: object
6399       type: object
6400       example:
6401         validationErrors: []
6402         error_description: []
6403         data:
6404           id: '193'
6405           pid: '1'
6406           pubpid: ''
6407           title: Mr
6408           fname: Baz
6409           mname: ''
6410           lname: Bop
6411           ss: ''
6412           street: '456 Tree Lane'
6413           postal_code: '08642'
6414           city: FooTown
6415           state: FL
6416           county: ''
6417           country_code: US
6418           drivers_license: ''
6419           contact_relationship: ''
6420           phone_contact: 123-456-7890
6421           phone_home: ''
6422           phone_biz: ''
6423           phone_cell: ''
6424           email: ''
6425           DOB: '1992-02-03'
6426           sex: Male
6427           race: ''
6428           ethnicity: ''
6429           status: ''
6430     api_encounter_request:
6431       description: 'Schema for the encounter request'
6432       required:
6433         - pc_catid
6434         - class_code
6435       properties:
6436         date:
6437           description: 'The date of encounter.'
6438           type: string
6439         onset_date:
6440           description: 'The onset date of encounter.'
6441           type: string
6442         reason:
6443           description: 'The reason of encounter.'
6444           type: string
6445         facility:
6446           description: 'The facility of encounter.'
6447           type: string
6448         pc_catid:
6449           description: 'The pc_catid of encounter.'
6450           type: string
6451         facility_id:
6452           description: 'The facility id of encounter.'
6453           type: string
6454         billing_facility:
6455           description: 'The billing facility id of encounter.'
6456           type: string
6457         sensitivity:
6458           description: 'The sensitivity of encounter.'
6459           type: string
6460         referral_source:
6461           description: 'The referral source of encounter.'
6462           type: string
6463         pos_code:
6464           description: 'The pos_code of encounter.'
6465           type: string
6466         external_id:
6467           description: 'The external id of encounter.'
6468           type: string
6469         provider_id:
6470           description: 'The provider id of encounter.'
6471           type: string
6472         class_code:
6473           description: 'The class_code of encounter.'
6474           type: string
6475       type: object
6476       example:
6477         date: '2020-11-10'
6478         onset_date: ''
6479         reason: 'Pregnancy Test'
6480         facility: 'Owerri General Hospital'
6481         pc_catid: '5'
6482         facility_id: '3'
6483         billing_facility: '3'
6484         sensitivity: normal
6485         referral_source: ''
6486         pos_code: '0'
6487         external_id: ''
6488         provider_id: '1'
6489         class_code: AMB
6490     api_encounter_response:
6491       description: 'Schema for the encounter response'
6492       properties:
6493         validationErrors:
6494           description: 'Validation errors.'
6495           type: array
6496           items:
6497             type: object
6498         internalErrors:
6499           description: 'Internal errors.'
6500           type: array
6501           items:
6502             type: object
6503         data:
6504           description: 'Returned data.'
6505           type: array
6506           items:
6507             properties:
6508               id:
6509                 description: 'encounter id'
6510                 type: string
6511               uuid:
6512                 description: 'encounter uuid'
6513                 type: string
6514               date:
6515                 description: 'encounter date'
6516                 type: string
6517               reason:
6518                 description: 'encounter reason'
6519                 type: string
6520               facility:
6521                 description: 'encounter facility name'
6522                 type: string
6523               facility_id:
6524                 description: 'encounter facility id name'
6525                 type: string
6526               pid:
6527                 description: 'encounter for patient pid'
6528                 type: string
6529               onset_date:
6530                 description: 'encounter onset date'
6531                 type: string
6532               sensitivity:
6533                 description: 'encounter sensitivity'
6534                 type: string
6535               billing_note:
6536                 description: 'encounter billing note'
6537                 type: string
6538               pc_catid:
6539                 description: 'encounter pc_catid'
6540                 type: string
6541               last_level_billed:
6542                 description: 'encounter last_level_billed'
6543                 type: string
6544               last_level_closed:
6545                 description: 'encounter last_level_closed'
6546                 type: string
6547               last_stmt_date:
6548                 description: 'encounter last_stmt_date'
6549                 type: string
6550               stmt_count:
6551                 description: 'encounter stmt_count'
6552                 type: string
6553               provider_id:
6554                 description: 'provider id'
6555                 type: string
6556               supervisor_id:
6557                 description: 'encounter supervisor id'
6558                 type: string
6559               invoice_refno:
6560                 description: 'encounter invoice_refno'
6561                 type: string
6562               referral_source:
6563                 description: 'encounter referral source'
6564                 type: string
6565               billing_facility:
6566                 description: 'encounter billing facility id'
6567                 type: string
6568               external_id:
6569                 description: 'encounter external id'
6570                 type: string
6571               pos_code:
6572                 description: 'encounter pos_code'
6573                 type: string
6574               class_code:
6575                 description: 'encounter class_code'
6576                 type: string
6577               class_title:
6578                 description: 'encounter class_title'
6579                 type: string
6580               pc_catname:
6581                 description: 'encounter pc_catname'
6582                 type: string
6583               billing_facility_name:
6584                 description: 'encounter billing facility name'
6585                 type: string
6586             type: object
6587       type: object
6588       example:
6589         validationErrors: []
6590         error_description: []
6591         data:
6592           id: '1'
6593           uuid: 90c196f2-51cc-4655-8858-3a80aebff3ef
6594           date: '2019-09-14 00:00:00'
6595           reason: 'Pregnancy Test'
6596           facility: 'Owerri General Hospital'
6597           facility_id: '3'
6598           pid: '1'
6599           onset_date: '2019-04-20 00:00:00'
6600           sensitivity: normal
6601           billing_note: null
6602           pc_catid: '5'
6603           last_level_billed: '0'
6604           last_level_closed: '0'
6605           last_stmt_date: null
6606           stmt_count: '0'
6607           provider_id: '1'
6608           supervisor_id: '0'
6609           invoice_refno: ''
6610           referral_source: ''
6611           billing_facility: '3'
6612           external_id: ''
6613           pos_code: '0'
6614           class_code: AMB
6615           class_title: ambulatory
6616           pc_catname: 'Office Visit'
6617           billing_facility_name: 'Owerri General Hospital'
6618     api_vital_request:
6619       description: 'Schema for the vital request'
6620       properties:
6621         bps:
6622           description: 'The bps of vitals.'
6623           type: string
6624         bpd:
6625           description: 'The bpd of vitals.'
6626           type: string
6627         weight:
6628           description: 'The weight of vitals. (unit is lb)'
6629           type: string
6630         height:
6631           description: 'The height of vitals. (unit is inches)'
6632           type: string
6633         temperature:
6634           description: 'The temperature of temperature. (unit is F)'
6635           type: string
6636         temp_method:
6637           description: 'The temp_method of vitals.'
6638           type: string
6639         pulse:
6640           description: 'The pulse of vitals.'
6641           type: string
6642         respiration:
6643           description: 'The respiration of vitals.'
6644           type: string
6645         note:
6646           description: 'The note (ie. comments) of vitals.'
6647           type: string
6648         waist_circ:
6649           description: 'The waist circumference of vitals. (unit is inches)'
6650           type: string
6651         head_circ:
6652           description: 'The head circumference of vitals. (unit is inches)'
6653           type: string
6654         oxygen_saturation:
6655           description: 'The oxygen_saturation of vitals.'
6656           type: string
6657       type: object
6658       example:
6659         bps: '130'
6660         bpd: '80'
6661         weight: '220'
6662         height: '70'
6663         temperature: '98'
6664         temp_method: Oral
6665         pulse: '60'
6666         respiration: '20'
6667         note: 'Patient with difficulty standing, which made weight measurement difficult.'
6668         waist_circ: '37'
6669         head_circ: '22.2'
6670         oxygen_saturation: '96'
6671     api_soap_note_request:
6672       description: 'Schema for the soap_note request'
6673       properties:
6674         subjective:
6675           description: 'The subjective of soap note.'
6676           type: string
6677         objective:
6678           description: 'The objective of soap note.'
6679           type: string
6680         assessment:
6681           description: 'The assessment of soap note.'
6682           type: string
6683         plan:
6684           description: 'The plan of soap note.'
6685           type: string
6686       type: object
6687       example:
6688         subjective: 'The patient with mechanical fall and cut finger.'
6689         objective: 'The patient with finger laceration on exam.'
6690         assessment: 'The patient with finger laceration requiring sutures.'
6691         plan: 'Sutured finger laceration.'
6692     api_medical_problem_request:
6693       description: 'Schema for the medical_problem request'
6694       required:
6695         - title
6696         - begdate
6697       properties:
6698         title:
6699           description: 'The title of medical problem.'
6700           type: string
6701         begdate:
6702           description: 'The beginning date of medical problem.'
6703           type: string
6704         enddate:
6705           description: 'The end date of medical problem.'
6706           type: string
6707         diagnosis:
6708           description: 'The diagnosis of medical problem. In format `<codetype>:<code>`'
6709           type: string
6710       type: object
6711       example:
6712         title: Dermatochalasis
6713         begdate: '2010-10-13'
6714         enddate: null
6715         diagnosis: 'ICD10:H02.839'
6716     api_allergy_request:
6717       description: 'Schema for the allergy request'
6718       required:
6719         - title
6720         - begdate
6721       properties:
6722         title:
6723           description: 'The title of allergy.'
6724           type: string
6725         begdate:
6726           description: 'The beginning date of allergy.'
6727           type: string
6728         enddate:
6729           description: 'The end date of allergy.'
6730           type: string
6731         diagnosis:
6732           description: 'The diagnosis of allergy. In format `<codetype>:<code>`'
6733           type: string
6734       type: object
6735       example:
6736         title: Iodine
6737         begdate: '2010-10-13'
6738         enddate: null
6739     api_medication_request:
6740       description: 'Schema for the medication request'
6741       required:
6742         - title
6743         - begdate
6744       properties:
6745         title:
6746           description: 'The title of medication.'
6747           type: string
6748         begdate:
6749           description: 'The beginning date of medication.'
6750           type: string
6751         enddate:
6752           description: 'The end date of medication.'
6753           type: string
6754         diagnosis:
6755           description: 'The diagnosis of medication. In format `<codetype>:<code>`'
6756           type: string
6757       type: object
6758       example:
6759         title: Norvasc
6760         begdate: '2013-04-13'
6761         enddate: null
6762     api_surgery_request:
6763       description: 'Schema for the surgery request'
6764       required:
6765         - title
6766         - begdate
6767       properties:
6768         title:
6769           description: 'The title of surgery.'
6770           type: string
6771         begdate:
6772           description: 'The beginning date of surgery.'
6773           type: string
6774         enddate:
6775           description: 'The end date of surgery.'
6776           type: string
6777         diagnosis:
6778           description: 'The diagnosis of surgery. In format `<codetype>:<code>`'
6779           type: string
6780       type: object
6781       example:
6782         title: Blepharoplasty
6783         begdate: '2013-10-14'
6784         enddate: null
6785         diagnosis: 'CPT4:15823-50'
6786     api_dental_issue_request:
6787       description: 'Schema for the dental_issue request'
6788       required:
6789         - title
6790         - begdate
6791       properties:
6792         title:
6793           description: 'The title of dental issue.'
6794           type: string
6795         begdate:
6796           description: 'The beginning date of dental issue.'
6797           type: string
6798         enddate:
6799           description: 'The end date of dental issue.'
6800           type: string
6801         diagnosis:
6802           description: 'The diagnosis of dental issue. In format `<codetype>:<code>`'
6803           type: string
6804       type: object
6805       example:
6806         title: Halitosis
6807         begdate: '2015-03-17'
6808         enddate: null
6809     api_insurance_company_request:
6810       description: 'Schema for the insurance_company request'
6811       required:
6812         - name
6813       properties:
6814         name:
6815           description: 'The name of insurance company.'
6816           type: string
6817         attn:
6818           description: 'The attn of insurance company.'
6819           type: string
6820         cms_id:
6821           description: 'The cms id of insurance company.'
6822           type: string
6823         ins_type_code:
6824           description: 'The insurance type code of insurance company. The insurance type code can be found by inspecting the route at (/api/insurance_type).'
6825           type: string
6826         x12_receiver_id:
6827           description: 'The x12 receiver id of insurance company.'
6828           type: string
6829         x12_default_partner_id:
6830           description: 'The x12 default partner id of insurance company.'
6831           type: string
6832         alt_cms_id:
6833           description: 'The alternate cms id of insurance company.'
6834           type: string
6835         line1:
6836           description: 'The line1 address of insurance company.'
6837           type: string
6838         line2:
6839           description: 'The line2 address of insurance company.'
6840           type: string
6841         city:
6842           description: 'The city of insurance company.'
6843           type: string
6844         state:
6845           description: 'The state of insurance company.'
6846           type: string
6847         zip:
6848           description: 'The zip of insurance company.'
6849           type: string
6850         country:
6851           description: 'The country of insurance company.'
6852           type: string
6853       type: object
6854       example:
6855         name: 'Cool Insurance Company'
6856         attn: null
6857         cms_id: null
6858         ins_type_code: '2'
6859         x12_receiver_id: null
6860         x12_default_partner_id: null
6861         alt_cms_id: ''
6862         line1: '123 Cool Lane'
6863         line2: 'Suite 123'
6864         city: Cooltown
6865         state: CA
6866         zip: '12245'
6867         country: USA
6868     api_insurance_request:
6869       description: 'Schema for the insurance request'
6870       required:
6871         - provider
6872         - plan_name
6873         - policy_number
6874         - group_number
6875         - subscriber_fname
6876         - subscriber_lname
6877         - subscriber_relationship
6878         - subscriber_ss
6879         - subscriber_DOB
6880         - subscriber_street
6881         - subscriber_postal_code
6882         - subscriber_city
6883         - subscriber_state
6884         - subscriber_country
6885         - subscriber_phone
6886         - subscriber_sex
6887         - accept_assignment
6888         - policy_type
6889       properties:
6890         provider:
6891           description: 'The insurance company id.'
6892           type: string
6893         plan_name:
6894           description: 'The plan name of insurance.'
6895           type: string
6896         policy_number:
6897           description: 'The policy number of insurance.'
6898           type: string
6899         group_number:
6900           description: 'The group number of insurance.'
6901           type: string
6902         subscriber_lname:
6903           description: 'The subscriber last name of insurance.'
6904           type: string
6905         subscriber_mname:
6906           description: 'The subscriber middle name of insurance.'
6907           type: string
6908         subscriber_fname:
6909           description: 'The subscriber first name of insurance.'
6910           type: string
6911         subscriber_relationship:
6912           description: 'The subscriber relationship of insurance.'
6913           type: string
6914         subscriber_ss:
6915           description: 'The subscriber ss number of insurance.'
6916           type: string
6917         subscriber_DOB:
6918           description: 'The subscriber DOB of insurance.'
6919           type: string
6920         subscriber_street:
6921           description: 'The subscriber street address of insurance.'
6922           type: string
6923         subscriber_postal_code:
6924           description: 'The subscriber postal code of insurance.'
6925           type: string
6926         subscriber_city:
6927           description: 'The subscriber city of insurance.'
6928           type: string
6929         subscriber_state:
6930           description: 'The subscriber state of insurance. `state` can be found by querying `resource=/api/list/state`'
6931           type: string
6932         subscriber_country:
6933           description: 'The subscriber country of insurance. `country` can be found by querying `resource=/api/list/country`'
6934           type: string
6935         subscriber_phone:
6936           description: 'The subscriber phone of insurance.'
6937           type: string
6938         subscriber_employer:
6939           description: 'The subscriber employer of insurance.'
6940           type: string
6941         subscriber_employer_street:
6942           description: 'The subscriber employer street of insurance.'
6943           type: string
6944         subscriber_employer_postal_code:
6945           description: 'The subscriber employer postal code of insurance.'
6946           type: string
6947         subscriber_employer_state:
6948           description: 'The subscriber employer state of insurance.'
6949           type: string
6950         subscriber_employer_country:
6951           description: 'The subscriber employer country of insurance.'
6952           type: string
6953         subscriber_employer_city:
6954           description: 'The subscriber employer city of insurance.'
6955           type: string
6956         copay:
6957           description: 'The copay of insurance.'
6958           type: string
6959         date:
6960           description: 'The date of insurance.'
6961           type: string
6962         subscriber_sex:
6963           description: 'The subscriber sex of insurance.'
6964           type: string
6965         accept_assignment:
6966           description: 'The accept_assignment of insurance.'
6967           type: string
6968         policy_type:
6969           description: 'The policy_type of insurance.'
6970           type: string
6971       type: object
6972       example:
6973         provider: '33'
6974         plan_name: 'Some Plan'
6975         policy_number: '12345'
6976         group_number: '252412'
6977         subscriber_lname: Tester
6978         subscriber_mname: Xi
6979         subscriber_fname: Foo
6980         subscriber_relationship: other
6981         subscriber_ss: '234231234'
6982         subscriber_DOB: '2018-10-03'
6983         subscriber_street: '183 Cool St'
6984         subscriber_postal_code: '23418'
6985         subscriber_city: Cooltown
6986         subscriber_state: AZ
6987         subscriber_country: USA
6988         subscriber_phone: 234-598-2123
6989         subscriber_employer: 'Some Employer'
6990         subscriber_employer_street: '123 Heather Lane'
6991         subscriber_employer_postal_code: '23415'
6992         subscriber_employer_state: AZ
6993         subscriber_employer_country: USA
6994         subscriber_employer_city: Cooltown
6995         copay: '35'
6996         date: '2018-10-15'
6997         subscriber_sex: Female
6998         accept_assignment: 'TRUE'
6999         policy_type: a
7000     api_message_request:
7001       description: 'Schema for the message request'
7002       required:
7003         - body
7004         - groupname
7005         - from
7006         - to
7007         - title
7008         - message_status
7009       properties:
7010         body:
7011           description: 'The body of message.'
7012           type: string
7013         groupname:
7014           description: 'The group name (usually is ''Default'').'
7015           type: string
7016         from:
7017           description: 'The sender of the message.'
7018           type: string
7019         to:
7020           description: 'The recipient of the message.'
7021           type: string
7022         title:
7023           description: 'use an option from resource=/api/list/note_type'
7024           type: string
7025         message_status:
7026           description: 'use an option from resource=/api/list/message_status'
7027           type: string
7028       type: object
7029       example:
7030         body: 'Test 456'
7031         groupname: Default
7032         from: Matthew
7033         to: admin
7034         title: Other
7035         message_status: New
7036     api_transaction_request:
7037       description: 'Schema for the transaction request'
7038       required:
7039         - message
7040         - groupname
7041         - title
7042       properties:
7043         message:
7044           description: 'The message of the transaction.'
7045           type: string
7046         type:
7047           description: 'The type of transaction. Use an option from resource=/api/transaction_type'
7048           type: string
7049         groupname:
7050           description: 'The group name (usually is ''Default'').'
7051           type: string
7052         referByNpi:
7053           description: 'NPI of the person creating the referral.'
7054           type: string
7055         referToNpi:
7056           description: 'NPI of the person getting the referral.'
7057           type: string
7058         referDiagnosis:
7059           description: 'The referral diagnosis.'
7060           type: string
7061         riskLevel:
7062           description: 'The risk level. (Low, Medium, High)'
7063           type: string
7064         includeVitals:
7065           description: 'Are vitals included (0,1)'
7066           type: string
7067         referralDate:
7068           description: 'The date of the referral'
7069           type: string
7070         authorization:
7071           description: 'The authorization for the referral'
7072           type: string
7073         visits:
7074           description: 'The number of vists for the referral'
7075           type: string
7076         validFrom:
7077           description: 'The date the referral is valid from'
7078           type: string
7079         validThrough:
7080           description: 'The date the referral is valid through'
7081           type: string
7082       type: object
7083       example:
7084         message: Message
7085         type: LBTref
7086         groupname: Default
7087         referByNpi: '9999999999'
7088         referToNpi: '9999999999'
7089         referDiagnosis: 'Diag 1'
7090         riskLevel: Low
7091         includeVitals: '1'
7092         referralDate: '2022-01-01'
7093         authorization: Auth_123
7094         visits: '1'
7095         validFrom: '2022-01-02'
7096         validThrough: '2022-01-03'
7097         body: 'Reason 1'
7098   responses:
7099     standard:
7100       description: 'Standard Response'
7101       content:
7102         application/json:
7103           schema:
7104             properties:
7105               validationErrors:
7106                 description: 'Validation errors.'
7107                 type: array
7108                 items:
7109                   type: object
7110               internalErrors:
7111                 description: 'Internal errors.'
7112                 type: array
7113                 items:
7114                   type: object
7115               data:
7116                 description: 'Returned data.'
7117                 type: array
7118                 items:
7119                   type: object
7120             type: object
7121             example:
7122               validationErrors: []
7123               error_description: []
7124               data: []
7125     badrequest:
7126       description: 'Bad Request'
7127       content:
7128         application/json:
7129           schema:
7130             properties:
7131               validationErrors:
7132                 description: 'Validation errors.'
7133                 type: object
7134             type: object
7135             example:
7136               validationErrors:
7137                 _id: 'The search field argument was invalid, improperly formatted, or could not be parsed.  Inner message: UUID columns must be a valid UUID string'
7138     unauthorized:
7139       description: Unauthorized
7140       content:
7141         application/json:
7142           schema:
7143             properties:
7144               error:
7145                 description: 'The error.'
7146                 type: string
7147               error_description:
7148                 description: 'The description of the error.'
7149                 type: string
7150               hint:
7151                 description: 'More specific information on the error.'
7152                 type: string
7153               message:
7154                 description: 'Message regarding the error.'
7155                 type: string
7156             type: object
7157             example:
7158               error: access_denied
7159               error_description: 'The resource owner or authorization server denied the request.'
7160               hint: 'Missing "Authorization" header'
7161               message: 'The resource owner or authorization server denied the request.'
7162     uuidnotfound:
7163       description: 'Not Found'
7164       content:
7165         application/json:
7166           schema:
7167             properties:
7168               empty:
7169                 description: empty
7170                 type: object
7171             type: object
7172             example: []
7173   securitySchemes:
7174     openemr_auth:
7175       type: oauth2
7176       flows:
7177         authorizationCode:
7178           authorizationUrl: /oauth2/default/authorize
7179           tokenUrl: /oauth2/default/token
7180           refreshUrl: /oauth2/default/token
7181           scopes:
7182             openid: 'Generic mandatory scope'
7183             offline_access: 'Will signal server to provide a refresh token'
7184             'api:fhir': 'FHIR R4 API'
7185             patient/AllergyIntolerance.read: 'Read allergy intolerance resources for the current patient (api:fhir)'
7186             patient/CarePlan.read: 'Read care plan resources for the current patient (api:fhir)'
7187             patient/CareTeam.read: 'Read care team resources for the current patient (api:fhir)'
7188             patient/Condition.read: 'Read condition resources for the current patient (api:fhir)'
7189             patient/Coverage.read: 'Read coverage resources for the current patient (api:fhir)'
7190             patient/Device.read: 'Read device resources for the current patient (api:fhir)'
7191             patient/DiagnosticReport.read: 'Read diagnostic report resources for the current patient (api:fhir)'
7192             patient/DocumentReference.read: 'Read document reference resources for the current patient (api:fhir)'
7193             patient/Encounter.read: 'Read encounter resources for the current patient (api:fhir)'
7194             patient/Goal.read: 'Read goal resources for the current patient (api:fhir)'
7195             patient/Immunization.read: 'Read immunization resources for the current patient (api:fhir)'
7196             patient/Location.read: 'Read location resources for the current patient (api:fhir)'
7197             patient/MedicationRequest.read: 'Read medication request resources for the current patient (api:fhir)'
7198             patient/Observation.read: 'Read observation resources for the current patient (api:fhir)'
7199             patient/Organization.read: 'Read organization resources for the current patient (api:fhir)'
7200             patient/Patient.read: 'Read patient resource for the current patient (api:fhir)'
7201             patient/Person.read: 'Read person resources for the current patient (api:fhir)'
7202             patient/Practitioner.read: 'Read practitioner resources for the current patient (api:fhir)'
7203             patient/Procedure.read: 'Read procedure resources for the current patient (api:fhir)'
7204             patient/Provenance.read: 'Read provenance resources for the current patient (api:fhir)'
7205             system/AllergyIntolerance.read: 'Read all allergy intolerance resources in the system (api:fhir)'
7206             system/CarePlan.read: 'Read all care plan resources in the system (api:fhir)'
7207             system/CareTeam.read: 'Read all care team resources in the system (api:fhir)'
7208             system/Condition.read: 'Read all condition resources in the system (api:fhir)'
7209             system/Coverage.read: 'Read all coverage resources in the system (api:fhir)'
7210             system/Device.read: 'Read all device resources in the system (api:fhir)'
7211             system/DiagnosticReport.read: 'Read all diagnostic report resources in the system (api:fhir)'
7212             system/Document.read: 'Read all document resources in the system (api:fhir)'
7213             system/DocumentReference.read: 'Read all document reference resources in the system (api:fhir)'
7214             system/Encounter.read: 'Read all encounter resources in the system (api:fhir)'
7215             system/Goal.read: 'Read all goal resources in the system (api:fhir)'
7216             system/Group.read: 'Read all group resources in the system (api:fhir)'
7217             system/Immunization.read: 'Read all immunization resources in the system (api:fhir)'
7218             system/Location.read: 'Read all location resources in the system (api:fhir)'
7219             system/MedicationRequest.read: 'Read all medication request resources in the system (api:fhir)'
7220             system/Observation.read: 'Read all observation resources in the system (api:fhir)'
7221             system/Organization.read: 'Read all organization resources in the system (api:fhir)'
7222             system/Patient.read: 'Read all patient resources in the system (api:fhir)'
7223             system/Person.read: 'Read all person resources in the system (api:fhir)'
7224             system/Practitioner.read: 'Read all practitioner resources in the system (api:fhir)'
7225             system/PractitionerRole.read: 'Read all practitioner role resources in the system (api:fhir)'
7226             system/Procedure.read: 'Read all procedure resources in the system (api:fhir)'
7227             system/Provenance.read: 'Read all provenance resources in the system (api:fhir)'
7228             user/AllergyIntolerance.read: 'Read all allergy intolerance resources the user has access to (api:fhir)'
7229             user/CarePlan.read: 'Read all care plan resources the user has access to (api:fhir)'
7230             user/CareTeam.read: 'Read all care team resources the user has access to (api:fhir)'
7231             user/Condition.read: 'Read all condition resources the user has access to (api:fhir)'
7232             user/Coverage.read: 'Read all coverage resources the user has access to (api:fhir)'
7233             user/Device.read: 'Read all device resources the user has access to (api:fhir)'
7234             user/DiagnosticReport.read: 'Read all diagnostic report resources the user has access to (api:fhir)'
7235             user/DocumentReference.read: 'Read all document reference resources the user has access to (api:fhir)'
7236             user/Encounter.read: 'Read all encounter resources the user has access to (api:fhir)'
7237             user/Goal.read: 'Read all goal resources the user has access to (api:fhir)'
7238             user/Immunization.read: 'Read all immunization resources the user has access to (api:fhir)'
7239             user/Location.read: 'Read all location resources the user has access to (api:fhir)'
7240             user/MedicationRequest.read: 'Read all medication request resources the user has access to (api:fhir)'
7241             user/Observation.read: 'Read all observation resources the user has access to (api:fhir)'
7242             user/Organization.read: 'Read all organization resources the user has access to (api:fhir)'
7243             user/Organization.write: 'Write all organization resources the user has access to (api:fhir)'
7244             user/Patient.read: 'Read all patient resources the user has access to (api:fhir)'
7245             user/Patient.write: 'Write all patient resources the user has access to (api:fhir)'
7246             user/Person.read: 'Read all person resources the user has access to (api:fhir)'
7247             user/Practitioner.read: 'Read all practitioner resources the user has access to (api:fhir)'
7248             user/Practitioner.write: 'Write all practitioner resources the user has access to (api:fhir)'
7249             user/PractitionerRole.read: 'Read all practitioner role resources the user has access to (api:fhir)'
7250             user/Procedure.read: 'Read all procedure resources the user has access to (api:fhir)'
7251             user/Provenance.read: 'Read all provenance resources the user has access to (api:fhir)'
7252             'api:oemr': 'Standard OpenEMR API'
7253             user/allergy.read: 'Read allergies the user has access to (api:oemr)'
7254             user/allergy.write: 'Write allergies the user has access to for (api:oemr)'
7255             user/appointment.read: 'Read appointments the user has access to (api:oemr)'
7256             user/appointment.write: 'Write appointments the user has access to for (api:oemr)'
7257             user/dental_issue.read: 'Read dental issues the user has access to (api:oemr)'
7258             user/dental_issue.write: 'Write dental issues the user has access to (api:oemr)'
7259             user/document.read: 'Read documents the user has access to (api:oemr)'
7260             user/document.write: 'Write documents the user has access to (api:oemr)'
7261             user/drug.read: 'Read drugs the user has access to (api:oemr)'
7262             user/encounter.read: 'Read encounters the user has access to (api:oemr)'
7263             user/encounter.write: 'Write encounters the user has access to (api:oemr)'
7264             user/facility.read: 'Read facilities the user has access to (api:oemr)'
7265             user/facility.write: 'Write facilities the user has access to (api:oemr)'
7266             user/immunization.read: 'Read immunizations the user has access to (api:oemr)'
7267             user/insurance.read: 'Read insurances the user has access to (api:oemr)'
7268             user/insurance.write: 'Write insurances the user has access to (api:oemr)'
7269             user/insurance_company.read: 'Read insurance companies the user has access to (api:oemr)'
7270             user/insurance_company.write: 'Write insurance companies the user has access to (api:oemr)'
7271             user/insurance_type.read: 'Read insurance types the user has access to (api:oemr)'
7272             user/list.read: 'Read lists the user has access to (api:oemr)'
7273             user/medical_problem.read: 'Read medical problems the user has access to (api:oemr)'
7274             user/medical_problem.write: 'Write medical problems the user has access to (api:oemr)'
7275             user/medication.read: 'Read medications the user has access to (api:oemr)'
7276             user/medication.write: 'Write medications the user has access to (api:oemr)'
7277             user/message.write: 'Read messages the user has access to (api:oemr)'
7278             user/patient.read: 'Read patients the user has access to (api:oemr)'
7279             user/patient.write: 'Write patients the user has access to (api:oemr)'
7280             user/practitioner.read: 'Read practitioners the user has access to (api:oemr)'
7281             user/practitioner.write: 'Write practitioners the user has access to (api:oemr)'
7282             user/prescription.read: 'Read prescriptions the user has access to (api:oemr)'
7283             user/procedure.read: 'Read procedures the user has access to (api:oemr)'
7284             user/soap_note.read: 'Read soap notes the user has access to (api:oemr)'
7285             user/soap_note.write: 'Write soap notes the user has access to (api:oemr)'
7286             user/surgery.read: 'Read surgeries the user has access to (api:oemr)'
7287             user/surgery.write: 'Write surgeries the user has access to (api:oemr)'
7288             user/transaction.read: 'Read transactions the user has access to (api:oemr)'
7289             user/transaction.write: 'Write transactions the user has access to (api:oemr)'
7290             user/vital.read: 'Read vitals the user has access to (api:oemr)'
7291             user/vital.write: 'Write vitals the user has access to (api:oemr)'
7292             'api:port': 'Standard Patient Portal OpenEMR API'
7293             patient/encounter.read: 'Read encounters the patient has access to (api:port)'
7294             patient/patient.read: 'Write encounters the patient has access to (api:port)'
7295 tags:
7296   -
7297     name: fhir
7298     description: 'FHIR R4 API'
7299   -
7300     name: standard
7301     description: 'Standard OpenEMR API'
7302   -
7303     name: standard-patient
7304     description: 'Standard Patient Portal OpenEMR API'