swagger/openemr-api.yaml

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