{"info":{"version":"v4 - Hunt Valley","description":"\n<style>\n.apitos ol {\n  list-style-type: none;\n  counter-reset: item;\n  margin: 0;\n  padding: 0;\n}\n\n.apitos ol > li {\n  display: table;\n  counter-increment: item;\n  margin-bottom: 0.6em;\n}\n\n.apitos ol > li:before {\n  content: counters(item, \".\") \". \";\n  display: table-cell;\n  padding-right: 0.6em;\n}\n\n.apitos li ol > li {\n  margin: 0;\n}\n\n.apitos li ol > li:before {\n  content: counters(item, \".\") \" \";\n}\n</style>\n\n# APPLICATION PROGRAMMING INTERFACE LICENSE TERMS AND CONDITIONS\n<div class=\"apitos\">\n<p>EverHealth Solutions Inc. doing business as DrChrono.\n(“Company”) requires developers (“Developer”) accessing the Company’s database\nthrough any of the standard application programming interface\n(“API”), including Fast Healthcare Interoperability Resources\n(“FHIR”) APIs and Proprietary APIs, to accept and adhere to these\nterms and conditions (the \"Agreement\"). By accessing or using\nCompany’s API, Developer agrees to be bound by this Agreement.\nCompany may update this Agreement from time to time and Developer\nwill have 30 days to reject the updated terms by providing written\nnotice to Company. If Developer continues to use or receive the\nservices following such period, the updated Agreement will be\ndeemed accepted.</p>\n<ol>\n<li>Definitions\n<ol>\n<li>“FHIR APIs\" are standardized APIs developed by HL7\nInternational to promote healthcare data interoperability.</li>\n<li>\"Proprietary APIs\" are custom-built interfaces. These APIs are\ntailored to the unique needs of the platform but may not follow\nindustry-wide standards.</li>\n</ol>\n</li>\n<li><strong>Developer Account.</strong>\n<p>To access Company’s APIs, Developer will be required to register\nby establishing a developer account and provide certain information\nsuch as contact information (e.g., name, address, telephone number\nand e-mail address), demographic information (e.g., zip code,\norganization and/or role), or, if applicable, billing information\n(e.g., credit or debit card numbers). Any registration information\nDeveloper gives to Company will always be accurate and up to date\nand Developer will inform Company promptly of any updates. If\nCompany assigns Developer credentials, Developer must use them with\nthe applicable APIs. Developer will not misrepresent or mask its\nidentity when using the APIs or developer account.</p>\n<li><strong>License.</strong>\n<ol>\n<li><u>License Grant.</u> During the term of this Agreement, and subject\nto the terms and conditions set forth herein, Company hereby grants\nto Developer a limited, non-exclusive, non-transferrable,\nnon-sublicensable, revocable license to access and use the API to:\n(A) integrate the Developer’s technology (“Technology”) with the\nElectronic Health Record (“EHR”), test, read/write data, and deploy\nthe API and the data; (B) access and use a dedicated test\nenvironment of the EHR (the, “Environment”) for the purposes of\ntesting the API; (C) use the documentation and specifications for\nthe API (“Documentation,” and collectively with the API, EHR and\nthe Environment, the “Services”) for the purpose of fulfilling\nDeveloper’s rights and obligations hereunder; and (D) make\navailable and use the API and data through the Technology on behalf\nof Developer’s customers (“Customers”). Company may change, modify,\nimprove, upgrade, suspend, or discontinue any aspect of the API or\nService at any time without notice, including the availability of\nthe API. Company may also impose limits on certain features or\nrestrict Developer’s access to parts or all of the API or the\nService (including limiting the number of Developer’s API Calls)\nwithout notice or liability</li>\n<li><u>Restrictions.</u> Developer will not: (a) resell, lease, encumber,\nsublicense, distribute, publish, transmit, transfer, assign or\nprovide such access or use to any third party in any medium\nwhatsoever, except for as described in Section 1.1 above; (b)\ndevise specifications from, reverse engineer, reverse compile,\ndisassemble, or create derivative works based on the Services; (c)\napply systems to extract or modify information in the Services\nusing technology or method such as those commonly referred to as\n“web scraping,” “data scraping,” or “screen scraping”; (d)\nknowingly input or post through or to the Services any content that\nis illegal, threatening, harmful, lewd, offensive, or defamatory or\nthat infringes the intellectual property rights, privacy rights or\nrights of publicity of others, (e) transmit through or store data\non the Services that is regulated by the PCI Data Standards (f)\ninput or transmit through or to the Services any virus, worm,\nTrojan Horse, or other mechanism that could damage or impair the\noperation of the Services or grant unauthorized access thereto; (g)\nuse or access the Services for purposes of monitoring the\navailability, performance or functionality of the Services or for\nany other benchmarking or competitive purposes; or (h) cause,\nassist, allow or permit any third party (including an end-user) to\ndo any of the foregoing; (i) use the Services to compete with\nCompany in any way; or (j) permit any third party to use or access\nthe Services other than Customers, or Developer’s direct employees\nor agents who are acting on Developer’s behalf.</li>\n<li><u>Maintenance.</u> Developer agrees that Company may update, correct\nor modify the Services as Company deems necessary from time to\ntime. All such updates, corrections and modifications will be\nconsidered part of the Services for purposes of this\nAgreement.</li>\n<li><u>Applicable Laws.</u> Developer’s access to and use of the Services\nis subject to all applicable international, federal, state and\nlocal laws and regulations. Developer may not use the Services or\nany data in violation of or to violate any law, rule or regulation.\nEnsuring Developer’s use of the Services is compliant with\napplicable laws is the responsibility of Developer.</li>\n<li><u>Suspension of API.</u> Company has the right to immediately suspend\nthe API, including sandbox access and API applications(a) in order\nto prevent damage to or degradation of the Services or unauthorized\nor non-compliant use or (b) for operational reasons such as repair,\nmaintenance, or improvement or because of any emergency, or (c) if,\nfollowing notice from Company, Developer has failed to pay any\namounts due and owing. In the case of (a) or (b) Company will give\nDeveloper prior notice if reasonable and will ensure that the API\nis restored as soon as possible after the event giving rise to\nsuspension has been resolved to Company’ reasonable\nsatisfaction.</li>\n</ol>\n</li>\n<li><strong>Ownership.</strong>\n<ol>\n<li><u>Company.</u> Company’s intellectual property, including without\nlimitation the EHR, the API and the Documentation, its trademarks\nand copyrights, and any modification thereof, are and will remain\nthe exclusive property of Company and its licensors. No licenses or\nrights are granted to Developer except for the limited rights\nexpressly granted in this Agreement.</li>\n<li><u>Developer.</u> developer’s intellectual property, including without\nlimitation the Technology, the design and architecture of the\nintegration of the Technology with the EHR via the API, or with any\nother electronic health records system, or equivalent medical\npatient and scheduling software, the source code and any text or\nbinary executable representation of that source code which enables\nintegration of the Technology with the Company EHR, its trademarks\nand copyrights and any modification thereof, are and will remain\nthe exclusive property of Developer and its licensors. No licenses\nor rights are granted to Company except for the limited rights\nexpressly granted in this Agreement.</li>\n<li><u>Feedback.</u> Developer agrees that advice, feedback, criticism, or\ncomments provided to Company related to the EHR, the API and the\nDocumentation are given to Company and may be used by Company\nfreely and without restriction and will not enable Developer to\nclaim any interest, ownership or royalty in Company’ intellectual\nproperty. Likewise, Company agrees that advice, feedback,\ncriticism, or comments provided to Developer related to the\nTechnology are given to Developer and may be used by Developer\nfreely and without restriction and will not enable Company to claim\nany interest, ownership or royalty in Developer’s intellectual\nproperty.</li>\n</ol>\n</li>\n<li><strong>Fees/Payment Terms</strong>.\n<ol>\n<li><u>Fees.</u> Company may charge a fee for Developer’s use of the\nServices and/or for support related to Developer’s use of the\nServices. For details about these fees, please contact the Company\nat <a href=\"mailto:api@drchrono.com\">api@drchrono.com</a>.</li>\n<li><u>Payment Terms.</u> The fees\nset forth in Section 5.1 (“Fees”) are due and payable by the\nLicensee within 30 days of receipt of an invoice from the Company.\nAny amounts past due will be subject to a monthly charge of 1.5% or\nthe maximum rate permitted by law, whichever is less. In the event\nthat any amounts are not paid when due, the Licensee agrees to pay\nall reasonable costs of collection. All fees are payable in United\nStates Dollars and are non-refundable.</li>\n<li><u>Taxes.</u> The fees outlined\nabove do not include any local, state, federal, or foreign taxes,\nlevies, or duties of any nature, including value-added tax, sales\ntax, use tax, or withholding taxes (“Taxes”). The Licensee is\nresponsible for paying all Taxes for which it is liable under this\nsection. The Company may invoice taxes to the Licensee, and the\nLicensee will pay such taxes unless it provides a valid tax\nexemption certificate from the appropriate taxing authority.</li>\n<li><u>Exemption for Patient API\nAccess.</u> At the Company's sole discretion, these fees will\nnot apply to API access related to patient access use case. The\nCompany may determine, based on the specific nature of the access,\nthat fees for patient-facing API interactions are waived or treated\ndifferently.</li>\n</ol>\n<li><strong>Marketing.</strong> Neither party will make any public\nstatements or press releases without the prior written approval of\nthe other party which may be withheld in the approving party’s sole\ndiscretion. Developer may include Company’ name and EHR in its\npublished list of supported EHR integrations and partnerships for\nthe purposes of Developer sales and marketing of the Technology.\nDeveloper acknowledges that the Company’s trademarks are owned\nsolely and exclusively by Company and agrees to use the Company’s\ntrademarks only in the form and manner as prescribed by Company.\nAll use of the Company’s trademark shall inure to the benefit of the Company.\nDeveloper shall defend, indemnify, and hold harmless Company and\nits affiliates in connection with any third party claims or actions arising out of\nDeveloper’s unauthorized use of the Company trademarks. Company may\nterminate Developer’s right to use Company trademarks under this\nsection (either in part or whole) immediately on notice, with or\nwithout cause. Such termination shall not terminate or otherwise\naffect this Agreement. Moreover, this permission shall terminate\nimmediately upon termination or expiration of this Agreement. Upon\ntermination or expiration of this Agreement, Company shall\nimmediately stop using the Company trademarks.</li>\n<li><strong>Confidentiality.</strong>\n<ol>\n<li><u>Confidential Information.</u> “Confidential Information” means any\ninformation disclosed by one party to the other whether orally or\nin writing that is designated as confidential or that reasonably\nshould be understood by the receiving party to be confidential,\nnotwithstanding the failure of the disclosing party to designate it\nas such. Confidential Information may include information that is\nproprietary to a third party and is disclosed by one party to\nanother pursuant to this Agreement. The Services, all features and\nfunctions thereof and related pricing and product plans will be the\nConfidential Information of Company.</li>\n<li><u>Non-Disclosure.</u> Each party agrees to maintain the\nconfidentiality of the other party’s Confidential Information with\nthe same security and measures it uses to protect its own\nConfidential Information of a similar nature (but in no event less\nthan reasonable security and measures) and not to use such\nConfidential Information except as necessary to perform its\nobligations or exercise its rights under this Agreement. The\nreceiving party may disclose Confidential Information of the\ndisclosing party to those employees, officers, directors, agents,\naffiliates, consultants, users, and suppliers who need to know such\nConfidential Information for the purpose of carrying out the\nactivities contemplated by this Agreement and who have agreed to\nconfidentiality provisions that are no less restrictive than the\nrequirements herein. Such party will be responsible for any\nimproper use or disclosure of the disclosing party’s Confidential\nInformation by any such party. Except as expressly permitted by\nthis Section, the receiving party will not disclose or facilitate\nthe disclosure of Confidential Information of the disclosing party\nto any third party. The restrictions in this Section shall continue\nuntil such time as the information is covered by an exclusion set\nforth below.</li>\n<li><u>Exclusions.</u> The receiving party will have no obligation under\nthis Section with respect to information provided by the disclosing\nparty that: (a) is or becomes generally available to the public\nother than as a result of a breach of this Agreement by the\nreceiving party, (b) is or becomes available to the receiving party\nfrom a source other than the disclosing party, provided that such\nsource is not known to the receiving party to be bound by an\nobligation of confidentiality to the disclosing party with respect\nto such information, (c) was in the receiving party’s possession\nprior to disclosure by the disclosing party, or (d) is\nindependently developed by the receiving party without reference to\nthe Confidential Information. Further either party may disclose\nConfidential Information (i) as required by any court or other\ngovernmental body or as otherwise required by law, or (ii) as\nnecessary for the enforcement of this Agreement or its rights\nhereunder.</li>\n</ol>\n</li>\n<li><strong>Compliance with Laws</strong>.\n<ol>\n<li><u>PHI.</u> “PHI” means “protected health information” as that\nterm is used in the Health Insurance Portability and Accountability\nAct of 1996 as associated regulations as may be amended from time\nto time (“HIPAA”). Neither Party is the business associate of the\nother. If a Party requires PHI from the other to perform its\nobligations hereunder, and to the extent that the operation of any\nInterface capability as to any mutual client involves the use or\ndisclosure of PHI by the other Party, each Party requesting or\nreceiving such PHI agrees to: (a)&nbsp;obtain the written\nauthorization of the client of all such uses and disclosures of\ninformation of that client and that client’s patients;\n(b)&nbsp;enter into an agreement with the client that complies with\nthe applicable business associate provisions required by HIPAA\nprior to obtaining any PHI and requires that any patient consent\nthat may be required by law for such uses and disclosures is\nobtained by the client; and (c)&nbsp;adopt and enforce appropriate\nphysical, administrative, and technical measures to maintain\nprivacy and security of such information in accordance with HIPAA\nand Applicable Law. Any PHI of a client unintentionally or\nincidentally disclosed to the other Party shall be held in\nconfidence by the other Party in accordance with Applicable Law.\nEach Party will take reasonable steps to limit its request or\nrequirement from the other Party of any client’s PHI to the minimum\namount necessary to accomplish the intended purpose of requests\nfor, and uses and disclosures of, such PHI in accordance with\n45&nbsp;C.F.R.&nbsp;502(b)(1), and as authorized under HIPAA.</li>\n<li><u>Personal Information.</u> “Personal Information” means any\ninformation that a party collects, receives, or obtains, from or on\nbehalf of Customers that does or can identify a specific individual\nor by or from which a specific individual may be identified,\ncontacted, or located, such as the individual’s name; address;\nsocial security number; driver’s license number or state-issued\nidentification card number; and any other information relating to\nan identified or identifiable individual, or may otherwise\nconstitute personally identifiable information under any applicable\nlaw. &nbsp;Each party acknowledges and agrees that, in the course\nof performance of this Agreement, it may receive or have access to\nPersonal Information. Each party shall comply with the terms and\nconditions set forth in this Agreement in its collection, receipt,\ntransmission, storage, disposal, use, and disclosure of such\nPersonal Information and be responsible for the unauthorized\ncollection, receipt, transmission, access, storage, disposal, use,\nand disclosure of Personal Information under its control or in its\npossession.</li>\n<li><u>Data Transmissions.</u> In connection with any transfer of\nPersonal Information or PHI between them in the operation of the\nAPI, each party: (i)&nbsp;will transfer such Personal Information\nor PHI only through use of a dedicated connection to which they are\nthe only authorized parties or such other method of communication,\nsuch as encrypted communication, between them as offers an\nequivalent level of security and authentication of the recipient;\n(ii)&nbsp;will not permit any third party to use any such\nconnection to the extent that such use is within that party’s\ncontrol, except as permitted herein; and (iii)&nbsp;will take\nadequate and reasonable steps to ensure that access to that\nPersonal Information and PHI at each facility that party has or on\neach system utilized by such party or its subcontractors is limited\nto authorized personnel of that party. Each party will take\nreasonable care to ensure that data transmissions between them in\nthe operation of the API that contain any Personal Information or\nPHI are timely, complete, and accurate, and each party will take\nreasonable steps to retransmit any such data transmission to the\nother party upon discovery that the original transmission has been\nlost in transmission or is corrupted. If either party receives data\nfrom the other and is informed or believes that such data was not\nintended for it, the receiving party will notify the sender,\npromptly take effective steps to return such data, or at the\ndirection of the other party immediately and permanently delete\nsuch data from its systems.</li>\n<li><u>Compliance with Laws.</u> Each party represents that its\ncollection, access, use, storage, disposal, and disclosure of\nPersonal Information and PHI does and will comply with all\napplicable law. Without limiting the parties’ obligations in the\npreceding sentence, each party shall implement administrative,\nphysical, and technical safeguards to protect Personal Information\nand PHI that are no less rigorous than generally accepted industry\nstandards, including, but not limited to, with respect to\nimplementation, client service, payment security, functionality,\nease of use, and the creation, access, storage, destruction, or\nexchange of Personal Information and PHI. If, in the course of\nperformance of this Agreement, a party has access to or will\ncollect, access, use, store, process, dispose of or disclose\ncredit, debit, or other payment cardholder information, that party\nshall at all times remain in compliance with the Payment Card\nIndustry Data Security Standard (“PCI DSS”) requirements, including\nremaining aware at all times of changes to the PCI DSS and promptly\nimplementing all procedures and practices as may be necessary to\nremain in compliance with the PCI DSS, in each case, at such\nparty’s sole cost and expense.</li>\n<li><u>Anti-Fraud and Abuse Law Compliance.</u> By entering into this\nAgreement, the parties specifically intend that no part of any\nconsideration paid hereunder is a prohibited payment for the\nrecommending or arranging for the referral of business or the\nordering of items or services; nor are the payments intended to\ninduce illegal referrals of business. If any part of this Agreement\nis determined to violate an applicable law, the parties agree to\nnegotiate in good faith revisions to the provision or provisions\nthat are in violation. If the parties are unable to agree to new or\nmodified terms as required to bring the entire Agreement into\ncompliance with such applicable law within 30 days, either party\nmay terminate this Agreement on no less than 30 days prior written\nnotice to the other party or sooner if required by any applicable\nlaw.</li>\n<li><u>No Exclusion.</u> If a\nparty becomes debarred, excluded, suspended, or otherwise\ndetermined to be ineligible to participate in federal health care\nprograms, that party shall provide notice thereof to the other\nparty. Upon receipt of such notice, this Agreement shall\nautomatically terminate without further action or notice.</li>\n</ol>\n</li>\n<li><strong>Disclaimer.</strong> COMPANY DOES NOT WARRANT THAT THE\nSERVICES WILL BE ERROR-FREE OR UNINTERRUPTED, THAT COMPANY WILL\nCORRECT ALL ERRORS OR THAT THE SERVICES WILL MEET DEVELOPER’S\nREQUIREMENTS OR EXPECTATIONS. COMPANY IS NOT RESPONSIBLE FOR ANY\nISSUES RELATED TO THE PERFORMANCE, OPERATIONS OR SECURITY OF THE\nSERVICES THAT ARISE FROM DEVELOPER’S TECHNOLOGY OR THIRD PARTY\nAPPLICATIONS OR SERVICES PROVIDED BY THIRD PARTIES. COMPANY\nEXPRESSLY DISCLAIMS (TO THE GREATEST EXTENT PERMISSIBLE UNDER\nAPPLICABLE LAW) ALL OTHER WARRANTIES EXPRESS, IMPLIED, STATUTORY OR\nOTHERWISE, RELATING TO THE SUBJECT MATTER OF THIS AGREEMENT,\nINCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,\nTITLE, OR FITNESS FOR A PARTICULAR PURPOSE.</li>\n<li><strong>Limitation of Liability.</strong> IN NO EVENT WILL\nCOMPANY OR ITS AFFILIATES BE LIABLE FOR ANY INDIRECT,\nCONSEQUENTIAL, INCIDENTAL, SPECIAL, PUNITIVE, OR EXEMPLARY DAMAGES,\nOF ANY KIND OR NATURE ARISING OUT OF THIS AGREEMENT OR THE\nSERVICES, INCLUDING WITHOUT LIMITATION, ANY COST TO COVER\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES (WHICH THE PARTIES\nAGREE WILL NOT BE CONSIDERED DIRECT DAMAGES), OR ANY LOSS OF\nREVENUE, PROFITS, SALES, DATA, DATA USE, GOOD WILL, OR REPUTATION.\nCOMPANY’ MAXIMUM LIABILITY ARISING OUT OF OR RELATED TO THE\nSERVICES OR THIS AGREEMENT WILL BE LIMITED TO THE AMOUNT OF FEES\nDEVELOPER HAS PAID TO COMPANY IN THE 3 MONTHS PRIOR TO THE EVENT(S)\nGIVING RISE TO SUCH LIABILITY. THE LIMITATIONS SET FORTH IN THIS\nSECTION APPLY REGARDLESS OF THE LEGAL THEORY ON WHICH A CLAIM IS\nBROUGHT, EVEN IF COMPANY HAS BEEN NOTIFIED OF THE POSSIBILITY OF\nDAMAGE OR IF SUCH DAMAGE COULD HAVE BEEN REASONABLY FORESEEN AND\nNOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY EXCLUSIVE\nREMEDY PROVIDED IN THIS AGREEMENT.</li>\n<li><strong>Indemnity.</strong>\n<ol>\n<li><u>By Company.</u> Company will indemnify and hold Developer, its\naffiliates and each of its and its affiliates’ employees,\ncontractors, directors, suppliers and representatives harmless\nagainst any action brought against Developer by a third party to\nthe extent such action is based on a claim that the unmodified\nServices as used in accordance with this Agreement infringe a\ncopyright, patent, trademark or misappropriate a trade secret of\nsuch third party or other proprietary right enforceable in the\ncountry in which Company has authorized Developer to use the\nServices. Should the Services become, or in Company’ opinion be\nlikely to become, the subject of any infringement claim, Company\nmay, at its option: (a) procure for Developer, at Company’ expense,\nthe right to continue using the Services, (b) modify, at Company’\nexpense, the Services so that it becomes non-infringing but remains\nfunctionally equivalent, or (c) terminate Developer’s right to use\nthe Services and refund to Developer any unused pre-paid fees for\nsuch Services. Company will have no liability for any claim of\nintellectual property infringement that is based on (i) the use or\ncombination of the Services with any products, services, data or\nother materials not provided by Company, provided such infringement\nwould not have arisen but for such combination, (ii) the use of\nother than a current, unaltered version of the Service, (iii)\nspecifications or designed provided by Developer, or (iv) any\nunauthorized modification of the Services.</li>\n<li><u>By Developer.</u> Developer agrees to defend and indemnify Company\nand its affiliates from and against any legal action, demand, suit,\nor proceeding brought against Company or its affiliates by a third\nparty arising out of or related to Developer’s use of the\nServices.</li>\n<li><u>Indemnification Procedures.</u> Each party’s indemnification\nobligations are subject to conditions that the indemnified party\nmust: (a) notify the indemnifying party promptly in writing of such\nclaim; (b) permit the indemnifying party to have sole control of\nthe defense, compromise, or settlement of such claim, including any\nappeals, provided, that the indemnifying party will not settle any\nclaim in a manner that adversely affect the rights of the\nindemnified party without the indemnified party’s prior written\nconsent; and (c) fully cooperate with the indemnifying party at the\nindemnifying party’s expense in the defense or settlement of such\nclaim.</li>\n<li><u>Disclaimer.</u> This Section states the entire liability of\nCompany, and Developer’s sole and exclusive remedy, with respect to\nthe infringement of any intellectual property rights by the\nService.</li>\n</ol>\n</li>\n<li><strong>Term and Termination.</strong>\n<ol>\n<li><u>Term.</u> This Agreement will be effective as of the Developer’s\ninitial creation of a developer’s account or access of the APIs\n(“Effective Date”) and remain in effect until terminated by either\nparty as permitted by this Agreement. The initial term will be for\none year, thereafter, this Agreement will automatically renew for\nsuccessive one-year periods, unless cancelled by either party in\naccordance with this Agreement.</li>\n<li><u>Termination.</u> Either party may terminate this Agreement for any\nreason or no reason by providing at least 90 days’ prior written\nnotice. Either party may terminate this Agreement immediately for a\nbreach by the other party of any of its material terms, if the\nbreaching party has failed to cure such breach (if curable) within\n30 days of receipt of written notice from the non-breaching party\ndescribing the breach. Either party may terminate this Agreement\nwithout notice if the other party becomes insolvent, makes or has\nmade an assignment for the benefit of creditors, is the subject of\nproceedings in voluntary or involuntary bankruptcy instituted on\nbehalf of or against such party (except for involuntary\nbankruptcies which are dismissed within 60 days), or has a receiver\nor trustee appointed for substantially all of its property.</li>\n<li><u>Effects of Termination.</u> Upon the expiration or termination of\nthis Agreement for any reason, (a) Developer will immediately cease\nusing the Services for any of Developer’s Customers who have not\nyet executed a contract with Developer for the deployment of\nTechnology dependent on the Services, (b) upon request, each party\nwill return or destroy all Confidential Information of the other\nparty, provided, that each party may retain one copy of the\nConfidential information of the other party as necessary to comply\nwith applicable law or its records retention or archival policies\nor practices (and such retained Confidential Information will\nremain subject the non-disclosure obligations in this Agreement)\nand (c) any unpaid, undisputed amounts due through termination will\nbecome immediately due and payable and (d) for those Customers who\nare in contract with Developer, and who have deployed and are using\nthe Technology in conjunction with the Services, Developer shall\ncease using the Services for, with and on behalf of those Customers\nwithin a 90 day period from the date of termination, during which\nCustomers have the opportunity to remove business and technical\ndependencies and migrate away from the Technology (“Wind-Down”).\nThis Wind-Down period may be extended by mutual, written agreement\nof the parties.</li>\n<li><u>Survival.</u> Any provisions of this Agreement that expressly, or\nby implication, are intended to survive its termination or\nexpiration will survive and continue to bind the parties, including\nwithout limitation provisions relating to confidentiality,\nrepresentations and warranties, indemnification, limitations on\nliability, intellectual property, and Developer’s payment\nobligations under this Agreement.</li>\n</ol>\n</li>\n<li><strong>Assignment</strong>. Developer may not assign or\ntransfer this Agreement or any of its rights or obligations\nhereunder in whole or in part without the prior written consent of\nCompany. Subject to the foregoing, this Agreement will inure to the\nbenefit of, be binding upon, and be enforceable against, each of\nthe parties hereto and their respective successors and\nassigns.</li>\n<li><strong>Attorney’s Fees</strong>. In the event any proceeding\nor lawsuit is brought in connection with this Agreement, the\nprevailing party in such proceeding will be entitled to receive its\nreasonable costs, expert witness and attorneys’ fees.</li>\n<li><strong>Relationship of the Parties</strong>. This Agreement\ndoes not create any joint venture, partnership, agency, or\nemployment relationship between the parties.</li>\n<li><strong>No Third-Party Beneficiaries</strong>. This Agreement\nis being entered into for the sole benefit of the parties hereto,\nand nothing herein, express or implied, is intended to or will\nconfer upon any other person or entity any legal or equitable\nright, benefit or remedy of any nature whatsoever.</li>\n<li><strong>Equitable Remedies</strong>. Each party acknowledges\nand agrees that (a) a breach or threatened breach by such party may\ngive rise to irreparable harm to the other party for which monetary\ndamages may not be an adequate remedy; and (b) if a breach or\nthreatened breach by such party occurs, the other party will in\naddition to any and all other rights and remedies that may be\navailable to such other party at law, at equity or otherwise in\nrespect of such breach, be entitled to seek equitable relief that\nmay be available from a court of competent jurisdiction, without\nany requirement to post a bond or other security.</li>\n<li><strong>Force Majeure</strong>. Neither party will be liable\nunder this Agreement for any failure or delay in the performance of\nits obligations (except for the payment of money) on account of\nstrikes, shortages, riots, insurrections, fires, flood, storm,\nexplosions, acts of God, war, governmental action, pandemics,\nearthquakes, material shortages, or any other cause that is beyond\nthe reasonable control of such party.</li>\n<li><strong>Export Compliance.</strong> Developer must comply with\nUnited States, foreign and international laws and regulations,\nincluding without limitation, the United States Export\nAdministration Regulations and the United States Office of Foreign\nAsset Control regulations, and other anti-boycott and import\nregulations. Such export laws govern use of the Services including\ntechnical data and any deliverables provided under this Agreement\nand Developer agrees to comply with all such laws and regulations\n(including “deemed export” and “deemed re-export” regulations).\nDeveloper is responsible for ensuring that no data, information,\nsoftware programs and/or materials resulting from the Services (or\ndirect product thereof) will be exported directly or indirectly in\nviolation of these laws. Developer will indemnify Company for any\nviolation by Developer of any applicable export controls or\neconomic sanctions laws and regulations.</li>\n<li><strong>Governing Law, Jurisdiction and Venue</strong>. This\nAgreement will be governed by and construed in all respects in\naccordance with the laws of the State of Delaware, without regard\nto its conflicts of laws principles. Each party hereby consents to\nthe exclusive venue and jurisdiction of the courts of Indiana. THE\nPARTIES FURTHER AGREE, TO THE EXTENT PERMITTED BY APPLICABLE LAW,\nTO WAIVE ANY RIGHT TO TRIAL BY JURY WITH RESPECT TO ANY CLAIM,\nCOUNTERCLAIM OR ACTION ARISING FROM THE TERMS OF THIS\nAGREEMENT.</li>\n<li><strong>Severability, Waiver and Amendment</strong>. If any\nprovision of this Agreement is held by a court of competent\njurisdiction to be unenforceable or invalid, such provision will be\nchanged and interpreted as to best accomplish the objectives of the\noriginal provision to the fullest extent permitted by law, and the\nremaining provisions will remain in full force and effect. No\nwaiver of any term or right in this Agreement will be effective\nunless made in writing and signed by an authorized representative\nof the waiving party. Any waiver or failure to enforce any\nprovision of this Agreement will not be deemed a waiver of future\nenforcement of that or any other provision. Except to the extent\notherwise expressly provided in this Agreement, this Agreement may\nonly be amended in writing signed by both parties hereto.</li>\n<li><strong>Notices.</strong> Any notices pertaining to this\nAgreement shall be addressed to the appropriate party as follows,\nunless otherwise provided in this Agreement:\n<p>For Company:</p>\n<p><a href=\n\"mailto:legal@evercommerce.com\">legal@evercommerce.com</a></p>\n<p>-and-</p>\n<p>EverHealth Solutions Inc.\n  <br>Attn: Legal</p>\n</li>\n</ol>\n</div>\n\n# Introduction\n\nThis document is intended as a detailed reference for the precise behavior of\nthe DrChrono API. If this is your first time using the API, start with our <a href=\"/api-docs-old/tutorial\">tutorial</a>.\nIf you are upgrading from a previous version, take a look at the changelog section.\n\n### Requests\n\nAll requests must be made using the base URL `https://app.drchrono.com`.\nFor each endpoint, up to six different kinds of requests may be permitted:\n\nPath | Method | Side Effects | Success Status | Failure Status | Response Content\n---- | ------ | ------------ | -------------- | -------------- | ---------------\n`:endpoint` | `GET` | None | `200` | `403` | Paginated list of all endpoint resources that the requester can access\n`:endpoint/:id` | `GET` | None | `200` | `403` or `404` | Object with requested ID\n`:endpoint` | `POST` | Create object | `201` | `400`, `403`, or `409` | Object(s) created\n`:endpoint/:id` | `PUT` | Update entire object | `204` | `400`, `403`, or `409` | Empty\n`:endpoint/:id` | `PATCH` | Update only included values of object | `204` | `400`, `403`, or `409` | Empty\n`:endpoint/:id` | `DELETE` | Delete object | `204` | `400` or `403` | Empty\n\n### Responses\n\nAll responses are in JSON format. Generally input may use the `application/json`, `application/x-www-form-urlencoded`, or `form/multipart` content types.\nThe list of objects returned by a `GET` request to `:endpoint` is paginated and has the following format:\n\n     {\n       \"previous\": URL or null,                    // URL of the previous page\n       \"results\": array of objects,                // these results follow the same format as `:endpoint/:id`\n       \"next\": URL or null                         // URL of the next page (same as the requested URL, but with the page query parameter included)\n     }\n\nMost page sizes default to 250, but can be lowered by setting the `page_size` query parameter. The 'api/appointments' endpoint is an exception to this rule as it has a max size of 20.\n\nSome endpoints may return a `302` redirect response. Most libraries handle this\nincorrectly by resending the response with different headers or a different HTTP method.\nYou will need to resend the original request with the right HTTP method and headers\nto the new \"Location\" specified by the `302` response.\n\n### Permissions\n\nAPI access is managed using scopes and permissions. Scopes are granted to an API\nApplication when a user authorizes and permissions are granted by a primary user\nto other users in their Practice Group. The scopes are granted during the OAuth\nprocess, whereas the permissions have to be granted from DrChrono web app. In order\nfor an app to access information on behalf of a DrChrono user, the user must authorize\nthe app for the requested scopes, and the user must have the appropriate permissions set.\nEach endpoint in this documentation will specify which scopes and permissions are\nneeded for access. Scopes are labeled `drchrono_oauth2` in the AUTHORIZATIONS section\nof each endpoint.\n\n### Data Types\n\nThe data types referred to in this documentation, for both requests and responses,\nare listed below:\n\nType | Example | Description\n---- | ------- | -----------\nboolean | `true` | a binary variable, having two possible values of `true` and `false`\ninteger | `123` | represents some range of mathmatical integers\nstring | `HelloWorld` | sequence of characters\nURL | `\"http://example.com/index.html\"` | An absolute URL, including protocol\nobject | `{\"key\": \"value\"}` | A nested object. All values that are type \"object\" will have a clickable dropdown of the object's format\narray | `[1,2]` | A value may have type \"array of :type\"\ndate | `\"2021-02-14\"` | An ISO 8601 encoded date\ndate range | `\"2021-02-17/2021-02-24\"` | A start and end date separated by a slash\nfile | `\"https://rackcdn.com/file.ext\"` | When uploading, this is provided as a standard `multipart/form-data` file\nbase64encoded file | `\"https://rackcdn.com/file.ext\"` | When uploading, this is provided as a base64 encoded file within JSON\ntime | `\"12:34:56\"` | An ISO 8601 encoded time\ntimestamp | `\"2021-02-14T13:40:39\"` | AN ISO 8601 encoded timestamp, with no as_system_timezone\ncolor | `\"#ABCDEF\"` or `\"rgb(12, 34, 56)\"` | A CSS color specified in either of these formats\ndecimal | `\"123.45\"` | A numeric value truncated to two decimal places. It may be passed to an endpoint as an integer, float, or string, but will always be returned as a string.\n\n### Verbose Parameter\n\nFor some endpoints, certain fields will be excluded in the response to a `GET` request\nunless the `verbose` query parameter is passed with the value `true`. These fields\nhave a particularly large performance penalty. Passing `verbose=true` will include\nthese keys in the response, but will reduce the default and maximum page sizes to 50.\n\n### Rate Limits\n\nApplications are subject to an hourly rate limit, which will reset at the top of each hour.\nRequests over this limit will receive a response with code `429`. By default, applications are\nlimited to 500 calls per hour. Contact api@drchrono.com or your account representative\nto request an increased rate limit.\n\n### Endpoint Levels\n\n`Level 1 API Call(s)` and `Level 2 API(s)` are defined in the following table and are based on the listed `Endpoint`; the Endpoint's corresponding `Level` number listed denotes whether that Endpoint constitutes a Level 1 API Call vs. a Level 2 API Call. DrChrono's definition of Level 1 API Calls and Level 2 API Calls as listed in the following table are subject to change at DrChrono's sole discretion.\n\nENDPOINT | Level\n---------- | -----\n`/api/allergies` | 1\n`/api/appointments` | 1\n`/api/appointment_profiles` | 1\n`/api/appointment_templates` | 1\n`/api/billing_profiles` | 1\n`/api/care_plans` | 1\n`/api/clinical_note_templates` | 1\n`/api/comm_logs` | 1\n`/api/consent_forms` | 1\n`/api/custom_appointment_fields` | 1\n`/api/custom_demographics` | 1\n`/api/custom_vitals` | 1\n`/api/doctors` | 1\n`/api/documents` | 1\n`/api/iframe_integration` | 1\n`/api/implantable_devices` | 1\n`/api/inventory_categories` | 1\n`/api/inventory_vaccines` | 1\n`/api/medications` | 1\n`/api/offices` | 1\n`/api/patients` | 1\n`/api/patients/:id/ccda` | 1\n`/api/patients/:id/qrda1` | 1\n`/api/patients/:id/onpatient_access` | 1\n`/api/patient_communications` | 1\n`/api/patient_flag_types` | 1\n`/api/patient_interventions` | 1\n`/api/patient_physical_exams` | 1\n`/api/patient_risk_assessments` | 1\n`/api/patients_summary` | 1\n`/api/problems` | 1\n`/api/reminder_profiles` | 1\n`/api/telehealth_appointments` | 1\n`/api/users` | 1\n`/api/user_groups` | 1\n`/o/authorize` | 1\n`/o/revoke_token` | 1\n`/o/token` | 1\n`/api/amendments` | 2\n`/api/claim_billing_notes` | 2\n`/api/clinical_notes` | 2\n`/api/clinical_note_field_types` | 2\n`/api/clinical_note_field_values` | 2\n`/api/custom_insurance_plan_names` | 2\n`/api/eligibility_checks` | 2\n`/api/eobs`| 2\n`/api/fee_schedules` | 2\n`/api/insurances` | 2\n`/api/lab_documents` | 2\n`/api/lab_orders` | 2\n`/api/lab_orders_summary` | 2\n`/api/lab_tests` | 2\n`/api/lab_results` | 2\n`/api/line_items` | 2\n`/api/medications/:id/append_to_pharmacy_note` | 2\n`/api/messages` | 2\n`/api/offices/:id/add_exam_room` | 2\n`/api/pateint_lab_results` | 2\n`/api/patient_messages` | 2\n`/api/patient_payments` | 2\n`/api/patient_payment_log` | 2\n`/api/patient_vaccine_records` | 2\n`/api/prescription_messages` | 2\n`/api/procedures` | 2\n`/api/sublabs` | 2\n`/api/tasks` | 2\n`/api/task_categories` | 2\n`/api/task_notes` | 2\n`/api/task_templates` | 2\n`/api/task_statuses` | 2\n`/api/transactions` | 2\n\n# Authorization\n\n## Initial authorization\n\nThere are three main steps in the OAuth 2.0 authentication workflow:\n\n1. Redirect the provider to the authorization page.\n2. The provider authorizes your application and is redirected back to\n   your web application.\n3. Your application exchanges the `authorization_code` that came with\n   the redirect for an `access_token` and `refresh_token`.\n\n### Step 1: Redirect to drchrono\n\nThe first step is redirecting your user to drchrono, typically with a button\nlabeled \"Connect to drchrono\" or \"Login with drchrono\".  This is just a link that\ntakes your user to the following URL:\n\n    https://app.drchrono.com/o/authorize/?redirect_uri=REDIRECT_URI_ENCODED&response_type=code&client_id=CLIENT_ID_ENCODED&scope=SCOPES_ENCODED\n\n- `REDIRECT_URI_ENCODED` is the URL-encoded version of the redirect URI (as registered for your application and used in later steps).\n- `CLIENT_ID_ENCODED` is the URL-encoded version of your application's client ID.\n- `SCOPES_ENCODED` is a URL-encoded version of a space-separated list of scopes, which can be found in each endpoint or omitted to default to all scopes.\n\nThe `scope` parameter consists of an optional, space-separated list of scopes your application is requesting.\nIf omitted, all scopes will be requested.\n\nScopes are of the form `BASE_SCOPE:[read|write]` where `BASE_SCOPE` is any of `user`, `calendar`, `patients`, `patients:summary`, `billing`, `clinical` and `labs`.\nYou should request only the scopes you need.\nFor instance, an application which sends \"Happy Birthday!\" emails to a doctor's patients on their birthdays would use the scope parameter `\"patients:summary:read\"`,\nwhile one that allows patients to schedule appointments online would need at least\n`\"patients:summary:read patients:summary:write calendar:read calendar:write clinical:read clinical:write\"`.\n\n### Step 2: Provider authorization\n\nAfter logging in (if necessary), the provider will be presented with a screen\nwith your application's name and the list of permissions you requested (via the\n`scope` parameter).\n\nWhen they click the \"Authorize\" button, they will be redirected to your redirect\nURI with a `code` query parameter appended, which contains an authorization code to be\nused in step 3.  If they click the \"Cancel\" button, they will be redirected to\nyour redirect URI with `error=access_denied` instead.\n\nNote: This authorization code expires extremely quickly, so you must perform\nstep 3 immediately, ideally before rendering the resulting page for the end\nuser.\n\n### Step 3: Token exchange\n\nThe `code` obtained from step 2 is usable exactly once to obtain an access token\nand refresh token.  Here is an example token exchange in Python:\n\n    import datetime, pytz, requests\n\n    if 'error' in get_params:\n        raise ValueError('Error authorizing application: %s' % get_params[error])\n\n    response = requests.post('https://app.drchrono.com/o/token/', data={\n        'code': get_params['code'],\n        'grant_type': 'authorization_code',\n        'redirect_uri': 'http://mytestapp.com/redirect_uri',\n        'client_id': 'abcdefg12345',\n        'client_secret': 'abcdefg12345',\n    })\n    response.raise_for_status()\n    data = response.json()\n\n    # Save these in your database associated with the user\n    access_token = data['access_token']\n    refresh_token = data['refresh_token']\n    expires_timestamp = datetime.datetime.now(pytz.utc) + datetime.timedelta(seconds=data['expires_in'])\n\nYou now have all you need to make API requests authenticated as that provider.\nWhen using this access token, you'll only be able to access the data that the\nuser has access to and that you have been granted permissions for.\n\n## Refreshing an access token\n\nAccess tokens only last 48 hours (given in seconds in the `'expires_in'` key in\nthe token exchange step above), so they occasionally need to be refreshed.  It\nwould be inconvenient to ask the user to re-authorize every time, so instead you\ncan use the refresh token like the original authorization to obtain a new access\ntoken.  Replace the `code` parameter with `refresh_token`, change the value\n`grant_type` from `authorization_code` to `refresh_token`, and omit the\n`redirect_uri` parameter.\n\nExample in Python:\n\n    ...\n    response = requests.post('https://app.drchrono.com/o/token/', data={\n        'refresh_token': get_refresh_token(),\n        'grant_type': 'refresh_token',\n        'client_id': 'abcdefg12345',\n        'client_secret': 'abcdefg12345',\n    })\n    ...\n\n# Webhooks\n\nIn order to use drchrono API webhooks, you first need to have an API application on file\n(even if it is in Test Model).\nEach API webhook is associated with one API application, go to\n<a href=\"/api-management/\" target=\"_blank\">here</a> to set up both API applications and webhooks!\n\nOnce you registered an API application, you will see webhook section in each saved API applications.\nCreate a webhook and register some events there and save all the changes, then you are good to go!\n\n## Webhooks setup\n\nAll fields under webhooks section are required.\n\n**Callback URL**\nCallback URl is used to receive all hooks when subscribed events are triggered. This should be an URL under your control.\n\n**Secret token**\nSecret token is used to verify webhooks, this is very important, please set something with high entropy. Also we will\ntalk more about this later.\n\n**Events**\n\nEvents is used to register events you want to receiver notification when they happen. Currently we support following events.\n\nEvent name | Event description\n---------- | -----------------\n`APPOINTMENT_CREATE` | We will deliver a hook any time an appointment is created\n`APPOINTMENT_MODIFY` | We will deliver a hook any time an appointment is modified\n`APPOINTMENT_DELETE` | We will deliver a hook any time an appointment is deleted\n`CASH_PAYMENT_DELETE` | We will deliver a hook any time a patient payment is deleted\n`CLINICAL_NOTE_LOCK` | We will deliver a hook any time a clinical note is locked\n`CLINICAL_NOTE_UNLOCK` | We will deliver a hook any time a clinical note is unlocked\n`LAB_ORDER_CREATE` | We will deliver a hook any time a lab order is created\n`LAB_ORDER_MODIFY` | We will deliver a hook any time a lab order is modified\n`LAB_ORDER_DELETE` | We will deliver a hook any time a lab order is deleted\n`LINE_ITEM_CREATE` | We will deliver a hook any time a line item is created\n`LINE_ITEM_MODIFY` | We will deliver a hook any time a line item is modified\n`LINE_ITEM_DELETE` | We will deliver a hook any time a line item is deleted\n`LINE_ITEM_TRANSACTION_DELETE` | We will deliver a hook any time a line item transaction is deleted\n`PATIENT_CREATE` | We will deliver a hook any time a patient is created\n`PATIENT_MODIFY` | We will deliver a hook any time a patient is modified\n`PATIENT_ALLERGY_CREATE` | We will deliver a hook any time a patient allergy is created\n`PATIENT_ALLERGY_MODIFY` | We will deliver a hook any time a patient allergy is modified\n`PATIENT_FLAG_CREATE` | We will deliver a hook any time a patient flag is created\n`PATIENT_FLAG_CMODIFY` | We will deliver a hook any time a patient flag is modified\n`PATIENT_PROBLEM_CREATE` | We will deliver a hook any time a patient problem is created\n`PATIENT_PROBLEM_MODIFY` | We will deliver a hook any time a patient problem is modified\n`PATIENT_MEDICATION_CREATE` | We will deliver a hook any time a patient medication is created\n`PATIENT_MEDICATION_MODIFY` | We will deliver a hook any time a patient medication is modified\n`TASK_CREATE` | We will deliver a hook any time a task is created\n`TASK_MODIFY` | We will deliver a hook any time a task is modified and any time creation, modification and deletion of task notes, associated task item\n`TASK_DELETE` | We will deliver a hook any time a task is deleted\n`VACCINE_ADMINISTERED` | We will deliver a hook any time a vaccine consent form is signed\n\n\n## Webhooks verification\n\nIn order to make sure the callback URL in webhook is under your control, we added a verification\nstep before we send any hooks out to you.\n\nVerification can be done by clicking \"Verify webhook\" button in webhooks setup page. After you click\nthe button, we will send a `GET` request to the callback URL, along with a parameter called `msg`.\n\nPlease use your webhook's secret token as hash key and SHA-256 as digest constructor, hash the `msg` value with\n<a href=\"https://tools.ietf.org/html/rfc2104.html\">HMAC algorithm</a>.\nAnd we expect a `200` JSON response, in JSON response body, there should be a key called `secret_token` existing, and its value should be\nequal to the <strong>hashed</strong> `msg`. Otherwise, verification will fail.\n\nHere is an example webhook verification in Python:\n\n    import hashlib, hmac\n\n    def webhook_verify(request):\n        secret_token = hmac.new(WEBHOOK_SECRET_TOKEN, request.GET['msg'], hashlib.sha256).hexdigest()\n        return json_response({\n            'secret_token': secret_token\n        })\n\n<div class=\"alert alert-warning\">\n<b>Note:</b> Verification will be needed when webhook is first created and anytime callback URl is changed.\n</div>\n\n\n## Webhooks header and body\n\n**Header**\n\nKey | Value\n--- | -----\n`X-drchrono-event` | Event that triggered this hook, could be any one event above or `PING`\n`X-drchrono-signature` | Secret token associated with this webhook\n`X-drchrono-delivery` | ID of this delivery\n\n**Body**\n\nKey | Value\n--- | -----\n`receiver` | This will be an JSON representation of the webhook\n`object` | This will be an JSON representation of the object related to the triggered event, this would share same serializer as drchrono API\n\n## Webhooks ping and deliveries\n\nWebhooks ping and deliveries will be sent as `POST` requests.\n\n**PING**:\n\nYou can always ping your webhook to check things, by clicking the \"Ping webhook\" button in webhook setup page. And a hook with header `X-drchrono-event: PING` would be sent to the callback URL.\n\n**Deliveries**:\n\nYou can check recent deliveries by clicking the \"deliveries\" link in webhook setup page. And you can resend a hook by clicking \"redeliver\" button after select a specific delivery.\n\n## Webhooks delivery mechanism\n\nWe will delivery a hook the moment a subscribed event is triggered. We will not record any response header or body you send back after you receive the hook.\nHowever we only consider the response status code. We will consider any `2xx` responses as successfully delivered.\nAny other responses, like `302` would be considered failing.\nAnd we will try to redeliver unsuccessfully delivered hooks 3 times, first redeliver happens at 1 hour after the initial event,\nsecond redeliver happens 3 hours after the initial event, and the third redeliver happens 7 hours after the initial event.\nAfter these intents, if the delivery is still unsuccessful, you have to redeliver it by hand.\n\n\n## Webhooks security\n\nYou may want to secure your webhooks to only consider requests send out from drchrono. And this is where <code>secret_token</code> is needed in\nrequest header.\nTry to set the <code>secret_token</code> to something with high entropy, a good example could be taking the output of\n<code>ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'</code>.\nAfter this, you might want to verify all request headers you received on your server with this token.\n\n\n# iframe integration\n\nSome API apps provide additional functionality for interacting with patient data\nnot offered by drchrono, and can benefit by being incorporated into drchrono's\npatient information page via iframe.  We have created a simple API to make this\npossible.\n\nTo make an existing API application accessible via an iframe on the patient\npage, you need to update either \"Patient iframe\" or \"Clinical note iframe\" section in API management page,\nto make the iframe to appear on (either the patient page or the clinical note page),\nwith the URL that the iframe will use for each page, and the height it should\nhave. The application will be reviewed before it is approved to ensure that it\nis functional and secure.\n\n## Register a Doctor\n\niframe applications will appear as choices on the left-hand menu of the patient\npage for doctors registered with your application.  To register a doctor with\nyour application, make a `POST` request to the `/api/iframe_integration`\nendpoint using the access token for the corresponding doctor. This endpoint does not\nexpect any payload.\n\nTo disable your iframe application for a doctor, make a `DELETE` request to the\nsame endpoint.\n\n## Populating the iframe\n\nThere are two places where the iframe can be displayed, either within the\npatient detail page or the clinical note page, shown below respectively:\n\n### Patient Chart\n![Iframe on the patient page](https://app.drchrono.com/site_media/cb-af088f58/public/images/iframe_patient_page.png \"Patient Chart iFrame\")\n\n### Clinical Note\n![Iframe on the clinical note page](https://app.drchrono.com/site_media/cb-af088f58/public/images/iframe_clinical_note.png \"Clincal Note iFrame\")\n\nWhen requesting approval for your iframe app, you must specify a URL for one or\nboth of these pages which will serve as the base URL for your IFrame\ncontents. When a doctor views your iframe, the source URL will have various\nquery parameters appended to it, for example for the patient page the `src`\nparameter of the IFrame will be:\n\n```\n<iframe_url>?doctor_id=<doctor_id>&patient_id=<patient_id>&practice_id=<practice_id>&iat=<iat>&jwt=<jwt>\n```\n\nThe `jwt` parameter is crucial if your application transfers any sort of PHI and\ndoes not implement its own login system.  It encapsulates the other parameters\nin a [JSON web token (JWT)](http://jwt.io) and signs them using SHA-256 HMAC\nwith your `client_secret` as the key.  This verifies that the iframe is being\nloaded within one of drchrono's pages by an authorized user.  In production, you\nshould validate the JWT using an approved library (which are listed on the\n[official site](http://jwt.io)), and only use the parameters extracted from the\nJWT.  Using Python and Django, this might look like:\n\n    import jwt\n\n    CLIENT_SECRET = <client_secret>\n    MAX_TIME_DRIFT_SECONDS = 60\n\n    def validate_parameters(request):\n        token = request.GET['jwt']\n\n        return jwt.decode(token, CLIENT_SECRET, algorithms=['HS256'], leeway=MAX_TIME_DRIFT_SECONDS)\n\nModern browsers' same-origin policy means that data cannot be passed between\nyour application and drchrono's page through the iframe.  Therefore, interaction\nmust happen through the API, using information provided in JWT.\n\n# Versions and deprecation\n\n## Stability Policy\n\nChanges to this API version will be limited to adding endpoints, or adding fields to existing\nendpoints, or adding optional query parameters. Any new fields which are not read-only will be optional.\n\n## Deprecation Policy\n\nThe drchrono API is versioned. Versions can be in the following states:\n\n* **Active:** This is our latest and greatest version of the API. It is actively supported by\nour API team and is improved upon with new features, bug fixes and optimizations that do\nnot break backwards compatibility.\n\n* **Deprecated:** A deprecated API version is considered second best--having been\nsurpassed by our active API version. An API version remains in this state for one year,\nafter which time it falls to the not supported state. A deprecated API version is passively supported;\nwhile it won't be removed until becoming unsupported, it may not receive new features but will likely\nbe subject to security updates and performance improvements.\n\n* **Unsupported:** An API version in the not supported state may be deactivated at any\ntime. An application using an unsupported API version should migrate to an active API version.\n\n## Version Map\n| Version Name | Previous Name | Start Date | Deprecation Date |\n|--------------|---------------|------------|------------------|\n| v2           | v2015_08      | 08/2015    | TBA              |\n| v3           | v2016_06      | 06/2016    |                  |\n| v4           | N/A           | 09/2018    |                  |\n\nIf you are looking for documentation for an older version\n\n- [V4(Hunt Valley)](/api-docs-old/v4/documentation) (old V4 documentation)\n- [V3(Sunnyvale)](/api-docs-old/v3/documentation)\n- [V2(Mountain View)](/api-docs-old/v2/documentation)\n\n# Changelog\n\nHere's changelog for different versions\n\n- [Current Changelog](https://headwayapp.co/drchrono-changelog)\n- [V4 Changelog](/api-docs-old/v4/changelog)\n- [V3 Changelog](/api-docs-old/v3/changelog)\n\n","x-logo":{"url":"https://www.drchrono.com/site_media/images/logos/drchrono-black-wpadding.png","altText":"DrChrono Logo"},"title":""},"paths":{"/api/day_sheet_charges":{"get":{"description":"Retrieve daysheet charges report for a given date range","parameters":[{"schema":{"type":"string","description":"Start date of report (M/D/YYYY)","title":"start_date"},"required":true,"name":"start_date","in":"query"},{"schema":{"type":"string","description":"End date of report (M/D/YYYY)","title":"end_date"},"required":true,"name":"end_date","in":"query"},{"schema":{"type":"string","description":"Filters report by scheduled time or date of entry if not provided. Can be one of ('scheduled_time', ' ')","title":"charges_date_type"},"required":false,"name":"charges_date_type","in":"query"},{"schema":{"type":"string","description":"Filters report by given value. Can be one of ('reimbursement_analysis', ' ')","title":"report_type"},"required":false,"name":"report_type","in":"query"},{"schema":{"type":"string","description":"Filters report by professional or institutional claims. Can be one of ('institutional', 'professional', ' ')","title":"claim_type"},"required":false,"name":"claim_type","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given patient ID","title":"patient_id"},"required":false,"name":"patient_id","in":"query"},{"schema":{"type":"string","description":"Filters report by a given office","title":"office"},"required":false,"name":"office_id","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given examroom ID","title":"examroom_id"},"required":false,"name":"examroom_id","in":"query"},{"schema":{"type":"boolean","description":"Runs report for all providers in the practice group","title":"pg_mode"},"required":false,"name":"pg_mode","in":"query"}],"tags":["Billing"],"x-permissions":["billing","access-patient-payments"],"security":[{"drchrono_oauth2":["billing"]}],"operationId":"daysheet_charges_list"}},"/api/claim_billing_notes":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimBillingNotes"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"claim_billing_notes_create","description":"Create a new billing note"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ClaimBillingNotes"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"claim_billing_notes_list","description":"Retrieve or search billing notes"}},"/api/signed_consent_forms":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedConsentForm"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","title":"patient"},"required":true,"description":"ID of the patient to associate with the consent form","name":"patient","in":"query"},{"schema":{"type":"integer","title":"appointment"},"required":true,"description":"ID of the appointment to associate with the consent form","name":"appointment","in":"query"},{"schema":{"type":"integer","title":"consent_form"},"required":true,"description":"ID of the consent form that was signed","name":"consent_form","in":"query"},{"schema":{"type":"file","title":"signature_file"},"required":false,"description":"File containing the patient's signature","name":"signature_file","in":"query"}],"tags":["Clinical"],"description":"Create a signed consent form record for a patient and consent form","x-permissions":["manage-patients"],"summary":"signed_consent_forms Create","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SignedConsentFormUpdate"}}}},"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"signed_consent_forms_create"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"ID of the consent form signature to update","title":"id"},"required":true,"name":"id","in":"query"},{"schema":{"type":"integer","title":"patient"},"required":false,"description":"ID of the patient to filter by","name":"patient","in":"query"}],"tags":["Clinical"],"description":"Update an existing consent form signature","x-permissions":["manage-patients"],"summary":"signed_consent_forms Update","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"archived":{"type":"boolean","description":"Whether to archive the consent form signature"},"appointment":{"type":"integer","description":"ID of the appointment to assign the consent form signature to"},"id":{"type":"integer","description":"ID of the consent form signature to update"},"signature_file":{"type":"string","description":"Base64-encoded signature file to update","format":"binary"}},"examples":{"ArchiveSignature":{"value":{"archived":true,"id":12345}},"AssignToDifferentAppointment":{"value":{"appointment":67890,"id":12345}},"UpdateSignatureFile":{"value":{"id":12345,"signature_file":"base64-encoded-signature-file"}}}}}}},"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"signed_consent_forms_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"results":{"items":{"$ref":"#/components/schemas/SignedConsentForm"},"type":"array","description":"List of consent form signatures","title":"results"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"ID of the patient to filter by","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"ID of the doctor to filter by","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"description":"Retrieve or search signed consent forms","x-permissions":["manage-patients"],"summary":"signed_consent_forms Get","requestBody":{"content":{"application/json":{"examples":{"example1":{"description":"Example of filtering by patient","value":{"patient":12345}}},"schema":{"$ref":"#/components/schemas/SignedConsentForm"}}}},"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"signed_consent_forms_list"}},"/api/custom_appointment_fields":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAppointmentFieldType"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_appointment_fields_create","description":"Create custom appointment fields"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CustomAppointmentFieldType"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_appointment_fields_list","description":"Retrieve or search custom appointment fields"}},"/api/lab_orders/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_update","description":"Update an existing lab order"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_partial_update","description":"Update an existing lab order"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabOrder"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_read","description":"Retrieve an existing lab order"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_delete","description":"Delete an existing lab order"}},"/api/clinical_notes_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request. Upon creation this will be \"In progress\"","title":"status"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page. Value between 1 and 1000.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"Number of page to return. Value between 1 and max number of pages in result set.","title":"Page"},"required":false,"name":"page","in":"query"},{"schema":{"type":"integer","description":"Patient ID filter","title":"patient"},"required":false,"description":"Patient ID filter","name":"patient","in":"query"},{"schema":{"type":"integer","description":"Office ID filter","title":"office"},"required":false,"description":"Office ID filter","name":"office","in":"query"},{"schema":{"type":"integer","description":"Doctor ID filter","title":"doctor"},"required":false,"description":"Doctor ID filter","name":"doctor","in":"query"},{"schema":{"type":"string","description":"Inclusive lower bound on clinical note updated/created time.","title":"since"},"required":false,"description":"Inclusive lower bound on clinical note updated/created time.","name":"since","in":"query"},{"schema":{"type":"string","description":"Inclusive bounded date range on appointment scheduled date","title":"date_range"},"required":false,"description":"Inclusive bounded date range on appointment scheduled date","name":"date_range","in":"query"},{"schema":{"type":"string","description":"Filter on specific appointment scheduled date","title":"date"},"required":false,"description":"Filter on specific appointment scheduled date","name":"date","in":"query"},{"schema":{"type":"boolean","description":"When `true` includes yellow notes","title":"verbose"},"required":false,"description":"When `true` includes yellow notes","name":"verbose","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_notes_list_create","description":"Create clinical note list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"Complete\" or \"In progress\".\n","title":"status"},"pagination":{"properties":{"count":{"type":"int","description":"the count of all records in the result set.","title":"count"},"pages":{"type":"int","description":"the total pages of all pages in the result set.","title":"pages"},"page":{"type":"int","description":"the current page (starting with 1) in the total pages.","title":"page"}},"type":"object","description":"information on the total pages, current page and total count.","title":"pagination"},"results":{"items":{"$ref":"#/components/schemas/ClinicalNote"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"}}}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"required":false,"description":"The UUID token for the batch of clinical notes.  This is returned in the response of the `create` endpoint.\n","name":"uuid","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read"]}],"operationId":"clinical_notes_list_list","description":"Retrieve or search clinical notes in batches. Results returned in order of ID."}},"/api/custom_vitals/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomVitalType"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_vitals_read","description":"Retrieve an existing custom vital type"}},"/api/sublabs/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"A unique integer value identifying this lab vendor location.","title":"ID"},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_update","description":"Update an existing sub vendor"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"A unique integer value identifying this lab vendor location.","title":"ID"},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_partial_update","description":"Update an existing sub vendor"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabVendorLocation"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"A unique integer value identifying this lab vendor location.","title":"ID"},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_read","description":"Retrieve an existing sub vendor"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"A unique integer value identifying this lab vendor location.","title":"ID"},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_delete","description":"Delete an existing sub vendor"}},"/api/patients/{id}/qrda1":{"get":{"responses":{"200":{"content":{"application/xml":{"schema":{"type":"object","description":"","title":""}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_qrda1","description":"Retrieve patient QRDA1"}},"/api/problems":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientProblem"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"problems_create","description":"Create patient problems"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientProblem"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"problems_list","description":"Retrieve or search patient problems"}},"/api/staff":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Staff"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"staff_list"}},"/api/patient_messages/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","messages:read","messages:write"]}],"operationId":"patient_messages_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","messages:read","messages:write"]}],"operationId":"patient_messages_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientMessage"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","messages:read","messages:write"]}],"operationId":"patient_messages_read"}},"/api/yellow_notepad":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YellowNotepad"}}},"description":"Success - content created/updated"},"405":{"content":{},"description":"Method not allowed"},"404":{"content":{},"description":"Not Found - invalid appointment_id or template_id, or not visible to user"},"403":{"content":{},"description":"Forbidden - insufficient permissions, suspended account, or light suspended account attempting write"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{"application/json":{"examples":{"invalid_params":{"value":["template_id must be an integer"],"summary":"Invalid parameter types"},"missing_content":{"value":{"content":["This field is required."]},"summary":"Missing content field"},"missing_params":{"value":["both appointment_id and template_id must be specified"],"summary":"Missing required parameters"}}}},"description":"Bad Request - missing/invalid parameters or content field"},"409":{"content":{"application/json":{"examples":{"locked_note":{"value":{"detail":"Cannot modify a locked clinical note."},"summary":"Clinical note is locked"}}}},"description":"Conflict - the associated clinical note is locked and cannot be modified"}},"parameters":[{"schema":{"type":"integer","description":"ID of the appointment. Must be visible to the authenticated user.","title":"Appointment ID"},"required":true,"name":"appointment_id","in":"query"},{"schema":{"type":"integer","description":"ID of the clinical note template. Must belong to the authenticated user.","title":"Template ID"},"required":true,"name":"template_id","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"requestBody":{"content":{"application/json":{"schema":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"The yellow notepad content. Can be empty string."}}}}},"required":true},"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"yellow_notepad_create","description":"Create or update yellow notepad content for a specific appointment and template combination.\n\nThis endpoint has different behavior based on the template's workflow_key:\n\nRegular templates (workflow_key != 'hp_meds_allergies'):\n- Automatically includes this template in the note\n- Content is appointment-specific\n\nMedications/Allergies templates (workflow_key == 'hp_meds_allergies'):\n- Content is patient-level (shared across appointments)\n\nBoth appointment_id and template_id must be provided as query parameters.\nContent is normalized to use consistent newline characters.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YellowNotepad"}}},"description":"Success - returns yellow notepad content"},"405":{"content":{},"description":"Method not allowed"},"404":{"content":{},"description":"Not Found - invalid appointment_id or template_id, or not visible to user"},"403":{"content":{},"description":"Forbidden - insufficient permissions or suspended account"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{"application/json":{"examples":{"invalid_params":{"value":["appointment_id must be an integer"],"summary":"Invalid parameter types"},"missing_params":{"value":["both appointment_id and template_id must be specified"],"summary":"Missing required parameters"}}}},"description":"Bad Request - missing or invalid query parameters"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"ID of the appointment. Must be visible to the authenticated user.","title":"Appointment ID"},"required":true,"name":"appointment_id","in":"query"},{"schema":{"type":"integer","description":"ID of the clinical note template. Must belong to the authenticated user.","title":"Template ID"},"required":true,"name":"template_id","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"yellow_notepad_retrieve","description":"Retrieve yellow notepad content for a specific appointment and template combination.\n\nBoth appointment_id and template_id must be provided as query parameters.\n"}},"/api/eligibility_checks":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Coverage"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"appointment_date"},"required":false,"description":"","name":"appointment_date","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"query_date_range"},"required":false,"description":"","name":"query_date_range","in":"query"},{"schema":{"type":"string","description":"","title":"appointment_date_range"},"required":false,"description":"","name":"appointment_date_range","in":"query"},{"schema":{"type":"string","description":"","title":"query_date"},"required":false,"description":"","name":"query_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling","manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","patients:read","patients:write"]}],"operationId":"eligibility_checks_list","description":"Retrieve or search past eligibility checks for patient"}},"/api/doctor_work_schedule/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctor_work_schedule_update","description":"Update an existing doctor's entire work schedule"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctor_work_schedule_partial_update","description":"Update an existing doctor's work schedule"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctor_work_schedule_read","description":"Retrieve a work schedule for the doctor (beta)"}},"/api/medications":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientDrug"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_create","description":"Create patient medications"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientDrug"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_list","description":"Retrieve or search patient medications"}},"/api/custom_demographics":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPatientFieldType"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"custom_demographics_create","description":"Create custom demographics fields"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CustomPatientFieldType"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"custom_demographics_list","description":"Retrieve or search custom demographics fields"}},"/api/appointments_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"}},"parameters":[{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [scheduled_time, updated_at]. Default: scheduled_time.","name":"order_by","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"},{"schema":{"type":"boolean","description":"Include archived or deleted appointments in the response","title":"show_archived"},"required":false,"description":"set to `true` or `1` to include deleted or archived appointments","name":"show_archived","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Appointment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"},{"schema":{"type":"boolean","description":"Include archived or deleted appointments in the response","title":"show_archived"},"required":false,"description":"set to `true` or `1` to include deleted or archived appointments","name":"show_archived","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_list"}},"/api/appointment_profiles":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentProfile"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_create","description":"Create appointment profiles for a doctor's calendar"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/AppointmentProfile"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_list","description":"Retrieve or search appointment profiles for a doctor's calendar"}},"/api/patient_communications":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientCommunication"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_communications_create","description":"Create patient communication for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientCommunication"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_communications_list","description":"Retrieve or search patient communications for CQM"}},"/api/patient_authorizations":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientAuthorization"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"start_date","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"end_date","in":"query"}],"tags":["Billing"],"x-permissions":null,"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":null,"operationId":"patient_authorizations_list","description":"Retrieve or search patient authorizations"}},"/api/appointment_profiles/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_update","description":"Update an existing appointment profile"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_partial_update","description":"Update an existing appointment profile"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentProfile"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_read","description":"Retrieve an existing appointment profile"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_profiles_delete","description":"Delete an existing appointment profile"}},"/api/messages":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DoctorMessage"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_create","description":"Create messages in doctor's message center"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/DoctorMessage"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_list","description":"Retrieve or search messages in doctor's message center"}},"/api/clinical_note_field_values/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"clinical_note_field"},"required":false,"description":"","name":"clinical_note_field","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_values_update","description":"Update an existing clinical note field value"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"clinical_note_field"},"required":false,"description":"","name":"clinical_note_field","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_values_partial_update","description":"Update an existing clinical note field value"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoapNoteLineItemFieldValue"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"clinical_note_field"},"required":false,"description":"","name":"clinical_note_field","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_values_read","description":"Retrieve an existing clinical note field value"}},"/api/task_categories":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCategory"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_categories_create","description":"Create a task category"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TaskCategory"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_categories_list","description":"Retrieve or search task categories"}},"/api/fee_schedules_v2":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/FeeSchedule"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"CSV of payer_ids","title":"payer_id"},"required":false,"name":"payer_id","in":"query"},{"schema":{"type":"string","description":"Name of the plan","title":"plan_name"},"required":false,"name":"plan_name","in":"query"},{"schema":{"type":"string","description":"CSV of specialities","title":"specialities"},"required":false,"name":"specialities","in":"query"},{"schema":{"type":"string","description":"CSV of assignees","title":"assignees"},"required":false,"name":"assignees","in":"query"},{"schema":{"type":"string","description":"Type of fee schedule, individual|speciality","title":"assignee_type"},"required":false,"name":"assignee_type","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"name":"effective_date","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"name":"ineffective_date","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"fee_schedules_v2_list"}},"/api/custom_insurance_plan_names/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomInsurancePlanName"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"user"},"required":false,"description":"","name":"user","in":"query"},{"schema":{"type":"string","description":"","title":"name"},"required":false,"description":"","name":"name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["settings"],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["settings:read","settings:write"]}],"operationId":"custom_insurance_plan_names_read","description":"Retrieve an existing custom insurance plan name"}},"/api/care_team_members":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CareTeamMember"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"care_team_members_list"}},"/api/user_groups":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/UserProfilesGroup"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"user_groups_list","description":"Retrieve or search user groups"}},"/api/line_items_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"In progress\", \"Complete\", \"Failed\", \"Canceled\".\n","title":"status"},"uuid":{"type":"string","description":"UUID of the batch of billing line items.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"Date of billing line item creation","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"Patient associated with the billing line item","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"Office associated with the billing line item","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"},{"schema":{"type":"string","description":"Bounded date range in which the service was rendered","title":"service_date_range"},"required":false,"description":"","name":"service_date_range","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read"]}],"operationId":"line_items_list_create","description":"Create a billing line items list request"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"In progress\", \"Complete\", \"Failed\", \"Canceled\".\n","title":"status"},"results":{"items":{"$ref":"#/components/schemas/BillingLineItem"},"type":"array","description":"result data. only presented when the status is \"completed\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch of billing line items.","title":"uuid"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"required":false,"description":"The UUID token for the batch of patients.  This is returned in the response of the create endpoint.\n","name":"uuid","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read"]}],"operationId":"line_items_list_list","description":"Retrieve the list of billing line items"}},"/api/consent_forms/{id}/unapply_from_appointment":{"post":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_unapply_from_appointment","description":"Unassign (unapply) a consent form from appointment"}},"/api/consent_forms/{id}/apply_to_appointment":{"post":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_apply_to_appointment","description":"Assign (apply) a consent form to appointment"}},"/api/consent_forms":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentForm"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_create","description":"Create a patient consent form"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ConsentForm"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_list","description":"Retrieve or search patient consent forms"}},"/api/reminder_profiles/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_update","description":"Update an existing reminder profile"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_partial_update","description":"Update an existing reminder profile"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderProfile"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_read","description":"Retrieve an existing reminder profile"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_delete","description":"Delete an existing reminder profile"}},"/api/day_sheet_patient_payments":{"get":{"description":"Retrieve daysheet cash report for a given date range","parameters":[{"schema":{"type":"string","description":"Start date of report (M/D/YYYY)","title":"start_date"},"required":true,"name":"start_date","in":"query"},{"schema":{"type":"string","description":"End date of report (M/D/YYYY)","title":"end_date"},"required":true,"name":"end_date","in":"query"},{"schema":{"type":"string","description":"Filters report by scheduled time or date of entry if not provided. Can be one of ('scheduled_time', ' ')","title":"charges_date_type"},"required":false,"name":"charges_date_type","in":"query"},{"schema":{"type":"string","description":"Filters report by given value. Can be one of ('reimbursement_analysis', ' ')","title":"report_type"},"required":false,"name":"report_type","in":"query"},{"schema":{"type":"string","description":"Filters report by professional or institutional claims. Can be one of ('institutional', 'professional', ' ')","title":"claim_type"},"required":false,"name":"claim_type","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given patient ID","title":"patient_id"},"required":false,"name":"patient_id","in":"query"},{"schema":{"type":"string","description":"Filters report by a given office","title":"office"},"required":false,"name":"office","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given examroom ID","title":"examroom_id"},"required":false,"name":"examroom_id","in":"query"},{"schema":{"type":"bool","description":"Enables backward compatibility for legacy version","title":"legacy"},"required":false,"name":"legacy","in":"query"}],"tags":["Billing"],"x-permissions":["billing","access-patient-payments"],"security":[{"drchrono_oauth2":["billing"]}],"operationId":"day_sheet_patient_payments_list"}},"/api/offices/{id}/add_exam_room":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Office"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"offices_add_exam_room","description":"Add an exam room to the office"}},"/api/eligibility_checks/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverage"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"appointment_date"},"required":false,"description":"","name":"appointment_date","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"query_date_range"},"required":false,"description":"","name":"query_date_range","in":"query"},{"schema":{"type":"string","description":"","title":"appointment_date_range"},"required":false,"description":"","name":"appointment_date_range","in":"query"},{"schema":{"type":"string","description":"","title":"query_date"},"required":false,"description":"","name":"query_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling","manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","patients:read","patients:write"]}],"operationId":"eligibility_checks_read","description":"Retrieve an existing past eligibility check"}},"/api/patients_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"In progress\" or \"Complete\".\n","title":"status"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"minimum":1,"type":"integer","description":"Number of results to return per page. Number between 1 and 1000.","maximum":1000,"title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"Filter the list for the patient's first name.","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"Filter the list for the patient's last name.","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"Filter the list for the patient's preferred language.","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"Filter the list for the patient's gender.","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"Filter the list for when the patient was created or updated.  The value should be a date in the format YYYY-MM-DD.  For example, to filter for patients created or updated on or after 2019-01-01, use the value 2019-01-01.\n","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"Filter the list for the patient's date of birth.  The value should be a date in the format YYYY-MM-DD.  For example, to filter for patients born on 2019-01-01, use the value 2019-01-01.\n","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"Filter the list for the patients' race.","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"Filter the list for the patients' chart id.","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"Filter the list for the patients' email.","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"Filter the list for the patients' ethnicity.","name":"ethnicity","in":"query"},{"schema":{"type":"boolean","description":"","title":"ethnicity"},"required":false,"description":"when `true` include additional verbose fields in the response.","name":"verbose","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read"]}],"operationId":"patients_list_create","description":"Submit patient list request.  Use the UUID returned in the response to retrieve the batch of patients.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"In progress\" or \"Complete\".","title":"status"},"results":{"items":{"$ref":"#/components/schemas/Patient"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch request.","title":"uuid"}},"type":"object","description":"Paginated Result","title":""}}},"description":"OK"},"404":{"content":{},"description":"Not Found. The UUID is not found, or, it has expired. UUIDs have a 1 hour lifetime."},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"description":"The UUID token for submitted batch request. This is returned in the response of the create request.\n","required":true,"name":"uuid","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","x-verbose-required":["auto_accident_insurance","custom_demographics","patient_flags","patient_flags_attached","primary_insurance","referring_doctor","secondary_insurance","tertiary_insurance","workers_comp_insurance"],"security":[{"drchrono_oauth2":["patients:read"]}],"operationId":"patients_list_list","description":"Retrieve or search patients in batches. This resource returns identical data to `GET /api/patients` but uses an asynchronous batch-based approach to data delivery. This is an efficient choice for large historical record loading use cases. Retrieve the results/status of a previously created patient_list request using the UUID returned in the response. Results are ordered by patient ID number.\n"}},"/api/patient_interventions":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientIntervention"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_interventions_create","description":"Create patient intervention for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientIntervention"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_interventions_list","description":"Retrieve or search patient interventions for CQM"}},"/api/patient_messages":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientMessage"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","messages:read","messages:write"]}],"operationId":"patient_messages_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientMessage"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","messages:read","messages:write"]}],"operationId":"patient_messages_list"}},"/api/patient_physical_exams/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_physical_exams_update","description":"Update an existing patient physical exam for CQM"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_physical_exams_partial_update","description":"Update an existing patient physical exam for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientPhysicalExam"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_physical_exams_read","description":"Retrieve an existing patient physical exam for CQM"}},"/api/clinical_note_field_values":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoapNoteLineItemFieldValue"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"clinical_note_field"},"required":false,"description":"","name":"clinical_note_field","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_values_create","description":"Create clinical note field value"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/SoapNoteLineItemFieldValue"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_field"},"required":false,"description":"","name":"clinical_note_field","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_values_list","description":"Retrieve or search clinical note field values"}},"/api/inventory_vaccines/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryVaccine"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"inventory_vaccines_read","description":"Retrieve an existing vaccine inventory"}},"/api/patients":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"},{"schema":{"type":"boolean","description":"Set to true to allow duplicate patient creation","title":"allow_duplicates"},"required":false,"description":"Override duplicate check","name":"allow_duplicates","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_create","description":"Create patient"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Patient"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"created_at filter in format YYYY-MM-DD","title":"created_at"},"required":false,"description":"","name":"created_at","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_list","description":"Retrieve or search patients"}},"/api/implantable_devices/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImplantableDevice"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"mu_date"},"required":false,"description":"","name":"mu_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date_range"},"required":false,"description":"","name":"mu_date_range","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"implantable_devices_read","description":"Retrieve an existing implantable device"}},"/api/patient_communications/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_communications_update","description":"Update an existing patient communication for CQM"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_communications_partial_update","description":"Update an existing patient communication for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientCommunication"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_communications_read","description":"Retrieve an existing patient communication for CQM"}},"/api/offices":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Office"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"offices_list","description":"Retrieve or search offices"}},"/api/prescription_messages/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrescriptionMessage"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"parent_message"},"required":false,"description":"","name":"parent_message","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"prescription_messages_read","description":"Retrieve an existing prescription message"}},"/api/implantable_devices":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ImplantableDevice"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date"},"required":false,"description":"","name":"mu_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date_range"},"required":false,"description":"","name":"mu_date_range","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"implantable_devices_list","description":"Retrieve or search implantable devices"}},"/api/patient_risk_assessments":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientRiskAssessment"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_risk_assessments_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientRiskAssessment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_risk_assessments_list"}},"/api/task_statuses/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_statuses_update","description":"Update an existing task status"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_statuses_partial_update","description":"Update an existing task status"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStatus"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_statuses_read","description":"Retrieve an existing task status"}},"/api/patients_summary":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Patient"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_list"}},"/api/documents/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_update","description":"Update an existing appointment template"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_partial_update","description":"Update an existing appointment template"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScannedClinicalDocument"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_read","description":"Retrieve an existing appointment template"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_delete","description":"Delete an existing appointment template"}},"/api/office_work_schedule":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"office_work_schedule_list","description":"Get the work schedule for the authed doctor's primary office (beta)"}},"/api/patients/{id}/onpatient_access":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_onpatient_access_create","description":"Send new onpatient invite to patient"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_onpatient_access_read","description":"Retrieve or search existing onpatient access invites"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_onpatient_access_delete","description":"Revoke sent onpatient invites"}},"/api/comm_logs":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallLog"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"comm_logs_create","description":"Create communication (phone call) logs"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PhoneCallLog"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"comm_logs_list","description":"Retrieve or search communicatioin (phone call) logs"}},"/api/lab_results/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_update","description":"Update an existing lab result"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_partial_update","description":"Update an existing lab result"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabResult"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_read","description":"Retrieve an existing lab result"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_delete","description":"Delete an existing lab result"}},"/api/medications/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_update","description":"Update an existing patient medications"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_partial_update","description":"Update an existing patient medications"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientDrug"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_read","description":"Retrieve an existing patient medications"}},"/api/day_sheet_credits":{"get":{"description":"Retrieve daysheet credits/adjustments report for a given date range","parameters":[{"schema":{"type":"string","description":"Start date of report (M/D/YYYY)","title":"start_date"},"required":true,"name":"start_date","in":"query"},{"schema":{"type":"string","description":"End date of report (M/D/YYYY)","title":"end_date"},"required":true,"name":"end_date","in":"query"},{"schema":{"type":"string","description":"Filters report by posted date or deposit date. Defaults to date of entry if not provided. Can be one of ('credit', 'debit', ' ')","title":"credits_date_type"},"required":false,"name":"credits_date_type","in":"query"},{"schema":{"type":"string","description":"Filters report by given value. Can be one of ('reimbursement_analysis', ' ')","title":"report_type"},"required":false,"name":"report_type","in":"query"},{"schema":{"type":"string","description":"Filters report by professional or institutional claims. Can be one of ('institutional', 'professional', ' ')","title":"claim_type"},"required":false,"name":"claim_type","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given patient ID","title":"patient_id"},"required":false,"name":"patient_id","in":"query"},{"schema":{"type":"string","description":"Filters report by a given office","title":"office"},"required":false,"name":"office_id","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given examroom ID","title":"examroom_id"},"required":false,"name":"examroom_id","in":"query"},{"schema":{"type":"boolean","description":"Runs report for all providers in the practice group","title":"pg_mode"},"required":false,"name":"pg_mode","in":"query"}],"tags":["Billing"],"x-permissions":["billing","access-patient-payments"],"security":[{"drchrono_oauth2":["billing"]}],"operationId":"daysheet_credits_list"}},"/api/task_templates":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskTemplate"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_templates_create","description":"Create a task template"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TaskTemplate"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_templates_list","description":"Retrieve or search task templates"}},"/api/transactions_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request. Upon creation this will be \"In progress\"","title":"status"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","title":"Page size"},"description":"Number of results to return per page. Value between 1 and 1000.","required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","title":"page"},"description":"Number of page to return. Value between 1 and max number of pages in result set.","required":false,"name":"page","in":"query"},{"schema":{"type":"integer","title":"line_item"},"description":"Line item ID","required":false,"name":"line_item","in":"query"},{"schema":{"type":"string","title":"posted_date"},"description":"Posted date","required":false,"name":"posted_date","in":"query"},{"schema":{"type":"integer","title":"appointment"},"description":"appointment","required":false,"name":"appointment","in":"query"},{"schema":{"type":"string","title":"since"},"description":"since","required":false,"name":"since","in":"query"},{"schema":{"type":"integer","title":"doctor"},"description":"doctor","required":false,"name":"doctor","in":"query"},{"schema":{"type":"boolean","title":"verbose"},"description":"When True includes full details","required":false,"name":"verbose","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"transactions_list_create","description":"Create transactions list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"In progress\" or \"Complete\".\n","title":"status"},"pagination":{"properties":{"count":{"type":"int","description":"the count of all records in the result set.","title":"count"},"pages":{"type":"int","description":"the total pages of all pages in the result set.","title":"pages"},"page":{"type":"int","description":"the current page (starting with 1) in the total pages.","title":"page"}},"type":"object","description":"information on the total pages, current page and total count.","title":"pagination"},"results":{"items":{"$ref":"#/components/schemas/LineItemTransaction"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch.","title":"uuid"}}}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The UUID token for the batch of transactions","title":"uuid"},"required":true,"description":"The UUID token for the batch of transactions.  This is returned in the response of the `create` endpoint.\n","name":"uuid","in":"query"}],"tags":["Billing"],"x-permissions":["billing"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"transactions_list_list","description":"Retrieve or search transactions in batches. Results returned in order of ID or updated_at."}},"/api/medications/{id}/append_to_pharmacy_note":{"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"medications_append_to_pharmacy_note","description":"Append a message to the \"pharmacy_note\" section of the prescription, in a new paragraph"}},"/api/office_work_schedule/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"office_work_schedule_update","description":"Update an existing office's entire work schedule"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"office_work_schedule_partial_update","description":"Update an existing office's work schedule"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"office_work_schedule_read","description":"Retrieve a work schedule (beta)"}},"/api/patient_vaccine_records/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\", \"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_vaccine_records_update","description":"Update an existing patient vaccine records"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\", \"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_vaccine_records_partial_update","description":"Update an existing patient vaccine records"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientVaccineRecord"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\", \"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_vaccine_records_read","description":"Retrieve an existing patient vaccine records"}},"/api/patient_flag_types/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"patient_flag_types_update","description":"Update an existing patient flag type"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"patient_flag_types_partial_update","description":"Update an existing patient flag type"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientFlagType"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"patient_flag_types_read","description":"Retrieve an existing patient flag type"}},"/api/inventory_categories/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryCategory"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"inventory_categories_read","description":"Retrieve an existing inventory category"}},"/api/clinical_note_field_types/{id}":{"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"freedraw_image_size":{"enum":["","150x300","300x600","450x900","600x1200","750x1500"],"type":"string","description":"Size setting for the free-draw image field:\n  - \"\" = Actual size (native resolution)\n  - \"150x300\" = Extra Small\n  - \"300x600\" = Small\n  - \"450x900\" = Medium\n  - \"600x1200\" = Large\n  - \"750x1500\" = Extra Large\n"}}}}},"required":true},"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_types_update","description":"Update the `freedraw_image_size` of an existing clinical note FreeDraw Field"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoapNoteLineItemFieldType"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_types_read","description":"Retrieve an existing clinial note field type"}},"/api/tasks/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_date"},"required":false,"description":"","name":"due_at_date","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_unknown"},"required":false,"description":"","name":"due_at_unknown","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_since"},"required":false,"description":"","name":"due_at_since","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_range"},"required":false,"description":"","name":"due_at_range","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"tasks_update","description":"Update an existing task"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_date"},"required":false,"description":"","name":"due_at_date","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_unknown"},"required":false,"description":"","name":"due_at_unknown","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_since"},"required":false,"description":"","name":"due_at_since","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_range"},"required":false,"description":"","name":"due_at_range","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"tasks_partial_update","description":"Update an existing task"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_date"},"required":false,"description":"","name":"due_at_date","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_unknown"},"required":false,"description":"","name":"due_at_unknown","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_since"},"required":false,"description":"","name":"due_at_since","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_range"},"required":false,"description":"","name":"due_at_range","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"tasks_read","description":"Retrieve an existing task"}},"/api/doctor_work_schedule":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"doctor_work_schedule_list","description":"Get the work schedule for the authed doctor's primary office (beta)"}},"/api/doctor_options":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/DoctorOptions"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctor_options_list","description":"Retrieve or search doctor options within practice group"}},"/api/fee_schedules":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/DoctorFeeSchedule"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"code"},"required":false,"description":"","name":"code","in":"query"},{"schema":{"type":"string","description":"","title":"code_type"},"required":false,"description":"","name":"code_type","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"payer_id"},"required":false,"description":"","name":"payer_id","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_fee_schedules\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"fee_schedules_list"}},"/api/patient_risk_assessments/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_risk_assessments_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_risk_assessments_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientRiskAssessment"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_risk_assessments_read"}},"/api/inventory_categories":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/InventoryCategory"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"inventory_categories_list","description":"Retrieve or search inventory categories"}},"/api/lab_documents/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_update","description":"Update an existing lab order document"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_partial_update","description":"Update an existing lab order document"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabOrderDocument"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_read","description":"Retrieve an existing lab order document"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_delete","description":"Delete an existing lab order document"}},"/api/appointment_templates/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_update","description":"Update an existing appointment template"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_partial_update","description":"Update an existing appointment template"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentTemplate"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_read","description":"Retrieve an existing appointment template"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_delete","description":"Delete an existing appointment template"}},"/api/patient_interventions/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_interventions_update","description":"Update an existing patient intervention for CQM"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_interventions_partial_update","description":"Update an existing patient intervention for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientIntervention"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_interventions_read","description":"Retrieve an existing patient intervention for CQM"}},"/api/task_statuses":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStatus"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_statuses_create","description":"Create a task status"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TaskStatus"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_statuses_list","description":"Retrieve or search task statuses"}},"/api/allergies/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"allergies_update","description":"Update an existing patient allergy"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"allergies_partial_update","description":"Update an existing patient allergy"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAllergy"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"allergies_read","description":"Retrieve an existing patient allergy"}},"/api/patients/{id}/ccda":{"get":{"responses":{"200":{"content":{"application/xml":{"schema":{"type":"object","description":"","title":""}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_ccda","description":"Retrieve patient CCDA"}},"/api/patient_payments/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashPayment"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["access-patient-payments","billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:patient-payment:read","billing:patient-payment:write"]}],"operationId":"patient_payments_read","description":"Retrieve an existing patient payment"}},"/api/lab_orders_summary":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabOrder"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"lab_orders_summary_list"}},"/api/patient_payments":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashPayment"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["access-patient-payments","billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:patient-payment:read","billing:patient-payment:write"]}],"operationId":"patient_payments_create","description":"Create patient payment"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CashPayment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["access-patient-payments","billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:patient-payment:read","billing:patient-payment:write"]}],"operationId":"patient_payments_list","description":"Retrieve or search patient payments"}},"/api/clinical_note_field_values_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request. Upon creation this will be \"In progress\"","title":"status"},"uuid":{"type":"string","description":"UUID of the batch.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID","title":"description"}}}}},"description":"Created"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page. Value between 1 and 20000.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"Number of page to return. Value between 1 and max number of pages in result set.","title":"Page"},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","description":"Inclusive lower bound on updated_at","title":"since"},"required":false,"name":"since","in":"query"},{"schema":{"type":"integer","description":"Appointment ID filter","title":"appointment"},"required":false,"name":"appointment","in":"query"},{"schema":{"type":"integer","description":"ID of clinical note report template","title":"clinical_note_template"},"required":false,"name":"clinical_note_template","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","patients:read"]}],"operationId":"clinical_note_field_values_list_create","description":"Create clinical note field value list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of ID.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"Complete\" or \"In progress\".\n","title":"status"},"pagination":{"properties":{"count":{"type":"int","description":"the count of all records in the result set.","title":"count"},"pages":{"type":"int","description":"the total pages of all pages in the result set.","title":"pages"},"page":{"type":"int","description":"the current page (starting with 1) in the total pages.","title":"page"}},"type":"object","description":"information on the total pages, current page and total count.","title":"pagination"},"results":{"items":{"$ref":"#/components/schemas/SoapNoteLineItemFieldValue"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"}}}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"required":false,"description":"The UUID token for the batch of requested data. This is returned in the response of the `create` endpoint.\n","name":"uuid","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read"]}],"operationId":"clinical_note_field_values_list_list","description":"Retrieve or search clinical note values (soap notes) in batches. Results returned in order of ID or by updated_at."}},"/api/care_plans/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarePlan"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"plan_type"},"required":false,"description":"","name":"plan_type","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"care_plans_read","description":"Retrieve an existing care plan"}},"/api/billing_profiles":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/BillingProfile"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_billing_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"billing_profiles_list","description":"Retrieve or search billing profiles"}},"/api/billing_profiles/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfile"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_billing_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"billing_profiles_read","description":"Retrieve an existing billing profiles"}},"/api/availability":{"get":{"description":"Retrieve availability slots for the given date and office, doctor, or exam room.","parameters":[{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"integer","description":"","title":"duration"},"required":false,"description":"","name":"duration","in":"query"}],"operationId":"availability"}},"/api/task_templates/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_templates_update","description":"Update an existing task template"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_templates_partial_update","description":"Update an existing task template"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskTemplate"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_templates_read","description":"Retrieve an existing task template"}},"/api/fee_schedules/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DoctorFeeSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"code"},"required":false,"description":"","name":"code","in":"query"},{"schema":{"type":"string","description":"","title":"code_type"},"required":false,"description":"","name":"code_type","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"payer_id"},"required":false,"description":"","name":"payer_id","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_fee_schedules\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"fee_schedules_read"}},"/api/appointments/{id}":{"put":{"responses":{"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Appointment ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_update","description":"Update an existing appointment or break"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Appointment ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_partial_update","description":"Update an existing appointment or break"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_read","description":"Retrieve an existing appointment or break"},"delete":{"responses":{"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Appointment ID. Can be in the form of date_id where date is the day of the appointment and ID is the recurring appointment ID. If not recurring this is just the ID number.","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_delete","description":"Delete an existing appointment or break"}},"/api/telehealth_appointments":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemedicineAppointment"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointments_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TelemedicineAppointment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointments_list"}},"/api/care_plans":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CarePlan"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"plan_type"},"required":false,"description":"","name":"plan_type","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"care_plans_list","description":"Retrieve or search care plans"}},"/api/patient_physical_exams":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientPhysicalExam"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_physical_exams_create","description":"Create patient physical exam for CQM"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientPhysicalExam"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_physical_exams_list","description":"Retrieve or search patient physical exams for CQM"}},"/api/line_item_deletions":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"results":{"items":{"$ref":"#/components/schemas/BillingLineItemDeletion"},"type":"array","description":"Result data","title":"data"},"next":{"type":"string","description":"Next paginated page","title":"next"}}}}}},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The datetime to query by","title":"since"},"required":false,"name":"since","in":"query"},{"schema":{"type":"integer","description":"The original appointment ID to filter results by","title":"appointment_id"},"required":false,"name":"appointment_id","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read"]}],"operationId":"line_item_deletions_list","description":"Retrieve or search billing line item deletions. When a billing line item is deleted, a record of its original ID and the appointment it was attached to will be logged and is accessible from this resource.\n"}},"/api/signed_consent_forms/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedConsentForm"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"description":"Retrieve a single signed consent form record by id","x-permissions":["manage-patients"],"summary":"signed_consent_forms Read","x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"signed_consent_forms_read"}},"/api/clinical_note_templates/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoapNoteCustomReport"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_templates_read","description":"Retrieve an existing clinical note tempalte"}},"/api/transactions":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LineItemTransaction"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"line_item"},"required":false,"description":"","name":"line_item","in":"query"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"transactions_list","description":"Retrieve or search insurance transactions associated with billing line items"}},"/api/lab_results":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabResult"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_create","description":"Create lab results. An example lab workflow is as following:\n\n- When you get orders, submit them via `/api/lab_orders`, such that doctors can see them in drchrono.\n\n- When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results`\n\n- Update `/api/lab_orders` status\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabResult"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_results_list","description":"Retrieve or search lab results"}},"/api/custom_insurance_plan_names":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CustomInsurancePlanName"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"user"},"required":false,"description":"","name":"user","in":"query"},{"schema":{"type":"string","description":"","title":"name"},"required":false,"description":"","name":"name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["settings"],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["settings:read","settings:write"]}],"operationId":"custom_insurance_plan_names_list","description":"Retrieve or search custom insurance plan names"}},"/api/problems/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"problems_update","description":"Update an existing patient problems"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"problems_partial_update","description":"Update an existing patient problems"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientProblem"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"problems_read","description":"Retrieve an existing patient problems"}},"/api/amendments":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAmendment"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_create","description":"Create patient amendments to a patient's clinical records"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientAmendment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_list","description":"Retrieve or search patient amendments. You can only interact with amendments created by your API application"}},"/api/lab_orders":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabOrder"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_create","description":"Create lab orders. An example lab workflow is as following:\n\n- When you get orders, submit them via `/api/lab_orders`, such that doctors can see them in drchrono.\n\n- When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results`\n\n- Update `/api/lab_orders` status\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabOrder"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_orders_list","description":"Retrieve or search lab orders"}},"/api/doctors/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Doctor"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctors_read","description":"Retrieve an existing doctor"}},"/api/patient_flag_types":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientFlagType"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"patient_flag_types_create","description":"Create patient flag types"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientFlagType"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"patient_flag_types_list","description":"Retrieve or search patient flag types"}},"/api/day_sheet_totals":{"get":{"description":"Retrieve daysheet totals report for a given date range","parameters":[{"schema":{"type":"string","description":"Start date of report (M/D/YYYY)","title":"start_date"},"required":true,"name":"start_date","in":"query"},{"schema":{"type":"string","description":"End date of report (M/D/YYYY)","title":"end_date"},"required":true,"name":"end_date","in":"query"},{"schema":{"type":"string","description":"Filters report by scheduled time or date of entry if not provided. Can be one of ('scheduled_time', ' ')","title":"charges_date_type"},"required":false,"name":"charges_date_type","in":"query"},{"schema":{"type":"string","description":"Filters report by given value. Can be one of ('reimbursement_analysis', ' ')","title":"report_type"},"required":false,"name":"report_type","in":"query"},{"schema":{"type":"string","description":"Filters report by date of service if receives value of 'check' otherwise defaults to posted date. Can be one of ('check', ' ')","title":"credits_date_type"},"required":false,"name":"credits_date_type","in":"query"},{"schema":{"type":"string","description":"Groups data","title":"group_by"},"required":false,"name":"group_by","in":"query"},{"schema":{"type":"string","description":"Sub-groups data","title":"sub_group_by"},"required":false,"name":"sub_group_by","in":"query"},{"schema":{"type":"string","description":"Tertiary Groups data","title":"tertiary_group_by"},"required":false,"name":"tertiary_group_by","in":"query"},{"schema":{"type":"string","description":"Includes moved cash if value of 'simple' is passed. Can be one of ('simple', ' ')","title":"cash_view_type"},"required":false,"name":"cash_view_type","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given patient ID","title":"patient_id"},"required":false,"name":"patient_id","in":"query"},{"schema":{"type":"string","description":"Filters report by a given office","title":"office_id"},"required":false,"name":"office_id","in":"query"},{"schema":{"type":"integer","description":"Filters report by a given examroom ID","title":"examroom_id"},"required":false,"name":"examroom_id","in":"query"},{"schema":{"type":"boolean","description":"Runs report for all providers in the practice group","title":"pg_mode"},"required":false,"name":"pg_mode","in":"query"}],"tags":["Billing"],"x-permissions":["billing","access-patient-payments"],"security":[{"drchrono_oauth2":["billing"]}],"operationId":"daysheet_totals_list"}},"/api/custom_appointment_fields/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_appointment_fields_update","description":"Update an existing custom appointment field"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_appointment_fields_partial_update","description":"Update an existing custom appointment field"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAppointmentFieldType"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_appointment_fields_read","description":"Retrieve an existing custom appointment field"}},"/api/eobs":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EOBObject"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"eobs_create","description":"Create EOB object"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/EOBObject"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"eobs_list","description":"Retrieve or search EOB objects"}},"/api/users/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"users_read","description":"Retrieve an existing user, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`"}},"/api/insurances":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Insurance"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":""},"required":true,"description":"One of `\"emdeon\"`, `\"gateway\"`, `\"ihcfa\"`","name":"payer_type","in":"query"},{"schema":{"type":"string","description":"","title":""},"required":false,"description":"Search term, which can be either a partial name, partial ID or the state.","name":"term","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"insurances_list"}},"/api/telehealth_appointment_history":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemedicineAppointmentEventLog"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointment_history_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TelemedicineAppointmentEventLog"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointment_history_list"}},"/api/task_notes":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskNote"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"task"},"required":false,"description":"","name":"task","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_notes_create","description":"Create a task note"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/TaskNote"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"task"},"required":false,"description":"","name":"task","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_notes_list","description":"Retrieve or search task notes"}},"/api/tasks":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_date"},"required":false,"description":"","name":"due_at_date","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_unknown"},"required":false,"description":"","name":"due_at_unknown","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_since"},"required":false,"description":"","name":"due_at_since","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_range"},"required":false,"description":"","name":"due_at_range","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"tasks_create","description":"Create a task"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Task"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"category"},"required":false,"description":"","name":"category","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_date"},"required":false,"description":"","name":"due_at_date","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_unknown"},"required":false,"description":"","name":"due_at_unknown","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_since"},"required":false,"description":"","name":"due_at_since","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_user"},"required":false,"description":"","name":"assignee_user","in":"query"},{"schema":{"type":"integer","description":"","title":"assignee_group"},"required":false,"description":"","name":"assignee_group","in":"query"},{"schema":{"type":"string","description":"","title":"due_at_range"},"required":false,"description":"","name":"due_at_range","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"tasks_list","description":"Retrieve or search tasks"}},"/api/patients_summary/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_read"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:summary:read","patients:summary:write"]}],"operationId":"patients_summary_delete"}},"/api/lab_documents":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabOrderDocument"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_create","description":"Create lab order documents. An example lab workflow is as following:\n\n- When you get orders, submit them via `/api/lab_orders`, such that doctors can see them in drchrono.\n\n- When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results`\n\n- Update `/api/lab_orders` status\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabOrderDocument"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_documents_list","description":"Retrieve or search lab order documents"}},"/api/consent_forms/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_update","description":"Update an existing patient consent form"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_partial_update","description":"Update an existing patient consent form"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentForm"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_consent_forms\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"consent_forms_read","description":"Retrieve an existing patient consent form"}},"/api/lab_tests/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_update","description":"Update an existing lab test"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_partial_update","description":"Update an existing lab test"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabTest"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_read","description":"Retrieve an existing lab test"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_delete","description":"Delete an existing lab test"}},"/api/prescription_messages_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request. Upon creation this will be \"In progress\"","title":"status"},"uuid":{"type":"string","description":"UUID of the batch.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","title":"Page size"},"description":"Number of results to return per page. Value between 1 and 1000.","required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","title":"page"},"description":"Number of page to return. Value between 1 and max number of pages in result set.","required":false,"name":"page","in":"query"},{"schema":{"type":"string","title":"since"},"description":"Inclusive lower bound on record updated/created time","required":false,"name":"since","in":"query"},{"schema":{"type":"integer","title":"patient"},"description":"Patient ID filter","required":false,"name":"patient","in":"query"},{"schema":{"type":"integer","title":"doctor"},"description":"Prescribing doctor ID filter","required":false,"name":"doctor","in":"query"},{"schema":{"type":"string","title":"created_at"},"description":"Filter on specific creation date","required":false,"name":"created_at","in":"query"},{"schema":{"type":"integer","title":"parent_message"},"description":"Filter on associated parent prescription message ID","required":false,"name":"parent_message","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"prescription_messages_list_create","description":"Create prescription messages list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"Complete\" or \"In progress\".\n","title":"status"},"pagination":{"properties":{"count":{"type":"int","description":"the count of all records in the result set.","title":"count"},"pages":{"type":"int","description":"the total pages of all pages in the result set.","title":"pages"},"page":{"type":"int","description":"the current page (starting with 1) in the total pages.","title":"page"}},"type":"object","description":"information on the total pages, current page and total count.","title":"pagination"},"results":{"items":{"$ref":"#/components/schemas/PrescriptionMessage"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch.","title":"uuid"}}}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"required":false,"description":"The UUID token for the batch of prescription messages.  This is returned in the response of the `create` endpoint.\n","name":"uuid","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read"]}],"operationId":"prescription_messages_list_list","description":"Retrieve or search prescription messages in batches. Results returned in order of ID or updated_at."}},"/api/patients/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_update","description":"Update an existing patient"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_partial_update","description":"Update an existing patient"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_read","description":"Retrieve an existing patient"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_delete","description":"Delete an existing patient"}},"/api/patients/{id}/ccda_async":{"get":{"responses":{"200":{"content":{"application/xml":{"schema":{"type":"object","description":"","title":""}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"first_name"},"required":false,"description":"","name":"first_name","in":"query"},{"schema":{"type":"string","description":"","title":"last_name"},"required":false,"description":"","name":"last_name","in":"query"},{"schema":{"type":"string","description":"","title":"preferred_language"},"required":false,"description":"","name":"preferred_language","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"gender"},"required":false,"description":"","name":"gender","in":"query"},{"schema":{"type":"string","description":"","title":"created_at"},"required":false,"description":"","name":"created_at","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_of_birth"},"required":false,"description":"","name":"date_of_birth","in":"query"},{"schema":{"type":"string","description":"","title":"race"},"required":false,"description":"","name":"race","in":"query"},{"schema":{"type":"string","description":"","title":"chart_id"},"required":false,"description":"","name":"chart_id","in":"query"},{"schema":{"type":"string","description":"","title":"email"},"required":false,"description":"","name":"email","in":"query"},{"schema":{"type":"string","description":"","title":"ethnicity"},"required":false,"description":"","name":"ethnicity","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"patients_ccda_async","description":"Retrieve patient CCDA async."}},"/api/custom_vitals":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CustomVitalType"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes","settings"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write","settings:read","settings:write"]}],"operationId":"custom_vitals_list","description":"Retrieve or search custom vital types"}},"/api/schedule_blocks":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"description":"Created"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request - Invalid data (e.g., start_time must be before end_time)"}},"tags":["Clinical"],"description":"Create a new schedule block to block off time on a provider's calendar. This prevents appointments from being scheduled during the specified time period. Use this to block time for lunch breaks, meetings, administrative tasks, PTO, or other activities.","x-permissions":["calendar"],"summary":"Create a schedule block","requestBody":{"content":{"application/json":{"examples":{"pto":{"value":{"description":"PTO - Personal Day","office":200,"color":"#9B59B6","start_time":"2024-04-01T08:00:00","end_time":"2024-04-01T17:00:00","provider":100},"summary":"Create a PTO (paid time off) schedule block"},"lunchBreak":{"value":{"description":"Lunch Break","office":200,"color":"#FF5733","start_time":"2024-03-15T12:00:00","exam_room":1,"end_time":"2024-03-15T13:00:00","provider":100},"summary":"Create a lunch break schedule block"},"staffMeeting":{"value":{"description":"Staff Meeting - Q1 Review","office":200,"color":"#3498DB","start_time":"2024-03-20T14:00:00","end_time":"2024-03-20T15:30:00","provider":100},"summary":"Create a staff meeting schedule block"}},"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"required":true},"security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ScheduleBlock"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"ID of the provider or doctor","title":"doctor"},"required":false,"description":"Filter by doctor/provider ID","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"ID of the office","title":"office"},"required":false,"description":"Filter by office ID","name":"office","in":"query"},{"schema":{"type":"string","description":"Specific date to filter schedule blocks","title":"date"},"required":false,"description":"Filter by specific date (YYYY-MM-DD format)","name":"date","in":"query"},{"schema":{"type":"string","description":"Inclusive date range to filter schedule blocks","title":"date_range"},"required":false,"description":"Filter by date range (YYYY-MM-DD/YYYY-MM-DD format)","name":"date_range","in":"query"}],"tags":["Clinical"],"description":"Retrieve or search schedule blocks. Schedule blocks are used to block off time on a provider's calendar to prevent appointments from being scheduled. Use this to retrieve existing blocks for lunch breaks, meetings, PTO, or other non-appointment activities. Either `date` or `date_range` parameter is recommended for efficient querying.","x-permissions":["calendar"],"summary":"Retrieve and search schedule blocks","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_list"}},"/api/care_team_members/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CareTeamMember"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"care_team_members_read"}},"/api/claim_billing_notes/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimBillingNotes"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"claim_billing_notes_read","description":"Retrieve an existing billing note"}},"/api/inventory_vaccines":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryVaccine"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"inventory_vaccines_create","description":"Create vaccine inventory"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/InventoryVaccine"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"inventory_vaccines_list","description":"Retrieve or search vaccine inventories"}},"/api/transactions/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemTransaction"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"line_item"},"required":false,"description":"","name":"line_item","in":"query"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"transactions_read","description":"Retrieve an existing insurance transaction"}},"/api/procedures":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Procedure"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date"},"required":false,"description":"","name":"mu_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date_range"},"required":false,"description":"","name":"mu_date_range","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"procedures_list"}},"/api/patient_lab_results/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientLabResultSet"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_read"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_delete"}},"/api/amendments/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_update","description":"Update an existing patient amendment, you can only interact with amendments created by your API application"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_partial_update","description":"Update an existing patient amendment, you can only interact with amendments created by your API application"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAmendment"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_read","description":"Retrieve an existing patient amendment, you can only interact with amendments created by your API application"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"amendments_delete","description":"Delete an existing patient amendment, you can only interact with amendments created by your API application"}},"/api/lab_tests":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabTest"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_create","description":"Create lab tests. An example lab workflow is as following:\n\n- When you get orders, submit them via `/api/lab_orders`, such that doctors can see them in drchrono.\n\n- When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results`\n\n- Update `/api/lab_orders` status\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabTest"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"order"},"required":false,"description":"","name":"order","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"lab_tests_list","description":"Retrieve or search lab tests"}},"/api/appointments_list/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_read"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list_delete"}},"/api/patient_lab_results":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientLabResultSet"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_create"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientLabResultSet"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"ordering_doctor"},"required":false,"description":"","name":"ordering_doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["labs:read","labs:write","patients:read","patients:write"]}],"operationId":"patient_lab_results_list"}},"/api/task_categories/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_categories_update","description":"Update an existing task category"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_categories_partial_update","description":"Update an existing task category"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCategory"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_categories_read","description":"Retrieve an existing task category"}},"/api/fee_schedules_v2/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeSchedule"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"fee_schedules_v2_read"}},"/api/insurances/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Insurance"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":""},"required":true,"description":"One of `\"emdeon\"`, `\"gateway\"`, `\"ihcfa\"`","name":"payer_type","in":"query"},{"schema":{"type":"string","description":"","title":""},"required":false,"description":"Search term, which can be either a partial name, partial ID or the state.","name":"term","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"insurances_read"}},"/api/clinical_notes":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ClinicalNote"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"created_at filter in format YYYY-MM-DD","title":"created_at"},"required":false,"description":"","name":"created_at","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_notes_list"}},"/api/eligibility_checks_list":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"status":{"type":"string","description":"Status of the request. Upon creation this will be \"In progress\"","title":"status"},"uuid":{"type":"string","description":"UUID of the batch of patients.","title":"uuid"},"description":{"type":"string","description":"Contains link to load the batch by UUID"}}}}},"description":"Created"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","title":"order_by"},"required":false,"description":"Order results by a specific field. Valid options include [id, updated_at]. Default: id.","name":"order_by","in":"query"},{"schema":{"type":"integer","title":"Page size"},"description":"Number of results to return per page. Value between 1 and 1000.","required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","title":"page"},"description":"Number of page to return. Value between 1 and max number of pages in result set.","required":false,"name":"page","in":"query"},{"schema":{"type":"string","title":"since"},"description":"Inclusive lower bound on record updated/created time","required":false,"name":"since","in":"query"},{"schema":{"type":"integer","title":"patient"},"description":"Patient ID filter","required":false,"name":"patient","in":"query"},{"schema":{"type":"string","title":"appointment_date_range"},"description":"Inclusive bounded date range on appointment scheduled date","required":false,"name":"appointment_date_range","in":"query"},{"schema":{"type":"string","title":"appointment_date"},"description":"Filter on specific appointment scheduled date","required":false,"name":"appointment_date","in":"query"},{"schema":{"type":"string","title":"date_range"},"description":"Inclusive bounded date range on eligibility check date","required":false,"name":"query_date_range","in":"query"},{"schema":{"type":"string","title":"query_date"},"description":"Filter on specific eligibility check date","required":false,"name":"query_date","in":"query"},{"schema":{"type":"string","title":"service_types"},"description":"Filter for checks included within a comma-separated list of service type codes (STCs)","required":false,"name":"service_types","in":"query"},{"schema":{"type":"boolean","title":"verbose"},"description":"When True includes full coverage details","required":false,"name":"verbose","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"eligibility_checks_list_create","description":"Create eligibility checks list request.  Use the UUID returned in the response to retrieve the batch of records. Results returned in order of id or updated_at.\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"status":{"type":"string","description":"Status of the request.  Possible values are \"Complete\" or \"In progress\".\n","title":"status"},"pagination":{"properties":{"count":{"type":"int","description":"the count of all records in the result set.","title":"count"},"pages":{"type":"int","description":"the total pages of all pages in the result set.","title":"pages"},"page":{"type":"int","description":"the current page (starting with 1) in the total pages.","title":"page"}},"type":"object","description":"information on the total pages, current page and total count.","title":"pagination"},"results":{"items":{"$ref":"#/components/schemas/Coverage"},"type":"array","description":"result data. only presented when the status is \"Complete\"","title":"data"},"uuid":{"type":"string","description":"UUID of the batch.","title":"uuid"}}}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncResourceError"}}},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"uuid"},"required":false,"description":"The UUID token for the batch of eligibility checks.  This is returned in the response of the `create` endpoint.\n","name":"uuid","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","patients:read"]}],"operationId":"eligibility_checks_list_list","description":"Retrieve or search eligibility checks in batches. Results returned in order of ID or updated_at."}},"/api/telehealth_appointment_history/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemedicineAppointmentEventLog"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointment_history_read"}},"/api/clinical_notes/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClinicalNote"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_notes_read"}},"/api/clinical_note_field_types":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/SoapNoteLineItemFieldType"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"clinical_note_template"},"required":false,"description":"","name":"clinical_note_template","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_field_types_list","description":"Retrieve or search clinical note field types"}},"/api/documents":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScannedClinicalDocument"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_create","description":"Create documents"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ScannedClinicalDocument"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write"]}],"operationId":"documents_list","description":"Retrieve or search documents"}},"/api/staff/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Staff"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"staff_read"}},"/api/users":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/UserProfile"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"users_list","description":"Retrieve or search users, `/api/users/current` can be used to identify logged in user, it will redirect to `/api/users/{current_user_id}`"}},"/api/schedule_blocks/{id}":{"put":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"description":"OK - Schedule block updated"},"204":{"content":{},"description":"No Content - Schedule block updated (alternative response)"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request - Invalid data or missing required fields"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Schedule block ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"description":"Update an existing schedule block. Unlike PATCH, PUT requires all fields to be provided. Use this when you want to completely replace the schedule block data.","x-permissions":["calendar"],"summary":"Update a schedule block","requestBody":{"content":{"application/json":{"examples":{"fullUpdate":{"value":{"description":"Early Lunch - Staff Training","office":200,"color":"#16A085","start_time":"2024-03-15T11:00:00","exam_room":1,"end_time":"2024-03-15T12:30:00","provider":100},"summary":"Complete update of schedule block"}},"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"required":true},"security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_update"},"patch":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"description":"OK - Schedule block updated"},"204":{"content":{},"description":"No Content - Schedule block updated (alternative response)"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request - Invalid data"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Schedule block ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"description":"Partially update an existing schedule block. You can modify the time, description, color, or other properties. Use this to reschedule a block or change its details.","x-permissions":["calendar"],"summary":"Partially update a schedule block","requestBody":{"content":{"application/json":{"examples":{"updateExamRoom":{"value":{"exam_room":4},"summary":"Update exam room association"},"updateTime":{"value":{"start_time":"2024-03-15T12:30:00","end_time":"2024-03-15T13:30:00"},"summary":"Update schedule block time"},"updateDescription":{"value":{"color":"#E74C3C","description":"Extended Lunch Break - Team Building"},"summary":"Update schedule block description and color"}},"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"required":true},"security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleBlock"}}},"description":"OK"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Schedule block ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"description":"Retrieve an existing schedule block by ID","x-permissions":["calendar"],"summary":"Retrieve a schedule block","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_read"},"delete":{"responses":{"500":{"content":{},"description":"Internal Server Error"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"204":{"content":{},"description":"No Content - Schedule block successfully deleted"},"401":{"content":{},"description":"Unauthorized"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"description":"Schedule block ID","required":true,"name":"id","in":"path"}],"tags":["Clinical"],"description":"Delete an existing schedule block. This will remove the block from the provider's calendar and allow appointments to be scheduled during that time period again.","x-permissions":["calendar"],"summary":"Delete a schedule block","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"schedule_blocks_delete"}},"/api/lab_orders_summary/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabOrder"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"lab_orders_summary_read"}},"/api/audit_log":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/AuditLog"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"","name":"date_range","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"","name":"date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"user"},"required":false,"description":"","name":"user","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"},{"schema":{"type":"string","description":"","title":"action"},"required":false,"description":"","name":"action","in":"query"}],"tags":["Audit"],"x-permissions":null,"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read"]}],"operationId":"audit_log_list","description":"Retrieve or search audit logs.\n<b>Note:</b> Either `since`, `date` or `date_range` parameter must be specified.\n            "}},"/api/task_notes/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"task"},"required":false,"description":"","name":"task","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_notes_update","description":"Update an existing task note"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"task"},"required":false,"description":"","name":"task","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_notes_partial_update","description":"Update an existing task note"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskNote"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"task"},"required":false,"description":"","name":"task","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["tasks:read","tasks:write"]}],"operationId":"task_notes_read","description":"Retrieve an existing task note"}},"/api/custom_demographics/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"custom_demographics_update","description":"Update an existing custom demographics field"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"custom_demographics_partial_update","description":"Update an existing custom demographics field"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPatientFieldType"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["manage-patients","settings"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["patients:read","patients:write","settings:read","settings:write"]}],"operationId":"custom_demographics_read","description":"Retrieve an existing custom demographics field"}},"/api/messages/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_update","description":"Update an existing message in doctor's message center"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_partial_update","description":"Update an existing message in doctor's message center"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DoctorMessage"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_read","description":"Retrieve an existing message in doctor's message center"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"integer","description":"","title":"responsible_user"},"required":false,"description":"","name":"responsible_user","in":"query"},{"schema":{"type":"string","description":"","title":"updated_since"},"required":false,"description":"","name":"updated_since","in":"query"},{"schema":{"type":"string","description":"","title":"received_since"},"required":false,"description":"","name":"received_since","in":"query"},{"schema":{"type":"integer","description":"","title":"owner"},"required":false,"description":"","name":"owner","in":"query"},{"schema":{"type":"string","description":"","title":"type"},"required":false,"description":"","name":"type","in":"query"}],"tags":["Practice Management"],"x-permissions":["message-center"],"x-practice-access":"\"share_communications\" need to be set for data access among practice","security":[{"drchrono_oauth2":["messages:read","messages:write"]}],"operationId":"messages_delete","description":"Delete an existing message in doctor's message center"}},"/api/eobs/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EOBObject"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"eobs_read","description":"Retrieve an existing EOB object"}},"/api/doctor_options/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DoctorOptions"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctor_options_read","description":"Retrieve existing options for a doctor"}},"/api/allergies":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientAllergy"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"allergies_create","description":"Create patient allergy"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientAllergy"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"allergies_list","description":"Retrieve or search patient allergies"}},"/api/appointments":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":"Created"},"403":{"content":{},"description":"Permission Denied"},"409":{"content":{},"description":"Scheduled time overlaps with an existing appointment"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_create","description":"Create a new appointment or break on doctor's calendar"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Appointment"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"403":{"content":{},"description":"Permission Denied"},"500":{"content":{},"description":"Internal Server Error"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"minimum":1,"type":"integer","description":"Number of results to return per page.","maximum":250,"title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"status"},"required":false,"description":"Appointment status name","name":"status","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"Patient ID","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"Office ID","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"Doctor ID","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"Lower bound inclusive date filter for appointment updated/created date","name":"since","in":"query"},{"schema":{"type":"string","description":"Filter appointments based on scheduled time","title":"occurred_since"},"required":false,"description":"Filter appointments based on scheduled time","name":"occurred_since","in":"query"},{"schema":{"type":"string","description":"","title":"date_range"},"required":false,"description":"Inclusive upper and lower bound filter for appointment scheduled date. Format: yyyy-mm-dd/yyyy-mm-dd. Max window size 190 days","name":"date_range","in":"query"},{"schema":{"type":"boolean","description":"","title":"verbose"},"required":false,"description":"set to `true` to include clinical_note, custom_fields, custom_vitals, extended_updated_at, reminders, status_transitions, vitals but limit page_size to 25","name":"verbose","in":"query"},{"schema":{"type":"string","description":"","title":"date"},"required":false,"description":"Specific date filter for appointment scheduled date","name":"date","in":"query"},{"schema":{"type":"boolean","description":"Do not include virtual appointments that have not yet been materialized.  This is useful when you need to get a list of appointments that are materialized and ready to be used.","title":"ignore_virtual"},"required":false,"description":"set to `true` to ignore virtual appointments that have not yet been materialized","name":"ignore_virtual","in":"query"},{"schema":{"type":"boolean","description":"Include archived or deleted appointments in the response","title":"show_archived"},"required":false,"description":"set to `true` or `1` to include deleted or archived appointments","name":"show_archived","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"appointments_list","description":"Retrieve or search appointment or breaks.\n<b>Note:</b> Either `since`, `occurred_since`, `date` or `date_range` parameter must be specified.\n          results returned in order of scheduled date.\n            "}},"/api/procedures/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Procedure"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"mu_date"},"required":false,"description":"","name":"mu_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"mu_date_range"},"required":false,"description":"","name":"mu_date_range","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"procedures_read"}},"/api/clinical_note_templates":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/SoapNoteCustomReport"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_clinical_templates\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"clinical_note_templates_list","description":"Retrieve or search clinical note templates"}},"/api/line_items/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingLineItem"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"},{"schema":{"type":"string","description":"Bounded date range in which the service was rendered","title":"service_date_range"},"required":false,"description":"","name":"service_date_range","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_read","description":"Retrieve an existing billing line item"},"delete":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_delete"}},"/api/doctors":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/Doctor"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"doctors_list","description":"Retrieve or search doctors within practice group"}},"/api/reminder_profiles":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderProfile"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_create","description":"Create reminder profile"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/ReminderProfile"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling"],"x-practice-access":"\"share_reminder_profile\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"reminder_profiles_list","description":"Retrieve or search reminder profiles"}},"/api/patient_payment_log":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/CashPaymentLog"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"patient_payment_log_list","description":"Retrieve or search patient payment logs"}},"/api/offices/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"offices_update","description":"Update an existing office"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"offices_partial_update","description":"Update an existing office"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Office"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Practice Management"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["user:read","user:write"]}],"operationId":"offices_read","description":"Retrieve an existing office"}},"/api/patient_payment_log/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashPaymentLog"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"patient_payment_log_read","description":"Retrieve an existing patient payment log"}},"/api/appointment_templates":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentTemplate"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_create","description":"Create appointment templates for a doctor's calendar"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/AppointmentTemplate"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The date for which the template is available.  The week day will be set to the week day of the date specified.  Format: yyyy-mm-dd","title":"Available"},"required":false,"name":"available","in":"query"},{"schema":{"items":{"type":"integer","description":"","title":""},"type":"array","description":"Array of integers that indicate week days in ISO Format (`0` = Monday, ..., `6` = Sunday)","title":"Week days"},"required":false,"name":"week_days","in":"query"},{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"profile"},"required":false,"description":"","name":"profile","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","settings"],"x-practice-access":"\"share_appointment_profiles\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","settings:read","settings:write"]}],"operationId":"appointment_templates_list","description":"Retrieve or search appointment templates for a doctor's calendar"}},"/api/patient_vaccine_records":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientVaccineRecord"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\", \"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_vaccine_records_create","description":"Create patient vaccine records"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PatientVaccineRecord"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"","title":"cvx_code"},"required":false,"description":"","name":"cvx_code","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_inventory\", \"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"patient_vaccine_records_list","description":"Retrieve or search patient vaccine records"}},"/api/telehealth_appointments/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointments_update"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointments_partial_update"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemedicineAppointment"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["scheduling","clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write","clinical:read","clinical:write"]}],"operationId":"telehealth_appointments_read"}},"/api/comm_logs/{id}":{"put":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"comm_logs_update","description":"Update an existing communication (phone call) logs"},"patch":{"responses":{"204":{"content":{},"description":"No Content"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"comm_logs_partial_update","description":"Update an existing communication (phone call) logs"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneCallLog"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Billing"],"x-permissions":["scheduling"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["calendar:read","calendar:write"]}],"operationId":"comm_logs_read","description":"Retrieve an existing communication (phone call) logs"}},"/api/prescription_messages":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/PrescriptionMessage"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"integer","description":"","title":"parent_message"},"required":false,"description":"","name":"parent_message","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"string","description":"created_at filter in format YYYY-MM-DD","title":"created_at"},"required":false,"description":"","name":"created_at","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Clinical"],"x-permissions":["clinical-notes"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["clinical:read","clinical:write"]}],"operationId":"prescription_messages_list","description":"Retrieve or search prescription messages"}},"/api/user_groups/{id}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfilesGroup"}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":""},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"}],"tags":["Administrative"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":[]}],"operationId":"user_groups_read","description":"Retrieve an existing user group"}},"/api/line_items":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingLineItem"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_create","description":"Create billing line item for appointments"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/BillingLineItem"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"string","description":"date of line_item creation","title":"posted_date"},"required":false,"description":"","name":"posted_date","in":"query"},{"schema":{"type":"integer","description":"","title":"patient"},"required":false,"description":"","name":"patient","in":"query"},{"schema":{"type":"integer","description":"","title":"office"},"required":false,"description":"","name":"office","in":"query"},{"schema":{"type":"integer","description":"","title":"doctor"},"required":false,"description":"","name":"doctor","in":"query"},{"schema":{"type":"string","description":"","title":"since"},"required":false,"description":"","name":"since","in":"query"},{"schema":{"type":"integer","description":"","title":"appointment"},"required":false,"description":"","name":"appointment","in":"query"},{"schema":{"type":"string","description":"Date on which the service was rendered","title":"service_date"},"required":false,"description":"","name":"service_date","in":"query"}],"tags":["Billing"],"x-permissions":["billing","show-billing-tab"],"x-practice-access":"\"share_patients\" need to be set for data access among practice","security":[{"drchrono_oauth2":["billing:read","billing:write"]}],"operationId":"line_items_list","description":"Retrieve or search billing line items"}},"/api/sublabs":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabVendorLocation"}}},"description":"Created"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_create","description":"Create sub-vendors\n\n- When you get orders, submit them via `/api/lab_orders`, such that doctors can see them in drchrono.\n\n- When results come in, submit the result document PDF via `/api/lab_documents` and submit the results data via `/api/lab_results`\n\n- Update `/api/lab_orders` status\n"},"get":{"responses":{"200":{"content":{"application/json":{"schema":{"title":"","type":"object","description":"Paginated Result","properties":{"previous":{"type":"string","description":"Previous paginated page","title":"previous"},"data":{"items":{"$ref":"#/components/schemas/LabVendorLocation"},"type":"array","description":"result data","title":"data"},"next":{"type":"string","description":"Next Paginated page","title":"next"}}}}},"description":"OK"},"405":{"content":{},"description":"Method Not Allowed"},"404":{"content":{},"description":"Not Found"},"403":{"content":{},"description":"Permission Denied"},"401":{"content":{},"description":"Unauthorized"},"400":{"content":{},"description":"Bad Request"},"500":{"content":{},"description":"Internal Server Error"}},"parameters":[{"schema":{"type":"string","description":"The pagination cursor value.","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","description":"Number of results to return per page.","title":"Page size"},"required":false,"name":"page_size","in":"query"}],"tags":["Clinical"],"x-permissions":[],"x-practice-access":"Data access among practice is available","security":[{"drchrono_oauth2":["labs:read","labs:write"]}],"operationId":"sublabs_list","description":"Retrieve or search sub vendors"}}},"tags":[{"description":"Create and manage administrative resources","name":"Administrative"},{"description":"Search Audit Logs","name":"Audit"},{"description":"Create and manage clinical resources","name":"Clinical"},{"description":"Create and manage billing resources","name":"Billing"},{"description":"Create and manage practice management resources","name":"Practice Management"}],"servers":[{"url":"https://app.drchrono.com"}],"components":{"securitySchemes":{"drchrono_oauth2":{"type":"oauth2","description":"","flows":{"authorizationCode":{"scopes":{"billing:patient-payment:read":"View patient payment information","billing:read":"View billing information.","patients:read":"View detailed patient information.","user:write":"Edit select account information, such as creating new exam rooms.","messages:write":"Create and modify messages in your message center.","messages:read":"View messages in your message center.","tasks:write":"Create and modify tasks in your tasks center","tasks:read":"View tasks in your tasks center","labs:write":"Create and modify patient lab orders and results.","patients:write":"Create patients and modify detailed patient information.","settings:write":"Create resources that requires Settings permission, such as custom fields.","billing:patient-payment:write":"Modify patient payment information","clinical:write":"Create and modify clinical information, such as vitals, clinical notes, medications and diagnoses.","patients:summary:write":"Create new patients and set their name, chart_id, age, and gender.","calendar:read":"View your appointments.","user:read":"View your basic information.","billing:write":"Modify billing information.","settings:read":"View resources that requires Settings permission, such as custom fields.","labs:read":"View patient lab orders and results.","calendar:write":"Schedule appointments and modify the data associated with them.","patients:summary:read":"View summary information about your patients. This includes patients' name, chart_id, age, and gender.","clinical:read":"View clinical information, such as vitals, clinical notes, medications and diagnoses."},"tokenUrl":"https://app.drchrono.com/o/token/","authorizationUrl":"https://app.drchrono.com/o/authorize/"}}}},"schemas":{"AppointmentProfile":{"x-verbose-required":[],"required":["name","color","online_scheduling"],"type":"object","description":"Appointment profiles are for common kinds of appointments a doctor might have, such as \"physical exam\", which have a standard duration and should show up as the same color on the calendar.","properties":{"archived":{"readOnly":true,"type":"boolean","description":"Indicates that the object has been soft-deleted and should not be used","title":"Archived"},"name":{"type":"string","description":"","title":"Name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"color":{"type":"string","description":"","title":"Color"},"reason":{"type":"string","description":"","title":"Reason"},"sort_order":{"type":"integer","description":"Override the usual ordering ordering of appointments in the patient's appointments page. Lower values are shown at the top","title":"Sort order"},"duration":{"type":"integer","description":"Length of an appointment in minutes","title":"Duration"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"online_scheduling":{"type":"boolean","description":"Whether this profile should be available for online scheduling","title":"Online scheduling"}}},"CarePlan":{"required":[],"type":"object","properties":{"code":{"readOnly":true,"type":"string","description":"","title":"Code"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"description":{"readOnly":true,"type":"string","description":"","title":"Description"},"title":{"readOnly":true,"type":"string","description":"","title":"Title"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"plan_type":{"readOnly":true,"enum":["1","2","3","4","5","6"],"type":"string","description":"Can be one of the following: `1`(Goal), `2`(Patient education), `3`(Patient decision aid), `4`(Patient clinical instruction), `5`(Referral to other doctor), `6`(Health concerns)","title":"Plan type"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"scheduled_date":{"readOnly":true,"type":"string","description":"","title":"Scheduled date"},"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"code_system":{"readOnly":true,"type":"string","description":"","title":"Code system"},"instructions":{"readOnly":true,"type":"string","description":"","title":"Instructions"}},"x-verbose-required":[]},"WorkDay":{"type":"object","properties":{"iso_weekday":{"type":"string","description":"Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday","title":"ISO weekday"},"enabled":{"type":"boolean","description":"whether the work day is enabled","title":"Enabled"},"id":{"readOnly":true,"type":"integer","description":"unique ID of the work day","title":"ID"},"work_hours":{"items":{"$ref":"#/components/schemas/WorkHours"},"type":"array","description":"work hours of the work day","title":"Work hours"}}},"FeeScheduleItem":{"required":[],"type":"object","properties":{"code_type":{"enum":["CPT","HCPCS","Custom","ICD9","ICD10","Revenue"],"type":"string","description":"","title":"Code type"},"insured_out_of_network_price":{"type":"number","description":"","title":"Insured out of network price"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"code":{"type":"string","description":"","title":"Code"},"billing_description":{"type":"string","description":"","title":"Billing description"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"picklist_category":{"type":"string","description":"Optional: Category to organize the code into.","title":"Picklist category"},"allowed_amount":{"type":"number","description":"Typical allowed amount for payer. Not used if blank.","title":"Allowed amount"},"ndc_quantity":{"type":"number","description":"","title":"NDC Quantity"},"cash_price":{"type":"number","description":"","title":"Cash price"},"plan_name":{"type":"string","description":"Name of insurance plan.","title":"Plan name"},"description":{"type":"string","description":"","title":"Description"},"ndc_units":{"enum":["F2","GR","ME","ML","UN"],"type":"string","description":"","title":"NDC Units"},"ndc_code":{"type":"string","description":"","title":"NDC Code"},"payer_id":{"type":"string","description":"Fee Schedule pricing specific to this payer, if null, then applies as default to all payers without a more specific fee schedule.","title":"Payer id"},"cpt_hcpcs_modifier2":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #2"},"cpt_hcpcs_modifier3":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #3"},"cpt_hcpcs_modifier1":{"type":"string","description":"","title":"Cpt hcpcs modifier1"},"cpt_hcpcs_modifier4":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #4"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"doctor":{"type":"integer","description":"","title":"Doctor"},"insured_price":{"type":"number","description":"","title":"Insured price"},"base_price":{"type":"number","description":"","title":"Base price"}},"x-verbose-required":[]},"PatientFlagType":{"required":["doctor","name"],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"Indicates the flag type is soft-deleted and should not be used","title":"Archived"},"name":{"type":"string","description":"Name of the patient flag type","title":"Name"},"doctor":{"type":"integer","description":"Doctor who owns the flag type","title":"Doctor"},"color":{"type":"string","description":"","title":"Color"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"priority":{"type":"integer","description":"Priority of the flag type","title":"Priority"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"Doctor":{"required":[],"type":"object","properties":{"website":{"type":"string","description":"","title":"Website"},"doctor_work_schedule":{"$ref":"#/components/schemas/WorkSchedule","description":"Doctor work schedule (beta)","title":"Doctor Work Schedule"},"first_name":{"type":"string","description":"","title":"First name"},"last_name":{"type":"string","description":"","title":"Last name"},"suffix":{"type":"string","description":"","title":"Suffix"},"profile_picture":{"readOnly":true,"type":"string","description":"","title":"Profile picture"},"country":{"enum":["BD","WF","BF","BG","BA","BB","BE","BL","BM","BN","BO","JP","BI","BJ","BT","JM","BV","JO","WS","BQ","BR","BS","JE","BY","BZ","RU","RW","RS","TL","RE","TM","TJ","RO","TK","GW","GU","GT","GS","GR","GQ","GP","BH","GY","GG","GF","GE","GD","GB","GA","GN","GM","GL","KW","GI","GH","OM","TN","BW","HR","HT","HU","HK","HN","HM","KR","AD","PR","PS","PW","PT","KN","PY","AI","PA","PF","PG","PE","PK","PH","PN","PL","PM","ZM","EH","EE","EG","ZA","EC","AL","AO","KZ","ET","ZW","KY","ES","ER","ME","MD","MG","MF","MA","MC","UZ","MM","ML","MO","MN","MH","MK","MU","MT","MW","MV","MQ","MP","MS","MR","AU","UG","MY","MX","MZ","FR","AW","AF","AX","FI","FJ","FK","FM","FO","NI","NL","NO","NA","VU","NC","NE","NF","NG","NZ","NP","NR","NU","CK","CI","CH","CO","CN","CM","CL","CC","CA","CG","CF","CD","CZ","CY","CX","CR","KP","CW","CV","CU","SZ","SY","SX","KG","KE","SS","SR","KI","KH","SV","KM","ST","SK","SJ","SI","SH","SO","SN","SM","SL","SC","SB","SA","SG","SE","SD","DO","DM","DJ","DK","DE","YE","AT","DZ","US","UY","YT","UM","LB","LC","LA","TV","TW","TT","TR","LK","LI","LV","TO","LT","LU","LR","LS","TH","TF","TG","TD","TC","LY","VA","VC","AE","VE","AG","VG","IQ","VI","IS","IR","AM","IT","VN","AQ","AS","AR","IM","IL","IO","IN","TZ","AZ","IE","ID","UA","QA"],"type":"string","description":"Two-letter country code. Default is `US`","title":"Country"},"practice_group_name":{"readOnly":true,"type":"string","description":"","title":"Practice group name"},"specialty":{"type":"string","description":"","title":"Specialty"},"is_account_suspended":{"type":"boolean","description":"Indicates the doctor's account is suspended or not","title":"Is account suspended"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"office_phone":{"type":"string","description":"","title":"Office phone"},"npi_number":{"type":"string","description":"If both this field and `group_npi_number` are set, prefer this field","title":"Npi number"},"group_npi_number":{"type":"string","description":"","title":"Group npi number"},"home_phone":{"type":"string","description":"","title":"Home phone"},"practice_group":{"readOnly":true,"type":"string","description":"The ID of the practice group this user belongs to. This can be used to identify users in the same practice.","title":"Practice group"},"timezone":{"type":"string","description":"","title":"Timezone"},"cell_phone":{"type":"string","description":"","title":"Cell phone"},"email":{"readOnly":true,"type":"string","description":"","title":"Email"},"job_title":{"enum":["","Provider/Staff (Private Practice)","Provider/Staff (Hospital)","Patients/Interview Candidate","Educator/Student","API/Developer","Consultant","Other"],"type":"string","description":"","title":"Job title"}},"x-verbose-required":[]},"AsyncResourceError":{"properties":{"status":{"type":"string","description":"Either \"Error\" or \"Failed\"","title":"Status"},"uuid":{"type":"string","description":"The UUID used to get the data for the asynchronous request","title":"UUID"},"detail":{"type":"string","description":"Instructions on what to do next","title":"Detail"}}},"BillingProfile":{"required":[],"type":"object","properties":{"cpt_codes":{"items":{"title":"","type":"object","description":"CPT Code object","properties":{"diagnosis_pointers_icd9":{"items":{"type":"string","description":"","title":""},"type":"array","description":"ICD9 codes represented in strings","title":"Diagnosis pointers icd9"},"code":{"type":"string","description":"","title":"Code"},"price":{"type":"string","description":"This field is represented in string format","title":"Price"},"ndc_code":{"items":{"title":"","type":"object","description":"NDC code object","properties":{"ndc_package_code":{"type":"string","description":"","title":"Ndc package code"},"units":{"enum":["F2","GR","ME","ML","UN"],"type":"string","description":"Can be one of `F2`(International Unit), `GR`(Gram), `ME`(Milligram), `ML`(Millimeter) or `UN`(Unit)","title":"Units"},"quantity":{"type":"string","description":"","title":"Quantity"}}},"type":"array","description":"Array of NDC Code objects","title":"Ndc code"},"diagnosis_pointers_icd10":{"items":{"type":"string","description":"","title":""},"type":"array","description":"ICD10 codes represented in strings","title":"Diagnosis pointers icd10"},"modifiers":{"items":{"type":"string","description":"","title":""},"type":"array","description":"Modifiers represented in strings","title":"Modifiers"},"quantity":{"type":"string","description":"This field is represented in string format","title":"Quantity"}}},"readOnly":true,"type":"array","description":"Array of CPT Code objects","title":"Cpt codes"},"archived":{"readOnly":true,"type":"boolean","description":"","title":"Archived"},"icd9_codes":{"items":{"type":"string","description":"ICD9 Code in string format","title":""},"readOnly":true,"type":"array","description":"ICD9 Codes represented in string format","title":"Icd9 codes"},"name":{"type":"string","description":"","title":"Name"},"hcpcs_codes":{"items":{"title":"","type":"object","description":"HCPCS code object","properties":{"diagnosis_pointers_icd9":{"items":{"type":"string","description":"ICD9 Code in string format","title":""},"type":"array","description":"ICD9 codes represented in array of strings","title":"Diagnosis pointers icd9"},"code":{"type":"string","description":"","title":"Code"},"price":{"type":"string","description":"This field is represented in string format","title":"Price"},"ndc_code":{"items":{"title":"","type":"object","description":"NDC code object","properties":{"ndc_package_code":{"type":"string","description":"","title":"Ndc package code"},"units":{"enum":["F2","GR","ME","ML","UN"],"type":"string","description":"Can be one of `F2`(International Unit), `GR`(Gram), `ME`(Milligram), `ML`(Millimeter) or `UN`(Unit)","title":"Units"},"quantity":{"type":"string","description":"","title":"Quantity"}}},"type":"array","description":"Array of NDC Code objects","title":"Ndc code"},"diagnosis_pointers_icd10":{"items":{"type":"string","description":"ICD Code in string format","title":""},"type":"array","description":"ICD10 codes represented in array of strings","title":"Diagnosis pointers icd10"},"modifiers":{"items":{"type":"string","description":"Modifier in string format","title":""},"type":"array","description":"Modifiers represented in array of strings","title":"Modifiers"},"quantity":{"type":"string","description":"This field is represented in string format","title":"Quantity"}}},"readOnly":true,"type":"array","description":"Array of HCPCS Code objects","title":"Hcpcs codes"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"custom_procedure_codes":{"items":{"title":"","type":"object","description":"Custom procedure code object","properties":{"price":{"type":"string","description":"This field is represented in string format","title":"Price"},"code":{"type":"string","description":"","title":"Code"},"quantity":{"type":"string","description":"This field is represented in string format","title":"Quantity"}}},"readOnly":true,"type":"array","description":"Array of custom procedure code objects","title":"Custom procedure codes"},"icd10_codes":{"items":{"type":"string","description":"ICD10 Code in string format","title":""},"readOnly":true,"type":"array","description":"ICD10 Codes represented in string format","title":"Icd10 codes"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"CashPaymentLog":{"required":[],"type":"object","properties":{"appointment":{"readOnly":true,"type":"string","description":"ID of appointment associated with the payment","title":"Appointment"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"payment_method":{"enum":["DRCP","CASH","CHCK","DBIT","CRDT","AMEX","VISA","MSTR","DISC","SQR1","SQRE","PTPA","ONPT","OTHR"],"type":"string","description":"`\"CASH\", \"CHCK\" for Check, \"DBIT\" for Debit, \"CRDT\" for Credit Card, \"AMEX\" for American Express, \"VISA\", \"MSTR\" for Mastercard, \"DISC\" for Discover, \"SQR1\" for Square (legacy), \"SQRE\" for Square, \"PTPA\" for Patient Payments, \"ONPT\" for onpatient, \"OTHR\" for Other`","title":"Payment method"},"updated_at":{"type":"string","description":"","title":"Updated at"},"created_by":{"readOnly":true,"type":"string","description":"ID of user who created the payment","title":"Created by"},"source":{"type":"string","description":"","title":"Source"},"amount":{"type":"number","description":"","title":"Amount"},"action":{"enum":["C","U","D","F","A"],"type":"string","description":"`C`(Create), `U`(Update), `D`(Delete), `F`(Fill), `A`(Autofill)","title":"Action"},"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"TelemedicineAppointmentEventLog":{"required":[],"type":"object","properties":{"timestamp":{"readOnly":true,"type":"string","description":"","title":"Timestamp"},"description":{"readOnly":true,"type":"string","description":"","title":"Description"},"event_type":{"readOnly":true,"type":"string","description":"","title":"Event type"}},"x-verbose-required":[]},"YellowNotepad":{"required":["appointment_id","template_id","content"],"type":"object","properties":{"content":{"type":"string","description":"The yellow notepad text content","title":"Content"},"template_id":{"readOnly":true,"type":"integer","description":"ID of the associated clinical note template","title":"Template ID"},"appointment_id":{"readOnly":true,"type":"integer","description":"ID of the associated appointment","title":"Appointment ID"}}},"PatientMessage":{"required":["doctor","patient","subject"],"type":"object","properties":{"body":{"type":"string","description":"","title":"Body"},"patient":{"type":"integer","description":"","title":"Patient"},"attachments":{"items":{"title":"PatientMessageAttachment","type":"object","description":"","properties":{"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"attachment":{"type":"string","description":"","title":"Attachment"},"doctor":{"type":"integer","description":"","title":"Doctor"}}},"type":"array","description":"","title":"Attachments"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"message":{"readOnly":true,"type":"string","description":"","title":"Message"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"subject":{"type":"string","description":"","title":"Subject"}},"x-verbose-required":[]},"ScheduleBlock":{"example":{"description":"Lunch Break","office":200,"color":"#FF5733","practice_group":1,"start_time":"2024-03-15T12:00:00","exam_room":1,"series":null,"end_time":"2024-03-15T13:00:00","provider":100,"id":12345,"appointment_break":null},"required":["provider","office","start_time","end_time"],"type":"object","description":"Schedule blocks are used to block off time on a provider's calendar, preventing appointments from being scheduled during those times. They can be associated with a specific provider, office, and exam room. Common use cases include blocking time for lunch breaks, meetings, administrative tasks, PTO, or other non-appointment activities.","properties":{"description":{"type":"string","description":"Description or reason for the schedule block (e.g., \"Lunch Break\", \"Staff Meeting\", \"PTO\")","title":"Description"},"office":{"type":"integer","description":"ID of the office where the schedule block is applied","title":"Office"},"color":{"type":"string","description":"Custom color associated with the schedule block for calendar display","title":"Color"},"practice_group":{"type":"integer","description":"ID of the practice group for the associated provider (doctor)","title":"Practice group"},"start_time":{"format":"date-time","type":"string","description":"Start time of the schedule block in ISO 8601 format","title":"Start time"},"exam_room":{"type":"integer","description":"ID of the exam room where the schedule block is applied","title":"Exam room"},"series":{"type":"integer","description":"Series ID if the schedule block is part of a recurring series","title":"Series"},"end_time":{"format":"date-time","type":"string","description":"End time of the schedule block in ISO 8601 format","title":"End time"},"provider":{"type":"integer","description":"ID of the provider or doctor who owns this schedule block","title":"Provider"},"id":{"readOnly":true,"type":"integer","description":"Unique identifier for the schedule block","title":"ID"},"appointment_break":{"readOnly":true,"type":"integer","description":"ID of an associated appointment break, if applicable","title":"Appointment break"}}},"CustomAppointmentFieldType":{"required":[],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"Indicates that the object has been soft-deleted and should not be used","title":"Archived"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"order":{"readOnly":true,"type":"integer","description":"displayed order in patient's demographic page","title":"Order"},"field_desc":{"type":"string","description":"Description of the custom field","title":"Field desc"},"field_name":{"type":"string","description":"","title":"Field name"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"UserProfilesGroup":{"required":[],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"Group is archived or not","title":"Archived"},"name":{"readOnly":true,"type":"string","description":"","title":"Name"},"practice_group":{"readOnly":true,"type":"string","description":"Practice group this user group belongs to","title":"Practice group"},"created_at":{"type":"string","description":"","title":"Created at"},"updated_at":{"type":"string","description":"","title":"Updated at"},"members":{"items":{"type":"string","description":"ID of `/api/users`","title":""},"readOnly":true,"type":"array","description":"Users in this user group.","title":"Members"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"UserProfile":{"required":[],"type":"object","properties":{"username":{"type":"string","description":"","title":"Username"},"doctor":{"readOnly":true,"type":"string","description":"For staff members, this is their primary physician's ID. For doctors, it is their own ID.","title":"Doctor"},"practice_group":{"readOnly":true,"type":"string","description":"The ID of the practice group this user belongs to. This can be used to identify users in the same practice.","title":"Practice group"},"is_doctor":{"readOnly":true,"type":"string","description":"Mutually exclusive with `is_staff`","title":"Is doctor"},"is_staff":{"readOnly":true,"type":"string","description":"Mutually exclusive with `is_doctor`","title":"Is staff"},"id":{"readOnly":true,"type":"string","description":"","title":"Id"},"permissions":{"readOnly":true,"type":"string","description":"Permissions the user has.","title":"Permissions"}},"x-verbose-required":[]},"PatientCommunication":{"required":["doctor","patient"],"type":"object","properties":{"value_name":{"readOnly":true,"type":"string","description":"Description of value","title":"Value name"},"value_code_system":{"type":"string","description":"Can be `SNOMEDCT`, `ICD10CM`, `LOINC`","title":"Value code system"},"code":{"type":"string","description":"Code from different code system","title":"Code"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"name":{"readOnly":true,"type":"string","description":"","title":"Name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"effective_time":{"type":"string","description":"","title":"Effective time"},"value_code":{"type":"string","description":"Code from different code system represent communication value","title":"Value code"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"code_system":{"type":"string","description":"Can be `SNOMEDCT`, `LOINC`","title":"Code system"}},"x-verbose-required":[]},"Appointment":{"required":["doctor","exam_room","office","patient","scheduled_time"],"type":"object","properties":{"status":{"enum":["","Arrived","Checked In","Checked In Online","In Room","In Session","Complete","Confirmed","Not Confirmed","Rescheduled","Cancelled","No Show"],"type":"string","description":"One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses.","title":"Status"},"icd9_codes":{"items":{"type":"string","description":"","title":""},"type":"array","description":"","title":"ICD9 Codes"},"office":{"type":"integer","description":"Office ID","title":"Office"},"base_recurring_appointment":{"readOnly":true,"type":"string","description":"ID of base appointment of a recurring series","title":"Base recurring appointment"},"color":{"type":"string","description":"","title":"Color"},"vitals":{"title":"SystemVitals","type":"object","description":"Clinical vitals associated with the appointment","properties":{"height_units":{"type":"string","description":"","title":"Height units"},"weight_units":{"type":"string","description":"","title":"Weight units"},"pain":{"type":"string","description":"0-10 pain scale.","title":"Pain"},"temperature":{"type":"number","description":"","title":"Temperature"},"weight":{"type":"number","description":"","title":"Weight"},"smoking_status":{"enum":["blank","449868002","428041000124106","8517006","266919005","77176002","266927001","428071000124103","428061000124105"],"type":"string","description":"","title":"Smoking status"},"head_circumference":{"type":"number","description":"","title":"Head circumference"},"bmi":{"readOnly":true,"type":"string","description":"","title":"Bmi"},"head_circumference_units":{"type":"string","description":"","title":"Head circumference units"},"blood_pressure_2":{"type":"integer","description":"","title":"Blood pressure 2"},"blood_pressure_1":{"type":"integer","description":"","title":"Blood pressure 1"},"height":{"type":"number","description":"","title":"Height"},"pulse":{"type":"integer","description":"Beats per minute.","title":"Pulse"},"oxygen_saturation":{"type":"number","description":"","title":"Oxygen saturation"},"respiratory_rate":{"type":"integer","description":"Breathes per minute.","title":"Respiratory rate"},"temperature_units":{"type":"string","description":"","title":"Temperature units"}}},"first_billed_date":{"readOnly":true,"type":"string","description":"","title":"First billed date"},"last_billed_date":{"readOnly":true,"type":"string","description":"","title":"Last billed date"},"billing_status":{"type":"string","description":"Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status","title":"Billing status"},"primary_insurer_payer_id":{"readOnly":true,"type":"string","description":"","title":"Primary insurer payer id"},"duration":{"type":"integer","description":"Length of the appointment in minutes. Optional if `profile` is provided.","title":"Duration"},"appt_is_break":{"type":"boolean","description":"","title":"Appt is break"},"id":{"readOnly":true,"type":"string","description":"Unique identifier. Usually numeric, but not always","title":"Id"},"custom_fields":{"items":{"title":"CustomAppointmentFieldValue","type":"object","description":"","properties":{"field_type":{"type":"integer","description":"","title":"Field type"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"field_value":{"type":"string","description":"","title":"Field value"}}},"type":"array","description":"Custom appointment fields","title":"Custom fields"},"scheduled_time":{"type":"string","description":"The starting time of the appointment","title":"Scheduled time"},"secondary_insurer_name":{"readOnly":true,"type":"string","description":"","title":"Secondary insurer name"},"doctor":{"type":"integer","description":"Doctor ID","title":"Doctor"},"recur_start_date":{"type":"string","description":"For recurring appointments, the start date of the recurring series","title":"Recur start date"},"primary_insurance_id_number":{"readOnly":true,"type":"string","description":"","title":"Primary insurance id number"},"created_by":{"readOnly":true,"type":"string","description":"","title":"Created by"},"ins2_status":{"readOnly":true,"enum":["","Incomplete Information","In Process Emdeon","Rejected Emdeon","Rejected EPS","Rejected Jopari","In Process Payor","Rejected Waystar Professional","Rejected Waystar Institutional","In Process Payer","Payer Acknowledged","Rejected Payor","Rejected Payer","Paid in Full","Partially Paid","Coordination of Benefits","ERA Received","ERA Denied","HCFA Form Faxed"],"type":"string","description":"Billing status of secondary insurer","title":"Ins2 status"},"first_edi_date":{"readOnly":true,"type":"string","description":"","title":"First edi date"},"billing_notes":{"items":{"title":"ClaimBillingNotes","type":"object","description":"Structure of a billing note","properties":{"text":{"type":"string","description":"Content of the note","title":"Text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"appointment":{"type":"integer","description":"","title":"Appointment"},"id":{"readOnly":true,"type":"integer","description":"ID of the billing note","title":"ID"},"created_by":{"readOnly":true,"type":"string","description":"","title":"Created by"}}},"readOnly":true,"type":"array","description":"Billing notes of the appointment. For writing, check `/api/claim_billing_notes`","title":"Billing notes"},"is_walk_in":{"type":"boolean","description":"Whether the appointment is a walk-in appointment","title":"Is walk in"},"billing_provider":{"type":"string","description":"","title":"Billing provider"},"reminder_profile":{"type":"string","description":"Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders.","title":"Reminder profile"},"primary_insurer_name":{"readOnly":true,"type":"string","description":"","title":"Primary insurer name"},"profile":{"type":"integer","description":"ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly.","title":"Profile"},"resubmit_claim_original_id":{"type":"integer","description":"ID of this claim id.","title":"resubmit_claim_original_id"},"patient":{"type":"integer","description":"ID of this appointment's patient. Breaks have a null patient field.","title":"Patient"},"cloned_from":{"type":"integer","description":"ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned.","title":"Cloned From"},"extended_updated_at":{"readOnly":true,"type":"string","description":"The most recent update time among appointment itself, its vitals and its custom vitals","title":"Extended updated at"},"exam_room":{"type":"integer","description":"Index of the exam room that this appointment occurs in. See `/api/offices`","title":"Exam room"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"reason":{"type":"string","description":"Default to `\"\"`","title":"Reason"},"last_edi_date":{"readOnly":true,"type":"string","description":"","title":"Last edi date"},"secondary_insurer_payer_id":{"readOnly":true,"type":"string","description":"","title":"Secondary insurer payer id"},"allow_overlapping":{"type":"boolean","description":"Bypass overlap check.","title":"Allow overlapping"},"payment_profile":{"type":"string","description":"Appointment Payment Profile","title":"Payment profile"},"secondary_insurance_id_number":{"readOnly":true,"type":"string","description":"","title":"Secondary insurance id number"},"clinical_note":{"title":"ClinicalNote","type":"object","description":"Associated clinical note object","properties":{"pdf":{"readOnly":true,"type":"string","description":"","title":"Pdf"},"locked":{"type":"boolean","description":"","title":"Locked"},"updated_at":{"type":"string","description":"","title":"Updated at"}}},"custom_vitals":{"items":{"title":"CustomVitalValue","type":"object","description":"","properties":{"value":{"type":"string","description":"","title":"Value"},"vital_type":{"type":"integer","description":"","title":"Vital type"}}},"type":"array","description":"Custom vitals associated with this appointment.","title":"Custom vitals"},"is_virtual_base":{"readOnly":true,"type":"boolean","description":"","title":"Is virtual base"},"recurring_appointment":{"type":"boolean","description":"Whether the appointment is a recurring appointment or not","title":"Recurring appointment"},"supervising_provider":{"type":"string","description":"Supervising provider of appointment if set.","title":"Supervising provider"},"recurring_days":{"type":"array","description":"For recurring appointments, the days of the week on which the appointment recurs. Can include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday","title":"Recurring days"},"status_transitions":{"items":{"title":"AppointmentStatusTransition","type":"object","description":"","properties":{"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"to_status":{"readOnly":true,"type":"string","description":"","title":"To status"},"from_status":{"readOnly":true,"type":"string","description":"","title":"From status"},"datetime":{"readOnly":true,"type":"string","description":"","title":"Datetime"}}},"readOnly":true,"type":"array","description":"","title":"Status transitions"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"reminders":{"items":{"title":"SimpleReminder","type":"object","description":"","properties":{"scheduled_time":{"readOnly":true,"type":"string","description":"","title":"Scheduled time"},"type":{"enum":["email","sms","phone","auto_call"],"type":"string","description":"","title":"Type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"readOnly":true,"type":"array","description":"Scheduled reminders of the appointment","title":"Reminders"},"ins1_status":{"readOnly":true,"enum":["","Incomplete Information","In Process Emdeon","Rejected Emdeon","Rejected EPS","Rejected Jopari","In Process Payor","Rejected Waystar Professional","Rejected Waystar Institutional","In Process Payer","Payer Acknowledged","Rejected Payor","Rejected Payer","Paid in Full","Partially Paid","Coordination of Benefits","ERA Received","ERA Denied","HCFA Form Faxed"],"type":"string","description":"Billing status of primary insurer","title":"Ins1 status"},"custom_status":{"type":"string","description":"AppointmentStatus Name","title":"AppointmentStatus"},"recur_end_date":{"type":"string","description":"For recurring appointments, the end date of the recurring series","title":"Recur end date"},"icd10_codes":{"items":{"type":"string","description":"","title":""},"type":"array","description":"","title":"Icd10 codes"},"deleted_flag":{"readOnly":true,"type":"boolean","description":"Whether the appointment is deleted.","title":"Deleted flag"},"notes":{"type":"string","description":"","title":"Notes"},"recurs_every":{"type":"integer","description":"For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.","title":"Recurs every"}},"x-verbose-required":["reminders","vitals","custom_fields","custom_vitals","clinical_note","extended_updated_at","status_transitions"]},"PatientProblem":{"required":["doctor","patient"],"type":"object","properties":{"category":{"readOnly":true,"type":"string","description":"The category of the problem. Either `problem-list-item` or `health-concern`","title":"Category"},"icd_code":{"type":"string","description":"ICD9 or ICD10 code for the problem","title":"Icd code"},"icd_version":{"enum":["9","10"],"type":"string","description":"Either `9` or `10`. If omitted in writing, default to 10.","title":"Icd version"},"appointment":{"type":"integer","description":"","title":"Appointment"},"description":{"type":"string","description":"","title":"Description"},"info_url":{"readOnly":true,"type":"string","description":"External URL with more information about the problem, intended for patient education","title":"Info url"},"doctor":{"type":"integer","description":"","title":"Doctor"},"notes":{"type":"string","description":"Any additional notes by the provider","title":"Notes"},"verification_status":{"enum":["","unconfirmed","provisional","differential","confirmed","refuted","entered-in-error"],"description":"The verification status of the problem:\n- `unconfirmed`\n- `provisional`\n- `differential`\n- `confirmed`\n- `refuted`\n- `entered-in-error`\n"},"status":{"enum":["active","inactive","resolved"],"type":"string","description":"Either `active`, `inactive` or `resolved`. If omitted in writing, default to `active`","title":"Status"},"snomed_ct_code":{"type":"string","description":"SnoMED code for the problem","title":"SnoMED CT code"},"abatement_date":{"readOnly":true,"title":"Abatement Date","type":"string","description":"The problem's resolution date.","format":"date"},"date_onset":{"type":"string","description":"","title":"Date onset"},"date_diagnosis":{"type":"string","description":"","title":"Date diagnosis"},"date_changed":{"type":"string","description":"","title":"Date changed"},"patient":{"type":"integer","description":"","title":"Patient"},"problem_type":{"readOnly":true,"enum":["","sdoh","functional status","disability status","cognitive status"],"type":"string","description":"The type of problem:\n- `sdoh`: Social Determinants of Health (SDOH).\n- `functional status`: Functional Status.\n- `disability status`: Disability Status.\n- `cognitive status`: Cognitive Status.\n","title":"Problem Type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"Name of the problem","title":"Name"}},"x-verbose-required":[]},"TaskCategory":{"required":["name","practice_group"],"type":"object","properties":{"archived":{"type":"boolean","description":"","title":"Archived"},"is_global":{"readOnly":true,"type":"string","description":"Indicates that the category is a system wide (pre-defined) category","title":"Is global"},"name":{"type":"string","description":"","title":"Name"},"practice_group":{"type":"integer","description":"","title":"Practice group"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"TaskNote":{"required":["task","text"],"type":"object","properties":{"archived":{"type":"boolean","description":"If the task note is archived or not","title":"Archived"},"task":{"type":"integer","description":"ID of task this note is related with","title":"Task"},"text":{"type":"string","description":"Content of the task note","title":"Text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"created_by":{"readOnly":true,"type":"string","description":"ID of the `/api/users` who created the note","title":"Created by"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"CustomInsurancePlanName":{"required":[],"type":"object","properties":{"archived":{"type":"boolean","description":"","title":"Archived"},"doctor":{"readOnly":true,"type":"string","description":"List custom appointment fields defined by the doctor with the given ID","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"insurance_plan_name":{"type":"string","description":"Custom name","title":"Insurance plan name"},"user":{"readOnly":true,"type":"string","description":"User who created the custom insurance plan name","title":"User"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"SignedConsentForm":{"required":["patient","appointment","consent_form"],"type":"object","properties":{"date_signed":{"readOnly":true,"type":"string","description":"Date when the consent form is signed.  Automatically set when the record is created","title":"Date signed"},"archived":{"type":"boolean","description":"Indicates that the consent form has been archived and should not be used","title":"Archived"},"appointment":{"type":"integer","description":"ID of the appointment that the consent form is signed for","title":"Appointment"},"signature_file":{"format":"binary","type":"string","description":"File with the signature of the patient","title":"Signature file"},"updated_at":{"readOnly":true,"type":"string","description":"Date and time when the signature was last updated","title":"Updated at"},"patient":{"type":"integer","description":"ID of the patient who signed the consent form","title":"Patient"},"consent_form":{"type":"integer","description":"ID of the consent form that is signed","title":"Consent form"},"id":{"readOnly":true,"type":"integer","description":"ID consent form signature","title":"ID"}},"x-verbose-required":[]},"WorkSchedule":{"type":"object","properties":{"work_days":{"items":{"$ref":"#/components/schemas/WorkDay"},"type":"array","description":"work days of the work schedule","title":"Work days"},"id":{"readOnly":true,"type":"integer","description":"unique ID for the work schedule","title":"ID"},"office":{"type":"integer","description":"ID of office for work schedule","title":"Office"},"doctor":{"type":"integer","description":"ID of doctor for work schedule","title":"Office"}}},"Staff":{"required":[],"type":"object","properties":{"username":{"readOnly":true,"type":"string","description":"","title":"Username"},"first_name":{"readOnly":true,"type":"string","description":"","title":"First name"},"last_name":{"readOnly":true,"type":"string","description":"","title":"Last name"},"user_id":{"readOnly":true,"type":"string","description":"","title":"User id"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"home_phone":{"readOnly":true,"type":"string","description":"","title":"Home phone"},"active":{"readOnly":true,"type":"string","description":"","title":"Active"},"cell_phone":{"readOnly":true,"type":"string","description":"","title":"Cell phone"},"email":{"readOnly":true,"type":"string","description":"An account registration email will be sent to this address.","title":"Email"}},"x-verbose-required":[]},"DoctorOptions":{"required":[],"type":"object","properties":{"default_supervising_provider":{"type":"integer","description":"ID of an `/api/doctors` instance.","title":"Supervising provider"},"doctor":{"type":"integer","description":"ID of an `/api/doctors` instance.","title":"Doctor"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"patient_statement_office":{"type":"integer","description":"ID of an `/api/offices` instance.","title":"Patient statement office"},"allowed_payment_methods":{"type":"array","description":"","title":"Allowed Payment Methods"},"default_report":{"type":"integer","description":"ID of an `/api/clinical_note_templates` instance.","title":"Default Report"},"default_billing_provider":{"type":"integer","description":"ID of an `/api/doctors` instance.","title":"Billing provider"},"default_reminder_profile":{"type":"integer","description":"ID of an `/api/reminder_profiles` instance.","title":"Default Reminder profile"},"enable_everhealth_scribe":{"readOnly":true,"type":"boolean","description":"Whether the EverHealth Scribe feature is enabled for this doctor.","title":"Enable EverHealth Scribe"},"office_for_lab_results":{"type":"integer","description":"ID of an `/api/offices` instance.","title":"Office for lab results"},"erx_supervising_providers":{"items":{"type":"integer"},"type":"array","description":"Array or IDs of `/api/doctors` instances.","title":"Supervising providers"},"iframe_apps":{"items":{"type":"string"},"type":"array","description":"Integrated applications","title":"Integrated applications"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"CareTeamMember":{"required":[],"type":"object","properties":{"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"user":{"readOnly":true,"type":"string","description":"","title":"User"}},"x-verbose-required":[]},"AppointmentTemplate":{"x-verbose-required":["open_slots"],"required":["office","exam_room","scheduled_time","profile"],"type":"object","description":"Appointment templates are blocks of time during which a doctor usually sees appointments with the same profile. These may have a longer duration then the corresponding profile, in which case they may allow multiple appointments to be booked during that period.","properties":{"profile":{"type":"integer","description":"ID of the appointment profile to default to","title":"Profile"},"scheduled_time":{"type":"string","description":"","title":"Scheduled time"},"archived":{"readOnly":true,"type":"boolean","description":"Indicats that the object has been soft-deleted and should not be used","title":"Archived"},"week_days":{"items":{"type":"integer","description":"","title":""},"type":"array","description":"Array of integers that indicate week days (`0` = Monday, ..., `6` = Sunday)","title":"Week days"},"office":{"type":"integer","description":"","title":"Office"},"open_slots":{"items":{"title":"Open Slot","type":"object","description":"","properties":{"start":{"type":"string","description":"","title":"Start"},"end":{"type":"string","description":"","title":"End"}}},"type":"array","description":"Array of time intervals during which the template is available. Only computed if the available and verbose query parameters are passed. Note that only slots long enough to fit an appointment with the corresponding profile are included.","title":"Open Slots"},"date_end":{"type":"string","description":"","title":"Date end"},"date_start":{"type":"string","description":"","title":"Date start"},"exam_room":{"type":"integer","description":"**1-based** index for the exam room","title":"Exam room"},"duration":{"type":"integer","description":"Length of an appointment in minutes","title":"Duration"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"PatientLabResultSet":{"required":["ordering_doctor","patient"],"type":"object","properties":{"doctor_signoff":{"type":"boolean","description":"Check this box when the doctor has reviewed the lab result and taken appropriate action.","title":"Doctor signoff"},"loinc_code":{"type":"string","description":"","title":"LOINC code"},"patient":{"type":"integer","description":"","title":"Patient"},"ordering_doctor":{"type":"integer","description":"","title":"Ordering doctor"},"lab_abnormal_flag":{"enum":["","L","H","LL","HH","<",">","N","A","AA","null","U","D","B","W","S","R","I","MS","VS"],"type":"string","description":"HL7 codified abnormal flag for the result.","title":"Abnormal flag"},"lab_normal_range_units":{"type":"string","description":"","title":"Normal range units"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"lab_normal_range":{"type":"string","description":"","title":"Normal range"},"doctor_comments":{"type":"string","description":"Comment from the doctor on lab result.","title":"Comments"},"date_test_performed":{"type":"string","description":"Date of lab test.","title":"Date test performed"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"lab_result_value":{"type":"string","description":"","title":"Result value"},"lab_result_value_as_float":{"type":"number","description":"","title":"Lab result value as float"},"scanned_in_result":{"readOnly":true,"type":"string","description":"Scanned in PDF for this lab result (optional).","title":"Scanned in result"},"title":{"type":"string","description":"","title":"Title"},"lab_order_status":{"enum":["","Order Entered","Discontinued","In Progress","Results Received","Results Reviewed with Patient","Paper Order"],"type":"string","description":"Status of the lab order.","title":"Status"},"lab_imported_from_ccr":{"readOnly":true,"type":"string","description":"Imported CCR document that contains lab results.","title":"Lab imported from ccr"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"lab_result_value_units":{"type":"string","description":"","title":"Result units"}},"x-verbose-required":[]},"ClaimBillingNotes":{"required":["appointment"],"type":"object","properties":{"text":{"type":"string","description":"","title":"Text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"appointment":{"type":"integer","description":"","title":"Appointment"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"created_by":{"readOnly":true,"type":"string","description":"ID of `/users` when created the note","title":"Created by"}},"x-verbose-required":[]},"Coverage":{"required":[],"type":"object","properties":{"coverage_subscriber":{"readOnly":true,"type":"string","description":"A variable size object containing subscriber information, if returned by the clearinghouse that ran the eligibility check","title":"Coverage subscriber"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"eligibility":{"type":"string","description":"\nValue | Description\n--- | ----\n`'1'` | Active Coverage\n`'2'` | Active - Full Risk Capitation\n`'3'` | Active - Services Capitated\n`'4'` | Active - Services Capitated to Primary Care Physician\n`'5'` | Active - Pending Investigation\n`'6'` | Inactive\n`'7'` | Inactive - Pending Eligibility Update\n`'8'` | Inactive - Pending Investigation\n`'A'` | Co-Insurance\n`'B'` | Co-Payment\n`'C'` | Deductible\n`'CB'` | Coverage Basis\n`'D'` | Benefit Description\n`'E'` | Exclusions\n`'F'` | Limitations\n`'G'` | Out of Pocket (Stop Loss)\n`'H'` | Unlimited\n`'I'` | Non-Covered\n`'J'` | Cost Containment\n`'K'` | Reserve\n`'L'` | Primary Care Provider\n`'M'` | Pre-existing Condition\n`'MC'` | Managed Care Coordinator\n`'N'` | Services Restricted to Following Provider\n`'O'` | Not Deemed a Medical Necessity\n`'P'` | Benefit Disclaimer\n`'Q'` | Second Surgical Opinion Required\n`'R'` | Other or Additional Payor\n`'S'` | Prior Year(s) History\n`'T'` | Card(s) Reported Lost/Stolen\n`'U'` | Contact Following Entity for Eligibility or Benefit Information\n`'V'` | Cannot Process\n`'W'` | Other Source of Data\n`'X'` | Health Care Facility\n`'Y'` | Spend Down\n","title":"Eligibility"},"payer_name":{"type":"string","description":"The name of the payer as returned by the clearinghouse that ran the eligibility check","title":"Payer name"},"coverage_details":{"readOnly":true,"type":"string","description":"A variable size object containing the details of the eligibility check, if returned by the clearinghouse that ran the eligibility check","title":"Coverage details"},"updated_at":{"readOnly":true,"type":"string","description":"Timestamp of most recent record update","title":"Updated at"},"query_date":{"readOnly":true,"type":"string","description":"The time at which the request was made","title":"Query date"},"service_type_description":{"readOnly":true,"type":"string","description":"","title":"Service type description"},"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"request_service_type":{"enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","30","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52","53","54","55","56","57","58","59","60","61","62","63","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98","99","A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF","AG","AH","AI","AJ","AK","AL","AM","AN","AO","AQ","AR","B1","B2","B3","BA","BB","BC","BD","BE","BF","BG","BH","BI","BJ","BK","BL","BM","BN","BP","BQ","BR","BS","BT","BU","BV","BW","BX","BY","BZ","C1","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","DG","DM","DS","GF","GN","GY","IC","MH","NI","ON","PT","PU","RN","RT","TC","TN","UC"],"type":"string","description":"\nValue | Description\n--- | ----\n`'1'` | Medical Care\n`'2'` | Surgical\n`'3'` | Consultation\n`'4'` | Diagnostic X-Ray\n`'5'` | Diagnostic Lab\n`'6'` | Radiation Therapy\n`'7'` | Anesthesia\n`'8'` | Surgical Assistance\n`'9'` | Other Medical\n`'10'` | Blood Charges\n`'11'` | Used Durable Medical Equipment\n`'12'` | Durable Medical Equipment Purchase\n`'13'` | Ambulatory Service Center Facility\n`'14'` | Renal Supplies in the Home\n`'15'` | Alternate Method Dialysis\n`'16'` | Chronic Renal Disease (CRD) Equipment\n`'17'` | Pre-Admission Testing\n`'18'` | Durable Medical Equipment Rental\n`'19'` | Pneumonia Vaccine\n`'20'` | Second Surgical Opinion\n`'21'` | Third Surgical Opinion\n`'22'` | Social Work\n`'23'` | Diagnostic Dental\n`'24'` | Periodontics\n`'25'` | Restorative\n`'26'` | Endodontics\n`'27'` | Maxillofacial Prosthetics\n`'28'` | Adjunctive Dental Services\n`'30'` | Health Benefit Plan Coverage\n`'32'` | Plan Waiting Period\n`'33'` | Chiropractic\n`'34'` | Chiropractic Office Visits\n`'35'` | Dental Care\n`'36'` | Dental Crowns\n`'37'` | Dental Accident\n`'38'` | Orthodontics\n`'39'` | Prosthodontics\n`'40'` | Oral Surgery\n`'41'` | Routine (Preventive) Dental\n`'42'` | Home Health Care\n`'43'` | Home Health Prescriptions\n`'44'` | Home Health Visits\n`'45'` | Hospice\n`'46'` | Respite Care\n`'47'` | Hospital\n`'48'` | Hospital - Inpatient\n`'49'` | Hospital - Room and Board\n`'50'` | Hospital - Outpatient\n`'51'` | Hospital - Emergency Accident\n`'52'` | Hospital - Emergency Medical\n`'53'` | Hospital - Ambulatory Surgical\n`'54'` | Long Term Care\n`'55'` | Major Medical\n`'56'` | Medically Related Transportation\n`'57'` | Air Transportation\n`'58'` | Cabulance\n`'59'` | Licensed Ambulance\n`'60'` | General Benefits\n`'61'` | In-vitro Fertilization\n`'62'` | MRI/CAT Scan\n`'63'` | Donor Procedures\n`'64'` | Acupuncture\n`'65'` | Newborn Care\n`'66'` | Pathology\n`'67'` | Smoking Cessation\n`'68'` | Well Baby Care\n`'69'` | Maternity\n`'70'` | Transplants\n`'71'` | Audiology Exam\n`'72'` | Inhalation Therapy\n`'73'` | Diagnostic Medical\n`'74'` | Private Duty Nursing\n`'75'` | Prosthetic Device\n`'76'` | Dialysis\n`'77'` | Otological Exam\n`'78'` | Chemotherapy\n`'79'` | Allergy Testing\n`'80'` | Immunizations\n`'81'` | Routine Physical\n`'82'` | Family Planning\n`'83'` | Infertility\n`'84'` | Abortion\n`'85'` | AIDS\n`'86'` | Emergency Services\n`'87'` | Cancer\n`'88'` | Pharmacy\n`'89'` | Free Standing Prescription Drug\n`'90'` | Mail Order Prescription Drug\n`'91'` | Brand Name Prescription Drug\n`'92'` | Generic Prescription Drug\n`'93'` | Podiatry\n`'94'` | Podiatry - Office Visits\n`'95'` | Podiatry - Nursing Home Visits\n`'96'` | Professional (Physician)\n`'97'` | Anesthesiologist\n`'98'` | Professional (Physician) Visit - Office\n`'99'` | Professional (Physician) Visit - Inpatient\n`'A0'` | Professional (Physician) Visit - Outpatient\n`'A1'` | Professional (Physician) Visit - Nursing Home\n`'A2'` | Professional (Physician) Visit - Skilled Nursing Facility\n`'A3'` | Professional (Physician) Visit - Home\n`'A4'` | Psychiatric\n`'A5'` | Psychiatric - Room and Board\n`'A6'` | Psychotherapy\n`'A7'` | Psychiatric - Inpatient\n`'A8'` | Psychiatric - Outpatient\n`'A9'` | Rehabilitation\n`'AA'` | Rehabilitation - Room and Board\n`'AB'` | Rehabilitation - Inpatient\n`'AC'` | Rehabilitation - Outpatient\n`'AD'` | Occupational Therapy\n`'AE'` | Physical Medicine\n`'AF'` | Speech Therapy\n`'AG'` | Skilled Nursing Care\n`'AH'` | Skilled Nursing Care - Room and Board\n`'AI'` | Substance Abuse\n`'AJ'` | Alcoholism\n`'AK'` | Drug Addiction\n`'AL'` | Vision (Optometry)\n`'AM'` | Frames\n`'AN'` | Routine Exam\n`'AO'` | Lenses\n`'AQ'` | Nonmedically Necessary Physical\n`'AR'` | Experimental Drug Therapy\n`'B1'` | Burn Care\n`'B2'` | Brand Name Prescription Drug - Formulary\n`'B3'` | Brand Name Prescription Drug - Non-Formulary\n`'BA'` | Independent Medical Evaluation\n`'BB'` | Partial Hospitalization (Psychiatric)\n`'BC'` | Day Care (Psychiatric)\n`'BD'` | Cognitive Therapy\n`'BE'` | Massage Therapy\n`'BF'` | Pulmonary Rehabilitation\n`'BG'` | Cardiac Rehabilitation\n`'BH'` | Pediatric\n`'BI'` | Nursery\n`'BJ'` | Skin\n`'BK'` | Orthopedic\n`'BL'` | Cardiac\n`'BM'` | Lymphatic\n`'BN'` | Gastrointestinal\n`'BP'` | Endocrine\n`'BQ'` | Neurology\n`'BR'` | Eye\n`'BS'` | Invasive Procedures\n`'BT'` | Gynecological\n`'BU'` | Obstetrical\n`'BV'` | Obstetrical/Gynecological\n`'BW'` | Mail Order Prescription Drug: Brand Name\n`'BX'` | Mail Order Prescription Drug: Generic\n`'BY'` | Physician Visit - Office: Sick\n`'BZ'` | Physician Visit - Office: Well\n`'C1'` | Coronary Care\n`'CA'` | Private Duty Nursing - Inpatient\n`'CB'` | Private Duty Nursing - Home\n`'CC'` | Surgical Benefits - Professional (Physician)\n`'CD'` | Surgical Benefits - Facility\n`'CE'` | Mental Health Provider - Inpatient\n`'CF'` | Mental Health Provider - Outpatient\n`'CG'` | Mental Health Facility - Inpatient\n`'CH'` | Mental Health Facility - Outpatient\n`'CI'` | Substance Abuse Facility - Inpatient\n`'CJ'` | Substance Abuse Facility - Outpatient\n`'CK'` | Screening X-ray\n`'CL'` | Screening laboratory\n`'CM'` | Mammogram, High Risk Patient\n`'CN'` | Mammogram, Low Risk Patient\n`'CO'` | Flu Vaccination\n`'CP'` | Eyewear and Eyewear Accessories\n`'CQ'` | Case Management\n`'DG'` | Dermatology\n`'DM'` | Durable Medical Equipment\n`'DS'` | Diabetic Supplies\n`'GF'` | Generic Prescription Drug - Formulary\n`'GN'` | Generic Prescription Drug - Non-Formulary\n`'GY'` | Allergy\n`'IC'` | Intensive Care\n`'MH'` | Mental Health\n`'NI'` | Neonatal Intensive Care\n`'ON'` | Oncology\n`'PT'` | Physical Therapy\n`'PU'` | Pulmonary\n`'RN'` | Renal\n`'RT'` | Residential Psychiatric Treatment\n`'TC'` | Transitional Care\n`'TN'` | Transitional Nursery Care\n`'UC'` | Urgent Care\n","title":"Request service type"},"id":{"readOnly":true,"type":"integer","description":"System identifier","title":"ID"},"cob_level":{"readOnly":true,"type":"string","description":"The level of insurance the eligibility check was run on. Can be one of the following: `Primary Insurance` or `Secondary Insurance`","title":"Cob level"}},"x-verbose-required":[]},"PatientAllergy":{"required":["doctor","patient"],"type":"object","properties":{"status":{"enum":["active","inactive"],"type":"string","description":"One of `\"active\"`, `\"inactive\"`. If absent in `POST`, default to `\"active\"`","title":"Status"},"reaction":{"type":"string","description":"Short description of the patient's allergic reaction, such as `\"Hives\"`","title":"Reaction"},"patient":{"type":"integer","description":"","title":"Patient"},"description":{"type":"string","description":"Description of the allergy, such as `\"Cat hair\"`","title":"Description"},"doctor":{"type":"integer","description":"Id of the doctor who diagnosed the allergy","title":"Doctor"},"snomed_reaction":{"enum":["","14669001","4448006","39579001","57676002","43724002","49727002","386661006","25064002","247472004","271795006","68962001","68235000","422587007","95388000","271807003","271825005","64531003","267036007","162397003","65124004"],"type":"string","description":"SNOMED code for the reaction. For possible SnoMED codes, please see [this link from PHIN VADS](https://phinvads.cdc.gov/vads/ViewValueSet.action?id=896AABB4-5ACD-DE11-913D-0015173D1785)","title":"Snomed reaction"},"notes":{"type":"string","description":"Any additional notes from the provider","title":"Notes"},"verification_status":{"enum":["confirmed","unconfirmed","refuted","entered-in-error"],"type":"string","description":"One of `\"confirmed\"`, `\"unconfirmed\"`, `\"refuted\" or `\"entered-in-error\"`","title":"Verification status"},"snomed_code":{"type":"string","description":"SNOMED code for the allergy","title":"Snomed code"},"rxnorm":{"type":"string","description":"If the allergy is a drug allergy, this is the RxNorm code of the drug","title":"Rxnorm"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":["description"]},"TaskTemplate":{"required":["name"],"type":"object","properties":{"archived":{"type":"boolean","description":"","title":"Archived"},"name":{"type":"string","description":"","title":"Name"},"practice_group":{"readOnly":true,"type":"string","description":"","title":"Practice group"},"default_category":{"type":"integer","description":"","title":"Default category"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"default_title":{"type":"string","description":"","title":"Default title"},"default_note":{"type":"string","description":"","title":"Default note"},"default_status":{"type":"integer","description":"","title":"Default status"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"default_assignee_group":{"type":"integer","description":"","title":"Default assignee group"},"default_assignee_user":{"type":"string","description":"","title":"Default assignee user"},"default_due_date_offset":{"type":"string","description":"Offset due date, format should follow `\"[DD] [HH:[MM:]]ss[.uuuuuu]\"`","title":"Default due date offset"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"default_priority":{"enum":["10","20","30","40"],"type":"string","description":"Can be one of the following 10(Low), 20(Medium), 30(High), 40(Urgent)","title":"Default priority"}},"x-verbose-required":[]},"BillingLineItemDeletion":{"type":"object","properties":{"billing_line_item_id":{"readOnly":true,"type":"number","description":"The ID of the original billing line item","title":"Billing Line Item ID"},"created_at":{"readOnly":true,"type":"string","description":"Date when the billing line item was deleted","title":"Created At"},"appointment_id":{"readOnly":true,"type":"number","description":"Appointment ID of the original billing line item","title":"Appointment ID"}}},"PhoneCallLog":{"required":["patient","doctor"],"type":"object","properties":{"scheduled_time":{"type":"string","description":"Date of phone call, if `appointment` is set, this field will be set as the `scheduled_time` of that appointment","title":"Scheduled time"},"archived":{"readOnly":true,"type":"boolean","description":"If this phone call log is archived or not","title":"Archived"},"appointment":{"type":"integer","description":"Appointment related with the phone call log","title":"Appointment"},"doctor":{"type":"integer","description":"","title":"Doctor"},"title":{"type":"string","description":"Title of this log","title":"Title"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"author":{"readOnly":true,"type":"string","description":"Author of post.","title":"Author"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"cash_charged":{"type":"number","description":"Amount of cash needs to be charged","title":"Cash charged"},"duration":{"type":"integer","description":"Duration of the phone call","title":"Duration"},"patient":{"type":"integer","description":"","title":"Patient"},"message":{"type":"string","description":"Additional message for the phone call","title":"Message"},"type":{"type":"string","description":"Type of phone call log","title":"Type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"PatientAuthorization":{"required":["doctor","patient"],"type":"object","properties":{"status":{"type":"string","description":"Status","title":"Status"},"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"end_date":{"readOnly":true,"type":"string","description":"","title":"End Date"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"number_of_visits":{"readOnly":true,"type":"integer","description":"","title":"Number of visits"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"specialty":{"type":"string","description":"Specialty","title":"Specialty"},"auth_number":{"type":"string","description":"Authorization Number","title":"Authorization Number"},"start_date":{"readOnly":true,"type":"string","description":"","title":"Start Date"},"patient_id":{"type":"integer","description":"","title":"Patient Id"},"visits_remaining":{"readOnly":true,"type":"integer","description":"","title":"Visits remainings"},"notes":{"type":"string","description":"Notes","title":"Notes"},"doctor_id":{"readOnly":true,"type":"integer","description":"","title":"Doctor Id"},"procedure_codes":{"items":{"title":"","type":"object","description":"Procedure code object","properties":{"price":{"type":"string","description":"This field is represented in string format","title":"Price"},"code":{"type":"string","description":"","title":"Code"},"quantity":{"type":"string","description":"This field is represented in string format","title":"Quantity"}}},"readOnly":true,"type":"array","description":"Array of procedure code objects","title":"Procedure codes"},"expired":{"readOnly":true,"type":"boolean","description":"","title":"Expired authorization"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"InventoryCategory":{"required":[],"type":"object","properties":{"archived":{"type":"boolean","description":"If the category is archived or not","title":"Archived"},"name":{"type":"string","description":"Name of the inventory category","title":"Name"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"category_type":{"enum":["vaccine","product","service"],"type":"string","description":"Can be one of `\"vaccine\"`, `\"product\"` or `\"service\"`","title":"Category type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"ImplantableDevice":{"required":[],"type":"object","properties":{"status":{"readOnly":true,"enum":["active","inactive"],"type":"string","description":"One of `'active'` or `'inactive'`","title":"Status"},"lot_number":{"readOnly":true,"type":"string","description":"","title":"Device lot number"},"archived":{"readOnly":true,"type":"boolean","description":"","title":"Archived"},"manufacturing_date":{"readOnly":true,"type":"string","description":"","title":"Manufacturing date"},"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"expiration_date":{"readOnly":true,"type":"string","description":"","title":"Expiration date"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"brand_name":{"readOnly":true,"type":"string","description":"","title":"Brand name"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"gmdn_pt_name":{"readOnly":true,"type":"string","description":"\"GMDN PT Name\" or \"SNOMED CT Description\" mapped to the attribute in  the \"GMDN PT Name\"","title":"GMDN PT Name"},"version_or_model":{"readOnly":true,"type":"string","description":"","title":"Version or model"},"serial_number":{"readOnly":true,"type":"string","description":"","title":"Serial number"},"udi":{"readOnly":true,"type":"string","description":"","title":"Unique Device Identifier"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"procedure":{"readOnly":true,"type":"string","description":"ID of `/api/procedures` object","title":"Procedure"},"company_name":{"readOnly":true,"type":"string","description":"","title":"Company name"}},"x-verbose-required":[]},"LabResult":{"required":["document","lab_test","test_performed","status","value"],"type":"object","properties":{"status":{"enum":["P","I","C","F","X"],"type":"string","description":"\nValue | Notes\n----- | -----\n`'P'` | `'preliminary'`\n`'I'` | `'pending'`\n`'C'` | `'correction'`\n`'F'` | `'final'`\n`'X'` | `'canceled'`\n","title":"Status"},"group_code":{"type":"string","description":"This is the code used for grouping result data.","title":"Group code"},"observation_description":{"type":"string","description":"For example, ``\"Blood Urea Nitrogen (BUN)\"``","title":"Observation description"},"is_abnormal":{"type":"string","description":"If true, the result will be flagged for the doctor's attention","title":"Is abnormal"},"observation_code":{"type":"string","description":"","title":"Observation code"},"specimen_received":{"type":"string","description":"","title":"Specimen received"},"comments":{"type":"string","description":"","title":"Comments"},"normal_range":{"type":"string","description":"When ``value_is_numeric`` is True, this parameter must be a string of the form ``\"<lower> <upper>\", where both lower and upper are numerical``","title":"Normal range"},"test_performed":{"type":"string","description":"","title":"Test performed"},"value":{"type":"string","description":"","title":"Value"},"abnormal_status":{"enum":["L","LL","H","HH","<",">","A","AA","S","R","I","NEG","POS","N",""],"type":"string","description":"\nValue | Notes\n----- | -----\n`'L'` | `'low'`\n`'LL'` | `'alert low'`\n`'H'` | `'high'`\n`'HH'` | `'alert high'`\n`'<'` | `'panic low'`\n`'>'` | `'panic high'`\n`'A'` | `'abnormal'`\n`'AA'` | `'very abnormal'`\n`'S'` | `'susceptible'`\n`'R'` | `'resistant'`\n`'I'` | `'intermediate'`\n`'NEG'` | `'negative'`\n`'POS'` | `'positive'`\n`'N'` | `'normal'`\n`''` | `'no comment'`\n","title":"Abnormal status"},"lab_order":{"readOnly":true,"type":"string","description":"ID of `/lab_orders` object the result belongs to","title":"Lab order"},"value_is_numeric":{"type":"boolean","description":"Default to `False`","title":"Value is numeric"},"document":{"type":"integer","description":"ID of `/lab_documents` object for the result","title":"Document"},"lab_test":{"type":"integer","description":"ID of `/lab_tests` object for the result","title":"Lab test"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"unit":{"type":"string","description":"Unit used for the value","title":"Unit"}},"x-verbose-required":[]},"LabTest":{"required":["lab_order"],"type":"object","properties":{"report_notes":{"type":"string","description":"Notes which are not meant for labs, but are copied on the results.","title":"Report notes"},"status":{"enum":["P","I","C","F","X"],"type":"string","description":"One of `\"preliminary\"`, `\"pending\"`, `\"correction\"`, `\"final\"` or `\"canceled\"`. Defaults to `\"preliminary\"`","title":"Status"},"code":{"type":"string","description":"","title":"Code"},"description":{"type":"string","description":"Short description of the ICD-10 code","title":"Description"},"specimen_condition":{"type":"string","description":"","title":"Specimen condition"},"collection_date":{"type":"string","description":"The date the specimen were collected","title":"Collection date"},"internal_notes":{"type":"string","description":"Notes which are meant for, and read by, the labs","title":"Internal notes"},"specimen_total_volume":{"type":"number","description":"","title":"Specimen total volume"},"specimen_source":{"type":"string","description":"","title":"Specimen source"},"lab_order":{"type":"integer","description":"ID of associated lab order","title":"Lab order"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"Name for the test","title":"Name"}},"x-verbose-required":[]},"PatientRiskAssessment":{"required":["doctor","patient"],"type":"object","properties":{"value_name":{"readOnly":true,"type":"string","description":"","title":"Value name"},"value_code_system":{"type":"string","description":"","title":"Value code system"},"code":{"type":"string","description":"","title":"Code"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"name":{"readOnly":true,"type":"string","description":"","title":"Name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"effective_time":{"type":"string","description":"","title":"Effective time"},"value_code":{"type":"string","description":"","title":"Value code"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"code_system":{"type":"string","description":"","title":"Code system"}},"x-verbose-required":[]},"BillingLineItem":{"required":["appointment","code","procedure_type","diagnosis_pointers"],"type":"object","properties":{"code":{"type":"string","description":"","title":"Code"},"ins3_paid":{"readOnly":true,"type":"number","description":"Amount paid by patinet's tertiary insurer","title":"Ins3 paid"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"posted_date":{"readOnly":true,"type":"string","description":"date of line_item creation","title":"Posted date"},"billing_status":{"readOnly":true,"enum":["","Incomplete Information","In Process Emdeon","In Process iHCFA","In Process Gateway","In Process Jopari","In Process Waystar","In Process EPS","Rejected Emdeon","Rejected iHCFA","Rejected Gateway","Rejected Jopari","Rejected Waystar","Rejected EPS","In Process Payer","Payer Acknowledged","Rejected Payer","Paid in Full","Partially Paid","Coordination of Benefits","ERA Received","ERA Denied"],"type":"string","description":"One of `\"\"`, `\"Incomplete Information\"`, `\"In Process Emdeon\"`, `\"In Process iHCFA\"`, `\"In Process Gateway\"`, `\"Rejected Emdeon\"`, `\"Rejected iHCFA\"`, `\"Rejected Gateway\"`, `\"In Process Payer\"`, `\"Payer Acknowledged\"`, `\"Rejected Payer\"`, `\"Paid in Full\"`,  `\"Partially Paid\"`,  `\"Coordination of Benefits\"`,  `\"ERA Received\"`,  `\"ERA Denied\"`","title":"Billing status"},"pt_paid":{"type":"number","description":"Amount paid by patient","title":"Pt paid"},"allowed":{"readOnly":true,"type":"number","description":"Amount allowed by insurance","title":"Allowed"},"patient":{"readOnly":true,"type":"string","description":"Patient ID","title":"Patient"},"adjustment":{"readOnly":true,"type":"number","description":"Adjustment from total billed","title":"Adjustment"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"doctor":{"readOnly":true,"type":"string","description":"Doctor ID","title":"Doctor"},"balance_pt":{"readOnly":true,"type":"number","description":"Patient balance","title":"Balance pt"},"units":{"type":"string","description":"Default to \"UN\"","title":"Units"},"balance_ins":{"type":"number","description":"Insurance balance","title":"Balance ins"},"paid_total":{"readOnly":true,"type":"string","description":"Total amount paid","title":"Paid total"},"diagnosis_pointers":{"items":{"type":"string","description":"String representation of an integer or ICD code","title":""},"type":"array","description":"List of 4 diagnosis pointers","title":"Diagnosis pointers"},"appointment":{"type":"integer","description":"Appointment ID","title":"Appointment"},"description":{"readOnly":true,"type":"string","description":"","title":"Description"},"balance_total":{"readOnly":true,"type":"string","description":"Total balance","title":"Balance total"},"price":{"type":"number","description":"Price of procedure","title":"Price"},"expected_reimbursement":{"readOnly":true,"type":"number","description":"","title":"Expected reimbursement"},"ins2_paid":{"readOnly":true,"type":"number","description":"Amount paid by patient's secondary insurer","title":"Ins2 paid"},"ins1_paid":{"readOnly":true,"type":"number","description":"Amount paid by patient's primary insurer","title":"Ins1 paid"},"insurance_status":{"readOnly":true,"type":"string","description":"This corresponds to the \"Status/Adj Type\" from billing detail screen","title":"Insurance status"},"billed":{"readOnly":true,"type":"number","description":"Total billed","title":"Billed"},"modifiers":{"items":{"type":"string","description":"String representation of modifier","title":""},"type":"array","description":"List of 4 code modifiers","title":"Modifiers"},"denied_flag":{"readOnly":true,"type":"boolean","description":"","title":"Denied flag"},"ins_total":{"readOnly":true,"type":"string","description":"Total amount paid by patient's insurers","title":"Ins total"},"procedure_type":{"enum":["C","H","U","S"],"type":"string","description":"One of `\"CPT(C)\"`, `\"HCPCS(H)\"`, `\"Custom(U)\"`, use 1 character identifier when using `POST`","title":"Procedure type"},"service_date":{"readOnly":true,"type":"string","description":"Date on which the service was rendered","title":"Service date"},"quantity":{"type":"number","description":"","title":"Quantity"}},"x-verbose-required":["description"]},"CustomVitalType":{"required":[],"type":"object","properties":{"archived":{"type":"boolean","description":"Indicates that the object has been soft-deleted and should not be used","title":"Archived"},"description":{"type":"string","description":"","title":"Description"},"data_type":{"enum":["text","number","single_sel"],"type":"string","description":"One of `text`, `number`, or `single_sel`","title":"Data type"},"doctor":{"readOnly":true,"type":"string","description":"ID of the doctor who created the custom vital","title":"Doctor"},"is_fraction_field":{"type":"boolean","description":"","title":"Is fraction field"},"fraction_delimiter":{"type":"string","description":"If `is_fraction_field` is true, this is the character separating the numerator and denominator","title":"Fraction delimiter"},"allowed_values":{"items":{"type":"string","description":"","title":""},"type":"array","description":"If `data_type` is `single_sel`, this is the array of values in the select's dropdown.","title":"Allowed values"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"unit":{"type":"string","description":"","title":"Unit"},"name":{"type":"string","description":"","title":"Name"}},"x-verbose-required":[]},"EOBObject":{"required":["doctor","insurance_payer_id","insurance_payer_name","insurance_payer_trace_number"],"type":"object","properties":{"posted_date":{"readOnly":true,"type":"string","description":"","title":"Posted date"},"insurance_payer_name":{"type":"string","description":"","title":"Insurance payer name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"payment_method":{"enum":["","ACH","BOPCCP","BOPCTX","CHK","FWT","VPAY","NON"],"type":"string","description":"`\"\"` - Unknown, `\"ACH\"` - Automated Clearing House (ACH), `\"BOPCCP\"` - Cash Concentration/Disbursement plus Addenda (CCD+) (ACH), `\"BOPCTX\"` - Corporate Trade Exchange (CTX) (ACH), `\"CHK\"` - Check, `\"FWT\"` - Federal Reserve Funds/Wire Transfer - Nonrepetitive, `\"VPAY\"` - vPayment, `\"NON\"` - Non-Payment Data","title":"Payment method"},"deposit_date":{"type":"string","description":"Date when EOB gets deposited.","title":"Deposit date"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"insurance_payer_id":{"type":"string","description":"","title":"Insurance payer id"},"scanned_eob":{"type":"string","description":"","title":"Scanned eob"},"insurance_payer_trace_number":{"type":"string","description":"","title":"Insurance payer trace number"},"total_paid":{"type":"number","description":"Total amount paid. If missing, default to 0.00","title":"Total paid"},"check_date":{"type":"string","description":"Date of check. If missing, default to the date when the request is made","title":"Check date"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"ClinicalNote":{"required":[],"type":"object","properties":{"patient":{"readOnly":true,"type":"string","description":"","title":"Patient"},"archived":{"type":"boolean","description":"","title":"Archived"},"clinical_note_sections":{"items":{"title":"Clinical Note Section","type":"object","description":"","properties":{"values":{"items":{"title":"Value","type":"object","description":"","properties":{"clinical_note_field":{"type":"integer","description":"","title":"Clinical Note Field"},"id":{"type":"integer","description":"","title":"Id"},"value":{"type":"string","description":"","title":""}}},"type":"array","description":"","title":"Values"},"clinical_note_template":{"type":"integer","description":"","title":"Clinical Note Template"},"name":{"type":"string","description":"","title":"Name"}}},"type":"array","description":"","title":"Clinical Note Sections"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"signee":{"title":"ClinicalNote","type":"object","description":"","properties":{"locked_by":{"readOnly":true,"type":"string","description":"","title":"Locked by"},"supervisor_locked_by":{"readOnly":true,"type":"string","description":"","title":"Supervisor locked by"}}}},"x-verbose-required":[]},"PatientAmendment":{"required":["patient","doctor","amendment_name","amendment_file"],"type":"object","properties":{"amendment_name":{"type":"string","description":"","title":"Amendment name"},"appointment":{"type":"integer","description":"ID of the appointment to which the amendment applies, if any. If present, the `amendment_file` will be appended to the clinical note for this appointment.","title":"Appointment"},"doctor":{"type":"integer","description":"ID of the doctor who owns the amendment","title":"Doctor"},"comments":{"type":"string","description":"","title":"Comments"},"amendment_file":{"type":"string","description":"A PDF file containing the amended information for the patient's record","title":"Amendment file"},"patient":{"type":"integer","description":"ID of the patient to whom the amendment applies","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"TelemedicineAppointment":{"x-verbose-required":[],"required":["appointment"],"type":"object","description":"The Telehealth Appointment endpoint is an extension of the existing Appointment endpoint.","properties":{"sent_patient_email":{"description":"Whether a confirmation email was sent to the Patient or not"},"appointment":{"type":"integer","description":"The Appointment related to the Telehealth Appointment, analagous to the /api/appointments resource id","title":"Appointment"},"created_at":{"readOnly":true,"type":"string","description":"UTC Timestamp for when the Telehealth Appointment was created","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"UTC Timestamp for when the Telehealth Appointment was updated","title":"Updated at"},"overlapping_duration":{"type":"string","description":"The duration that counts only if patient and doctor are in the video room","title":"Overlapping duration"},"duration":{"readOnly":true,"type":"integer","description":"Length of an appointment in minutes","title":"Duration"},"telehealth_url":{"readOnly":true,"type":"string","description":"URL used to access Telehealth Appointment","title":"Telehealth url"}}},"PatientDrug":{"required":["doctor","patient"],"type":"object","properties":{"dispense_quantity":{"type":"number","description":"","title":"Dispense quantity"},"prn":{"type":"boolean","description":"If `True`, the medication should be taken when necessary","title":"Prn"},"pharmacy_note":{"type":"string","description":"","title":"Pharmacy note"},"number_refills":{"type":"integer","description":"","title":"Number refills"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"dosage_quantity":{"type":"string","description":"Please note, this used to be an decimal field, you can still pass decimal value to it. Or you can pass in some formatted string if needed.","title":"Dosage quantity"},"doctor":{"type":"integer","description":"Prescribing doctor ID","title":"Doctor"},"date_started_taking":{"type":"string","description":"","title":"Date started taking"},"dosage_units":{"type":"string","description":"","title":"Dosage units"},"date_stopped_taking":{"type":"string","description":"","title":"Date stopped taking"},"order_status":{"enum":["","Administered during visit","Discontinued","Electronic eRx Sent","Faxed to Pharmacy","Ordered","Over the Counter","Paper Rx","Phoned into Pharmacy","Prescribed by other Dr","Prescription Printed"],"type":"string","description":"One of `\"\"`, `\"Ordered\"`, `\"Administered during visit\"`, `\"Electronic eRx Sent\"`, `\"Phoned into Pharmacy\"`, `\"Faxed to Pharmacy\"`, `\"Paper Rx\"`, `\"Prescription Printed\"`, `\"Discontinued\"`, `\"Prescribed by other Dr\"` or `\"Over the Counter\"`. If omitted in writing, default to `\"\"`","title":"Order status"},"status":{"enum":["active","inactive"],"type":"string","description":"If present, one of `\"active\"` or `\"inactive\"`. If omitted in writing, default to `\"active\"`","title":"Status"},"appointment":{"type":"integer","description":"Appointment ID corresponding to the initial prescription","title":"Appointment"},"daw":{"type":"boolean","description":"If true, the prescription should be dispensed as written and not substituted","title":"Daw"},"rxnorm":{"type":"string","description":"RxNorm code for the medication","title":"Rxnorm"},"date_prescribed":{"type":"string","description":"","title":"Date prescribed"},"name":{"type":"string","description":"","title":"Name"},"ndc":{"type":"string","description":"","title":"Ndc"},"notes":{"type":"string","description":"Any additional notes from the provider","title":"Notes"},"frequency":{"type":"string","description":"Frequency pf administration","title":"Frequency"},"indication":{"type":"string","description":"","title":"Indication"},"signature_note":{"type":"string","description":"","title":"Signature note"},"route":{"type":"string","description":"Route of administration","title":"Route"}},"x-verbose-required":[]},"DoctorMessage":{"required":["doctor","title"],"type":"object","properties":{"type_description":{"readOnly":true,"type":"string","description":"Type Description","title":"Type description"},"patient_middle_name":{"readOnly":true,"type":"string","description":"Patient Middle Name","title":"Patient middle name"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"owner":{"type":"string","description":"ID of `/api/users` who owns the message, who may be the doctor themselves or one of their staff members","title":"Owner"},"responsible_user_first_name":{"readOnly":true,"type":"string","description":"Responsible User First Name","title":"Responsible user first name"},"received_at":{"readOnly":true,"type":"string","description":"","title":"Received at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"doctor_last_name":{"readOnly":true,"type":"string","description":"Doctor Last Name","title":"Doctor last name"},"owner_first_name":{"readOnly":true,"type":"string","description":"Owner First Name","title":"Owner first name"},"archived":{"readOnly":true,"type":"boolean","description":"If true, indicates that the message has been soft-deleted","title":"Archived"},"doctor":{"type":"integer","description":"","title":"Doctor"},"owner_last_name":{"readOnly":true,"type":"string","description":"Owner Last Name","title":"Owner last name"},"patient_first_name":{"readOnly":true,"type":"string","description":"Patient First Name","title":"Patient first name"},"attachment":{"type":"string","description":"Files are passed using `multipart/form-data` encoding, but returned as URLs.","title":"Attachment"},"outgoing_fax_recipient_fax_number":{"readOnly":true,"type":"string","description":"Outgoing fax recipient fax number","title":"Outgoing fax recipient fax number"},"responsible_user_last_name":{"readOnly":true,"type":"string","description":"Responsible User Last Name","title":"Responsible user last name"},"type":{"enum":["GP","GC","GT","GZ","IF","OF","IL","IR","OR","IE","CE","CH","OA","PO","PI","PM","OO","OD","ID","DL","CN"],"type":"string","description":"\nValue | Description\n----- | -----------\n`\"GP\"` | Generated PDF\n`\"GC\"` | Generated CSV\n`\"GZ\"` | Generated ZIP\n`\"IF\"` | Incoming Fax\n`\"OF\"` | Outgoing Fax\n`\"IL\"` | Incoming Labs\n`\"IR\"` | Inbound Referrals\n`\"OR\"` | Outbound Referrals\n`\"IE\"` | Incoming eRx\n`\"OA\"` | Online Appointments\n`\"PO\"` | Patient Onboarding\n`\"PI\"` | Patient Incoming Message\n`\"PM\"` | Patient Outgoing Message\n`\"OO\"` | Demo Meeting Message\n`\"OD\"` | Outbound Direct Message\n`\"ID\"` | Inbound Direct Message\n","title":"Type"},"patient_last_name":{"readOnly":true,"type":"string","description":"Patient Last Name","title":"Patient last name"},"patient":{"type":"integer","description":"ID of patient that the message concerns, if applicable","title":"Patient"},"doctor_first_name":{"readOnly":true,"type":"string","description":"Doctor First Name","title":"Doctor first name"},"read":{"readOnly":true,"type":"boolean","description":"","title":"Read"},"responsible_user":{"type":"string","description":"ID of `/api/users` who has been assigned to process the message, who may be the doctor themselves or one of their staff members","title":"Responsible user"},"workflow_step":{"readOnly":true,"type":"string","description":"Used by doctors and their staff to keep track of what step of processing the message is in","title":"Workflow step"},"outgoing_fax_recipient_name":{"readOnly":true,"type":"string","description":"Outgoing fax recipient name","title":"Outgoing fax recipient name"},"doctor_middle_name":{"readOnly":true,"type":"string","description":"Doctor Middle Name","title":"Doctor middle name"},"message_notes":{"items":{"title":"MessageNote","type":"object","description":"Additional note","properties":{"text":{"type":"string","description":"Content of the note","title":"Text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"created_by":{"readOnly":true,"type":"string","description":"ID of `/api/users` who created the note","title":"Created by"}}},"type":"array","description":"Array of notes attached to the message","title":"Message notes"},"title":{"type":"string","description":"","title":"Title"},"starred":{"readOnly":true,"type":"boolean","description":"","title":"Starred"}},"x-verbose-required":[]},"Procedure":{"properties":{"status":{"readOnly":true,"type":"string","description":"","title":"Status"},"code":{"type":"string","description":"","title":"Code"},"patient":{"readOnly":true,"type":"integer","description":"Patient ID","title":"Patient"},"description":{"readOnly":true,"type":"string","description":"","title":"Description"},"doctor":{"readOnly":true,"type":"integer","description":"Doctor ID","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"procedure_type":{"enum":["C","H","U","S"],"type":"string","description":"One of `\"CPT(C)\"`, `\"HCPCS(H)\"`, `\"Custom(U)\"`","title":"Procedure type"},"date":{"readOnly":true,"type":"string","description":"Date of service for the procedure","title":"Date"},"appointment":{"type":"integer","description":"Appointment ID","title":"Appointment"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"ScannedClinicalDocument":{"required":["doctor","description","date","document","patient"],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"`DELETE` operation will set this field to `true`","title":"Archived"},"patient":{"type":"integer","description":"ID of the patient the document concerns","title":"Patient"},"description":{"type":"string","description":"","title":"Description"},"doctor":{"type":"integer","description":"ID of the doctor who owns the document","title":"Doctor"},"metatags":{"type":"string","description":"Array of tags represented as string. This should be quoted--e.g. `'[\"a\", \"b\"]'`--since this endpoint requires `multipart/form-data` encoding","title":"Metatags"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"date":{"type":"string","description":"","title":"Date"},"document":{"type":"string","description":"When creating, if you receive response as 201, but this field is `null`, please send a `GET` request with the created object's ID to retrieve the updated file URL","title":"Document"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"PatientPhysicalExam":{"required":["doctor","patient"],"type":"object","properties":{"value_name":{"readOnly":true,"type":"string","description":"Description of value","title":"Value name"},"value_code_system":{"type":"string","description":"Can be `SNOMEDCT`, `ICD10CM`, `LOINC`","title":"Value code system"},"code":{"type":"string","description":"Code from different code system","title":"Code"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"name":{"readOnly":true,"type":"string","description":"Description of physical exam","title":"Name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"effective_time":{"type":"string","description":"","title":"Effective time"},"value_code":{"type":"string","description":"Code from different code system represent physical exam value","title":"Value code"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"code_system":{"type":"string","description":"Can be `SNOMEDCT`, `LOINC`","title":"Code system"}},"x-verbose-required":[]},"FeeSchedule":{"required":[],"type":"object","properties":{"ineffective_date":{"type":"string","description":"End date that this schedule is valid. If null, then it is applied until an end date is set","title":"Ineffective date"},"assignees":{"type":"array","description":"Schedule specific to these assignees, if null, then applies as default to all assignees without a more specific fee schedule.","title":"Assignees"},"items":{"type":"array","description":"Items that belong to this fee schedule (this field is only available for single requests)","title":"Items"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"payer_id":{"type":"string","description":"Fee Schedule pricing specific to this payer, if null, then applies as default to all payers without a more specific fee schedule.","title":"Payer id"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"assignee_type":{"enum":["Individual","Speciality"],"type":"string","description":"Type of assignee","title":"Assignee Type"},"specialities":{"type":"array","description":"Schedule specific to these specialities, if null, then applies as default to all specialities without a more specific fee schedule.","title":"Specialities"},"effective_date":{"type":"string","description":"Start date that this schedule is valid. If null, then since the beginning of time","title":"Effective date"},"plan_name":{"type":"string","description":"Name of insurance plan.","title":"Plan name"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"SoapNoteLineItemFieldValue":{"x-verbose-required":[],"required":["appointment","clinical_note_field","value"],"type":"object","description":"Values entered by doctor when charting a particular appointment","properties":{"clinical_note_field":{"type":"integer","description":"ID of `/api/clinical_note_field_types` object that indicates type of the value","title":"Clinical note field"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"value":{"type":"string","description":"Value of the field. Interpretation varies by field type.\n`clinical_note_field.data_type` | Value | Description\n------------------------------- | ----- | -----------\n`\"Header\"` | string | \n`\"SubHeader\"` | string |\n`\"String\"` | string | If field is single/multiple select field, make sure value presents in allowed values set.\n`\"TwoStrings\"` | string | String is seperated by `\"/\"`\n`\"NullCheckbox\"` | string | Can be `\"0\"`, `\"1\"`, `\"2\"`, `\"0\"`-`Not selected`, `\"1\"`-`No`, `\"2\"`-`Yes`\n`\"Checkbox\"` | string | Can be `\"True\"`, `\"False\"`\n","title":"Value"},"appointment":{"type":"integer","description":"ID of appointment that the value applies to","title":"Appointment"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"Patient":{"required":["gender","doctor"],"type":"object","properties":{"medication_history_consent":{"type":"string","description":"","title":"Medication history consent"},"last_name":{"type":"string","description":"","title":"Last name"},"emergency_contact_phone":{"type":"string","description":"","title":"Emergency contact phone"},"primary_care_physician":{"type":"string","description":"Referring doctor for this patient","title":"Primary care physician"},"date_of_first_appointment":{"type":"string","description":"Date of first patient visit.","title":"Date of first appointment"},"tertiary_insurance":{"title":"TertiaryInsurance","type":"object","description":"**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.","properties":{"insurance_group_name":{"type":"string","description":"","title":"Insurance group name"},"insurance_id_number":{"type":"string","description":"","title":"Insurance id number"},"insurance_claim_office_number":{"type":"string","description":"Insurance office phone number","title":"Insurance claim office number"},"subscriber_address":{"type":"string","description":"","title":"Subscriber address"},"subscriber_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"Two-letter state code","title":"Subscriber state"},"subscriber_social_security":{"type":"string","description":"","title":"Subscriber social security"},"photo_front":{"type":"string","description":"Photo of front of insurance card","title":"Photo front"},"subscriber_last_name":{"type":"string","description":"","title":"Subscriber last name"},"subscriber_middle_name":{"type":"string","description":"","title":"Subscriber middle name"},"subscriber_date_of_birth":{"type":"string","description":"","title":"Subscriber date of birth"},"insurance_company":{"type":"string","description":"","title":"Insurance company"},"is_subscriber_the_patient":{"type":"boolean","description":"True if the insurance policy is under patient's own name. Defaults to true","title":"Is subscriber the patient"},"insurance_plan_name":{"type":"string","description":"Name of insurance plan.","title":"Insurance plan name"},"patient_relationship_to_subscriber":{"enum":["","01","04","05","07","10","15","17","19","20","21","22","23","24","29","32","33","36","39","40","41","43","53","76","G8"],"type":"string","description":"HCFA/1500 individual relationship code","title":"Patient relationship to subscriber"},"subscriber_gender":{"enum":["","Male","Female","Other","UNK","ASKU"],"type":"string","description":"One of `\"Male\"` or `\"Female\"`","title":"Subscriber gender"},"photo_back":{"type":"string","description":"Photo of back of insurance card","title":"Photo back"},"subscriber_suffix":{"type":"string","description":"E.g. `\"II\"` or `\"III\"`","title":"Subscriber suffix"},"subscriber_zip_code":{"type":"string","description":"","title":"Subscriber zip code"},"subscriber_city":{"type":"string","description":"","title":"Subscriber city"},"insurance_plan_type":{"enum":["","AM","BL","CH","CI","17","DS","14","FI","HM","16","15","LM","MC","MA","MB","ZZ","OF","11","13","12","TV","VA","WC"],"type":"string","description":"","title":"Insurance plan type"},"insurance_payer_id":{"type":"string","description":"","title":"Insurance payer id"},"subscriber_country":{"enum":["","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","CYM","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","description":"Two-letter country code","title":"Subscriber country"},"subscriber_first_name":{"type":"string","description":"","title":"Subscriber first name"},"insurance_group_number":{"type":"string","description":"","title":"Insurance group number"}}},"patient_flags_attached":{"items":{"title":"PatientFlag","type":"object","description":"Array of patient flag objects","properties":{"archived":{"readOnly":true,"type":"boolean","description":"","title":"Archived"},"flag_text":{"type":"string","description":"Description of the patient flag","title":"Flag text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"flag_type":{"type":"integer","description":"ID of the associated `/api/patient_flag_types` object","title":"Flag type"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"type":"array","description":"Patient flags attached to the patient","title":"Patient flags attached"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"custom_demographics":{"items":{"title":"CustomPatientFieldValue","type":"object","description":"Custom demographic values the patient has","properties":{"field_type":{"type":"integer","description":"ID of the `/api/custom_demographics` object","title":"Field type"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"value":{"type":"string","description":"","title":"Value"}}},"type":"array","description":"","title":"Custom demographics"},"referring_source":{"type":"string","description":"Referring source.","title":"Referring source"},"responsible_party_relation":{"type":"string","description":"","title":"Responsible party relation"},"zip_code":{"type":"string","description":"","title":"Zip code"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"employer_city":{"type":"string","description":"","title":"Employer city"},"employer_state":{"type":"string","description":"Two-letter abbreviation","title":"Employer state"},"city":{"type":"string","description":"","title":"City"},"first_name":{"type":"string","description":"","title":"First name"},"middle_name":{"type":"string","description":"","title":"Middle name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"race_subcategories":{"items":{"title":"RaceSubcategories","type":"object","description":"","properties":{"code":{"type":"string","description":"","title":"Code"},"description":{"type":"string","description":"","title":"Description"}}},"type":"array","description":"","title":"Race subcategories"},"disable_sms_messages":{"type":"boolean","description":"If True, suppress SMS/Txt messages to this patient even if we have a cell phone # for them.","title":"Disable sms messages"},"employer":{"type":"string","description":"","title":"Employer"},"preferred_language_description":{"readOnly":true,"type":"string","description":"","title":"Preferred language description"},"patient_flags":{"items":{"title":"PatientFlagType","type":"object","description":"Array of patien flag type objects","properties":{"archived":{"readOnly":true,"type":"boolean","description":"","title":"Archived"},"name":{"type":"string","description":"","title":"Name"},"doctor":{"type":"integer","description":"ID of doctor who owns the flag","title":"Doctor"},"color":{"type":"string","description":"","title":"Color"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"priority":{"type":"integer","description":"","title":"Priority"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"readOnly":true,"type":"array","description":"Possible patient flag type that can be attached to the patient","title":"Patient flags"},"date_of_birth":{"type":"string","description":"","title":"Date of birth"},"ethnicity":{"enum":["blank","hispanic","not_hispanic","declined"],"type":"string","description":"One of `\"blank\"`, `\"hispanic\"`, `\"not_hispanic\"` or `\"declined\"`","title":"Ethnicity"},"home_phone":{"type":"string","description":"","title":"Home phone"},"pronouns":{"enum":["","LA29518-0","LA29519-8","LA29520-6","LA29523-0","LA29521-4","LA29515-6","LA29516-4","LA29517-2","LA29522-2","LA29524-8"],"type":"string","description":"","title":"Pronouns"},"patient_status":{"enum":["A","I","D"],"type":"string","description":"One of `\"A\"` (active), `\"I\"` (inactive), `\"D\"` (inactive-deceased)","title":"Patient status"},"patient_photo_date":{"type":"string","description":"Cannot be passed without `patient_photo`","title":"Patient photo date"},"gender_identity_description":{"readOnly":true,"type":"string","description":"","title":"Gender Identity description"},"email":{"type":"string","description":"","title":"Email"},"responsible_party_email":{"type":"string","description":"","title":"Responsible party email"},"patient_photo":{"type":"string","description":"","title":"Patient photo"},"responsible_party_phone":{"type":"string","description":"","title":"Responsible party phone"},"state":{"type":"string","description":"Two-letter abbreviation","title":"State"},"secondary_insurance":{"title":"SecondaryInsurance","type":"object","description":"**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.","properties":{"insurance_group_name":{"type":"string","description":"","title":"Insurance group name"},"insurance_id_number":{"type":"string","description":"","title":"Insurance id number"},"insurance_claim_office_number":{"type":"string","description":"Insurance office phone number","title":"Insurance claim office number"},"subscriber_address":{"type":"string","description":"","title":"Subscriber address"},"subscriber_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"Two-letter state code","title":"Subscriber state"},"subscriber_social_security":{"type":"string","description":"","title":"Subscriber social security"},"photo_front":{"type":"string","description":"Photo of front of insurance card","title":"Photo front"},"subscriber_last_name":{"type":"string","description":"","title":"Subscriber last name"},"subscriber_middle_name":{"type":"string","description":"","title":"Subscriber middle name"},"subscriber_date_of_birth":{"type":"string","description":"","title":"Subscriber date of birth"},"insurance_company":{"type":"string","description":"","title":"Insurance company"},"is_subscriber_the_patient":{"type":"boolean","description":"True if the insurance policy is under patient's own name. Defaults to true","title":"Is subscriber the patient"},"insurance_plan_name":{"type":"string","description":"Name of insurance plan.","title":"Insurance plan name"},"patient_relationship_to_subscriber":{"enum":["","01","04","05","07","10","15","17","19","20","21","22","23","24","29","32","33","36","39","40","41","43","53","76","G8"],"type":"string","description":"HCFA/1500 individual relationship code","title":"Patient relationship to subscriber"},"subscriber_gender":{"enum":["","Male","Female","Other","UNK","ASKU"],"type":"string","description":"One of `\"Male\"` or `\"Female\"`","title":"Subscriber gender"},"photo_back":{"type":"string","description":"Photo of back of insurance card","title":"Photo back"},"subscriber_suffix":{"type":"string","description":"E.g. `\"II\"` or `\"III\"`","title":"Subscriber suffix"},"subscriber_zip_code":{"type":"string","description":"","title":"Subscriber zip code"},"subscriber_city":{"type":"string","description":"","title":"Subscriber city"},"insurance_plan_type":{"enum":["","AM","BL","CH","CI","17","DS","14","FI","HM","16","15","LM","MC","MA","MB","ZZ","OF","11","13","12","TV","VA","WC"],"type":"string","description":"","title":"Insurance plan type"},"insurance_payer_id":{"type":"string","description":"","title":"Insurance payer id"},"subscriber_country":{"enum":["","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","CYM","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","description":"Two-letter country code","title":"Subscriber country"},"subscriber_first_name":{"type":"string","description":"","title":"Subscriber first name"},"insurance_group_number":{"type":"string","description":"","title":"Insurance group number"}}},"date_of_last_appointment":{"type":"string","description":"Date of previous patient visit","title":"Date of last appointment"},"preferred_language_code":{"readOnly":true,"type":"string","description":"","title":"Preferred language code"},"patient_payment_profile":{"enum":["","Cash","Insurance","Insurance Out of Network","Auto Accident","Worker's Comp"],"type":"string","description":"One of `\"\"`, `\"Cash\"`, `\"Insurance\"`, `\"Insurance Out of Network\"`, `\"Auto Accident\"` or `\"Worker's Comp\"`.<br>**Note:** Patient must already have either `primary_insurance` or `secondary_insurance` or new `primary_insurance` or `secondary_insurance` is passed in request if `Insurance`, `Auto Accident` or `Worker's Comp` payment profiles are chosen.","title":"Patient payment profile"},"date_of_death":{"type":"string","description":"Available when show_inactive is passed","title":"Date of death"},"social_security_number":{"type":"string","description":"","title":"Social security number"},"auto_accident_insurance":{"title":"AutoAccidentInsurance","type":"object","description":"","properties":{"auto_accident_claim_rep_city":{"type":"string","description":"","title":"Auto accident claim rep city"},"auto_accident_claim_rep_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Auto accident claim rep state"},"auto_accident_claim_rep_address":{"type":"string","description":"","title":"Auto accident claim rep address"},"auto_accident_will_require_therapy_rec":{"type":"string","description":"","title":"Auto accident will require therapy rec"},"auto_accident_subscriber_middle_name":{"type":"string","description":"","title":"Auto accident subscriber middle name"},"auto_accident_still_under_care":{"type":"boolean","description":"Is patient still under your care for this condition?","title":"Auto accident still under care"},"auto_accident_significant_injury_notes":{"type":"string","description":"","title":"Auto accident significant injury notes"},"auto_accident_subscriber_first_name":{"type":"string","description":"","title":"Auto accident subscriber first name"},"auto_accident_subscriber_address":{"type":"string","description":"","title":"Auto accident subscriber address"},"auto_accident_disabled_from_date":{"type":"string","description":"Patient was disabled (unable to work) from","title":"Auto accident disabled from date"},"auto_accident_company":{"type":"string","description":"","title":"Auto accident company"},"auto_accident_disabled_to_date":{"type":"string","description":"Patient was disabled (unable to work) to","title":"Auto accident disabled to date"},"auto_accident_similar_condition_date":{"type":"string","description":"Date of same or similar condition","title":"Auto accident similar condition date"},"auto_accident_case_number":{"type":"string","description":"","title":"Auto accident case number"},"auto_accident_claim_rep_is_insurer":{"type":"boolean","description":"Is the insurer's claim representative the insurer?","title":"Auto accident claim rep is insurer"},"auto_accident_payer_address":{"type":"string","description":"","title":"Auto accident payer address"},"auto_accident_subscriber_last_name":{"type":"string","description":"","title":"Auto accident subscriber last name"},"auto_accident_subscriber_social_security":{"type":"string","description":"","title":"Auto accident subscriber social security"},"auto_accident_subscriber_phone_number":{"type":"string","description":"","title":"Auto accident subscriber phone number"},"auto_accident_subscriber_city":{"type":"string","description":"","title":"Auto accident subscriber city"},"auto_accident_significant_injury":{"enum":["YES","NO","N\\A"],"type":"string","description":"","title":"Auto accident significant injury"},"auto_accident_similar_condition_notes":{"type":"string","description":"","title":"Auto accident similar condition notes"},"auto_accident_payer_id":{"type":"string","description":"Auto Accident Payer ID","title":"Auto accident payer id"},"auto_accident_payer_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Auto accident payer state"},"auto_accident_subscriber_zip_code":{"type":"string","description":"","title":"Auto accident subscriber zip code"},"auto_accident_payer_zip":{"type":"string","description":"","title":"Auto accident payer zip"},"auto_accident_payer_city":{"type":"string","description":"","title":"Auto accident payer city"},"auto_accident_will_require_therapy":{"type":"boolean","description":"Will the patient require rehabilitation and/or occupational therapy as a result of the injuries sustained in this accident?","title":"Auto accident will require therapy"},"auto_accident_date_of_accident":{"type":"string","description":"","title":"Auto accident date of accident"},"auto_accident_subscriber_date_of_birth":{"type":"string","description":"","title":"Auto accident subscriber date of birth"},"auto_accident_subscriber_suffix":{"type":"string","description":"","title":"Auto accident subscriber suffix"},"auto_accident_subscriber_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Auto accident subscriber state"},"auto_accident_return_to_work_date":{"type":"string","description":"If still disabled, patient should be able to return to work on","title":"Auto accident return to work date"},"auto_accident_notes":{"type":"string","description":"","title":"Auto accident notes"},"auto_accident_policy_number":{"type":"string","description":"","title":"Auto accident policy number"},"auto_accident_is_subscriber_the_patient":{"type":"boolean","description":"True if the insurance policy is under patient's own name.","title":"Auto accident is subscriber the patient"},"auto_accident_claim_rep_zip":{"type":"string","description":"","title":"Auto accident claim rep zip"},"auto_accident_state_of_occurrence":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Auto accident state of occurrence"},"auto_accident_treatment_duration":{"type":"string","description":"","title":"Auto accident treatment duration"},"auto_accident_had_similar_condition":{"type":"boolean","description":"Has the patient had same or similar condition?","title":"Auto accident had similar condition"},"auto_accident_patient_relationship_to_subscriber":{"enum":["","01","04","05","07","10","15","17","19","20","21","22","23","24","29","32","33","36","39","40","41","43","53","76","G8"],"type":"string","description":"","title":"Auto accident patient relationship to subscriber"},"auto_accident_claim_rep_name":{"type":"string","description":"","title":"Auto accident claim rep name"}}},"address":{"type":"string","description":"","title":"Address"},"chart_id":{"type":"string","description":"Automatically set using first & last name if absent","title":"Chart id"},"referring_doctor":{"title":"Patient","type":"object","description":"","properties":{"fax":{"type":"string","description":"Should follow format \"xxx-xx-xxxx\"","title":"Fax"},"last_name":{"type":"string","description":"","title":"Last name"},"middle_name":{"type":"string","description":"","title":"Middle name"},"suffix":{"type":"string","description":"","title":"Suffix"},"first_name":{"type":"string","description":"","title":"First name"},"provider_number":{"type":"string","description":"","title":"Provider number"},"specialty":{"enum":["","Acupuncture","Advanced Practice Midwife","Aesthetic Medicine","Aesthetician","Allergist/Immunologist","Anesthesiologist","Cardiac Electrophysiologist","Cardiologist","Cardiothoracic Surgeon","Child/Adolescent Psychiatry","Chiropractor","Clinical Social Worker","Colorectal Surgeon","Correactology","Cosmetic Medicine","Counselor Mental Health","Counselor Professional","Counselor","Dentist","Diabetology","Dermatologist","Diagnostic Medical Sonographer","Dietitian, Registered","Ear-Nose-Throat Specialist (ENT)","Emergency Medicine Physician","Endocrinologist","Endodontist","Epidemiologist","Family Practitioner","Gastroenterologist","General Practice","General Surgeon","Geneticist","Geriatrician","Gerontologist","Gynecologist (no OB)","Gynegologic Oncologist","Hand Surgeon","Hematologist","Home Care","Hospice","Hospitalist","Infectious Disease Specialist","Integrative and Functional Medicine","Integrative Medicine","Internist","Interventional Radiology","Laboratory Medicine Specialist","Laser Surgery","Massage Therapist","Naturopathic Physician","Neonatologist","Nephrologist","Neurologist","Neuropsychology","Neurosurgeon","Not Actively Practicing","Nuclear Medicine Specialist","Nurse Practitioner","Nursing","Nutritionist","Obstetrician/Gynecologist","Occupational Medicine","Occupational Therapist","Oncologist","Ophthalmologist","Optometrist","Oral Surgeon","Orofacial Pain","Orthodontist","Orthopedic Surgeon","Orthotist","Other","Pain Management Specialist","Pathologist","Pediatric Dentist","Pediatric Gastroenterology","Pediatric Surgeon","Pediatrician","Perinatologist","Periodontist","Physical Medicine and Rehab Specialist","Physical Therapist","Physician Assistant","Plastic Surgeon","Podiatrist","Preventive-Aging Medicine","Preventive Medicine/Occupational-Environmental Medicine","Primary Care Physician","Prosthetist","Prosthodontist","Psychiatrist","Psychologist","Public Health Professional","Pulmonologist","Radiation Oncologist","Radiologist","Registered Nurse","Religious Nonmedical Practitioner","Reproductive Endocrinologist","Reproductive Medicine","Rheumatologist","Sleep Medicine","Speech-Language Pathologist","Sports Medicine Specialist","Urologist","Urgent Care","Vascular Surgeon"],"type":"string","description":"Can be one of following, `''`, `'Acupuncture'`, `'Advanced Practice Midwife'`, `'Aesthetic Medicine'`, `'Aesthetician'`, `'Allergist/Immunologist'`, `'Anesthesiologist'`, `'Cardiac Electrophysiologist'`, `'Cardiologist'`, `'Cardiothoracic Surgeon'`, `'Child/Adolescent Psychiatry'`, `'Chiropractor'`, `'Clinical Social Worker'`, `'Colorectal Surgeon'`, `'Correactology'`, `'Cosmetic Medicine'`, `'Counselor Mental Health'`, `'Counselor Professional'`, `'Counselor'`, `'Dentist'`, `'Diabetology'`, `'Dermatologist'`, `'Diagnostic Medical Sonographer'`, `'Dietitian, Registered'`, `'Ear-Nose-Throat Specialist (ENT)'`, `'Emergency Medicine Physician'`, `'Endocrinologist'`, `'Endodontist'`, `'Epidemiologist'`, `'Family Practitioner'`, `'Gastroenterologist'`, `'General Practice'`, `'General Surgeon'`, `'Geneticist'`, `'Geriatrician'`, `'Gerontologist'`, `'Gynecologist (no OB)'`, `'Gynegologic Oncologist'`, `'Hand Surgeon'`, `'Hematologist'`, `'Home Care'`, `'Hospice'`, `'Hospitalist'`, `'Infectious Disease Specialist'`, `'Integrative and Functional Medicine'`, `'Integrative Medicine'`, `'Internist'`, `'Interventional Radiology'`, `'Laboratory Medicine Specialist'`, `'Laser Surgery'`, `'Massage Therapist'`, `'Naturopathic Physician'`, `'Neonatologist'`, `'Nephrologist'`, `'Neurologist'`, `'Neuropsychology'`, `'Neurosurgeon'`, `'Not Actively Practicing'`, `'Nuclear Medicine Specialist'`, `'Nurse Practitioner'`, `'Nursing'`, `'Nutritionist'`, `'Obstetrician/Gynecologist'`, `'Occupational Medicine'`, `'Occupational Therapist'`, `'Oncologist'`, `'Ophthalmologist'`, `'Optometrist'`, `'Oral Surgeon'`, `'Orofacial Pain'`, `'Orthodontist'`, `'Orthopedic Surgeon'`, `'Orthotist'`, `'Other'`, `'Pain Management Specialist'`, `'Pathologist'`, `'Pediatric Dentist'`, `'Pediatric Gastroenterology'`, `'Pediatric Surgeon'`, `'Pediatrician'`, `'Perinatologist'`, `'Periodontist'`, `'Physical Medicine and Rehab Specialist'`, `'Physical Therapist'`, `'Physician Assistant'`, `'Plastic Surgeon'`, `'Podiatrist'`, `'Preventive-Aging Medicine'`, `'Preventive Medicine/Occupational-Environmental Medicine'`, `'Primary Care Physician'`, `'Prosthetist'`, `'Prosthodontist'`, `'Psychiatrist'`, `'Psychologist'`, `'Public Health Professional'`, `'Pulmonologist'`, `'Radiation Oncologist'`, `'Radiologist'`, `'Registered Nurse'`, `'Religious Nonmedical Practitioner'`, `'Reproductive Endocrinologist'`, `'Reproductive Medicine'`, `'Rheumatologist'`, `'Sleep Medicine'`, `'Speech-Language Pathologist'`, `'Sports Medicine Specialist'`, `'Urologist'`, `'Urgent Care'`, `'Vascular Surgeon'`","title":"Specialty"},"provider_qualifier":{"enum":["","0B","1G","G2"],"type":"string","description":"Can be one of following, `''`, `'0B'`(State License #), `'1G'`(Provider UPIN #), `'G2'`(Provider Commercial #)","title":"Provider qualifier"},"phone":{"type":"string","description":"Should follow format \"xxx-xx-xxxx\"","title":"Phone"},"address":{"type":"string","description":"","title":"Address"},"npi":{"type":"string","description":"","title":"Npi"},"email":{"type":"string","description":"","title":"Email"}}},"primary_insurance":{"title":"PrimaryInsurance","type":"object","description":"**Warning:** Changing insurance information may make past appointments unbillable. Insurance data is also **unvalidated**; you should use the [`/api/insurances`](#apiinsurances) endpoint to find the appropriate insurance payer.","properties":{"insurance_group_name":{"type":"string","description":"","title":"Insurance group name"},"insurance_id_number":{"type":"string","description":"","title":"Insurance id number"},"insurance_claim_office_number":{"type":"string","description":"Insurance office phone number","title":"Insurance claim office number"},"subscriber_address":{"type":"string","description":"","title":"Subscriber address"},"subscriber_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"Two-letter state code","title":"Subscriber state"},"subscriber_social_security":{"type":"string","description":"","title":"Subscriber social security"},"photo_front":{"type":"string","description":"Photo of front of insurance card","title":"Photo front"},"subscriber_last_name":{"type":"string","description":"","title":"Subscriber last name"},"subscriber_middle_name":{"type":"string","description":"","title":"Subscriber middle name"},"subscriber_date_of_birth":{"type":"string","description":"","title":"Subscriber date of birth"},"insurance_company":{"type":"string","description":"","title":"Insurance company"},"is_subscriber_the_patient":{"type":"boolean","description":"True if the insurance policy is under patient's own name. Defaults to true","title":"Is subscriber the patient"},"insurance_plan_name":{"type":"string","description":"Name of insurance plan.","title":"Insurance plan name"},"patient_relationship_to_subscriber":{"enum":["","01","04","05","07","10","15","17","19","20","21","22","23","24","29","32","33","36","39","40","41","43","53","76","G8"],"type":"string","description":"HCFA/1500 individual relationship code","title":"Patient relationship to subscriber"},"subscriber_gender":{"enum":["","Male","Female","Other","UNK","ASKU"],"type":"string","description":"One of `\"Male\"` or `\"Female\"`","title":"Subscriber gender"},"photo_back":{"type":"string","description":"Photo of back of insurance card","title":"Photo back"},"subscriber_suffix":{"type":"string","description":"E.g. `\"II\"` or `\"III\"`","title":"Subscriber suffix"},"subscriber_zip_code":{"type":"string","description":"","title":"Subscriber zip code"},"subscriber_city":{"type":"string","description":"","title":"Subscriber city"},"insurance_plan_type":{"enum":["","AM","BL","CH","CI","17","DS","14","FI","HM","16","15","LM","MC","MA","MB","ZZ","OF","11","13","12","TV","VA","WC"],"type":"string","description":"","title":"Insurance plan type"},"insurance_payer_id":{"type":"string","description":"","title":"Insurance payer id"},"subscriber_country":{"enum":["","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","CYM","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","description":"Two-letter country code","title":"Subscriber country"},"subscriber_first_name":{"type":"string","description":"","title":"Subscriber first name"},"insurance_group_number":{"type":"string","description":"","title":"Insurance group number"}}},"preferred_language":{"enum":["blank","eng","zho","fra","ita","jpn","por","rus","spa","other","unknown","declined"],"type":"string","description":"Use ISO 639 alpha-3 codes","title":"Preferred language"},"responsible_party_name":{"type":"string","description":"","title":"Responsible party name"},"nick_name":{"type":"string","description":"Common name for patient, should be used instead of first name if supplied.","title":"Nick name"},"copay":{"type":"string","description":"","title":"Copay"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"emergency_contact_relation":{"type":"string","description":"","title":"Emergency contact relation"},"gender_identity_code":{"readOnly":true,"type":"string","description":"","title":"Gender Identity  code"},"office_phone":{"type":"string","description":"","title":"Office phone"},"employer_address":{"type":"string","description":"","title":"Employer address"},"race":{"enum":["blank","indian","asian","black","hawaiian","white","other","declined"],"type":"string","description":"One of `\"blank\"`, `\"indian\"`, `\"asian\"`, `\"black\"`, `\"hawaiian\"`, `\"white\"` or `\"declined\"`","title":"Race"},"offices":{"items":{"type":"integer","description":"","title":""},"type":"array","description":"IDs of every office this patient has been to","title":"Offices"},"preferred_pharmacies":{"items":{"type":"string","description":"","title":""},"enum":[["string"]],"type":"array","description":"ncpdp id of patient's preferred pharmacies","title":"Preferred pharmacies"},"emergency_contact_name":{"type":"string","description":"","title":"Emergency contact name"},"gender":{"enum":["","Male","Female","Other","UNK","ASKU"],"type":"string","description":"One of `\"Male\"`, `\"Female\"`, or `\"Other\"`","title":"Gender"},"default_pharmacy":{"type":"string","description":"ncpdp id of patient's default pharmacy","title":"Default pharmacy"},"cell_phone":{"type":"string","description":"","title":"Cell phone"},"employer_zip_code":{"type":"string","description":"","title":"Employer zip code"},"workers_comp_insurance":{"title":"WorkerCompInsurance","type":"object","description":"","properties":{"workers_comp_payer_city":{"type":"string","description":"","title":"Workers comp payer city"},"workers_comp_payer_id":{"type":"string","description":"","title":"Workers comp payer id"},"workers_comp_group_name":{"type":"string","description":"","title":"Workers comp group name"},"workers_comp_wcb":{"type":"string","description":"","title":"Workers comp wcb"},"workers_comp_carrier_code":{"type":"string","description":"","title":"Workers comp carrier code"},"workers_comp_notes":{"type":"string","description":"","title":"Workers comp notes"},"property_and_casualty_agency_claim_number":{"type":"string","description":"","title":"Property and casualty agency claim number"},"workers_comp_state_of_occurrence":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Workers comp state of occurrence"},"workers_comp_payer_zip":{"type":"string","description":"","title":"Workers comp payer zip"},"workers_comp_wcb_rating_code":{"type":"string","description":"","title":"Workers comp wcb rating code"},"workers_comp_case_number":{"type":"string","description":"","title":"Workers comp case number"},"workers_comp_group_number":{"type":"string","description":"","title":"Workers comp group number"},"workers_comp_company":{"type":"string","description":"","title":"Workers comp company"},"workers_comp_payer_address":{"type":"string","description":"","title":"Workers comp payer address"},"workers_comp_date_of_accident":{"type":"string","description":"","title":"Workers comp date of accident"},"workers_comp_payer_state":{"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"","title":"Workers comp payer state"}}}},"x-verbose-required":["auto_accident_insurance","custom_demographics","patient_flags","patient_flags_attached","primary_insurance","referring_doctor","secondary_insurance","tertiary_insurance","workers_comp_insurance"]},"AuditLog":{"required":[],"type":"object","properties":{"patient":{"type":"string","description":"Patient's name","title":"Patient"},"description":{"type":"string","description":"Text description of the audit log","title":"Description"},"ip_address":{"type":"string","description":"IPv4 address of the user","title":"IP Address"},"created_at":{"type":"string","description":"","title":"Created at"},"appointment_id":{"type":"integer","description":"","title":"Appointment Id"},"updated_at":{"type":"string","description":"","title":"Updated at"},"field":{"type":"string","description":"Related field of this audit entry","title":"Field"},"name_of_user":{"type":"string","description":"","title":"User name"},"action":{"enum":["Not specified","Create","Read","Update","Delete"],"type":"string","description":"","title":"Action"},"user_id":{"type":"integer","description":"","title":"User id"},"doctor_id":{"type":"integer","description":"","title":"Doctor id"},"type":{"enum":["Account","Allergy","API","Appointment Template","Appointment Profile","Appointment","Billing Profile","Chart","Clinical Note","Direct Message","Data Export","EPCS","eRx","Family History","Fee Schedule","Immunization","Insurance Authorization","Insurance","Insurance Credit Card Payment","Login","Medical Form","Medication","MedList","Office","OnPatient","Patient Flag","Permissions","Phone Log","Problem","Refill Request","Uploaded Documents","Sample Data","Telehealth","Fax","Vital Flowsheet","Navigation View","Break The Glass","Lab Order","File Access"],"type":"string","description":"Type of audit log","title":"Type"},"page":{"type":"string","description":"Related page of this audit entry","title":"Page"}},"x-verbose-required":["description"]},"CashPayment":{"required":["patient"],"type":"object","properties":{"line_item":{"type":"integer","description":"","title":"Line item"},"posted_date":{"readOnly":true,"type":"string","description":"","title":"Posted date"},"appointment":{"type":"integer","description":"If this is absent, the apponitment will be inferred from line item","title":"Appointment"},"doctor":{"type":"integer","description":"","title":"Doctor"},"payment_method":{"enum":["DRCP","CASH","CHCK","DBIT","CRDT","AMEX","VISA","MSTR","DISC","SQR1","SQRE","PTPA","ONPT","OTHR"],"type":"string","description":"`\"CASH\", \"CHCK\" for Check, \"DBIT\" for Debit, \"CRDT\" for Credit Card, \"AMEX\" for American Express, \"VISA\", \"MSTR\" for Mastercard, \"DISC\" for Discover, \"SQR1\" for Square (legacy), \"SQRE\" for Square, \"PTPA\" for Patient Payments, \"ONPT\" for onpatient, \"OTHR\" for Other`","title":"Payment method"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"payment_transaction_type":{"enum":["","REF","COR","COPAY","COINSR","OTHR"],"type":"string","description":"`\"\" for Credit, \"REF\" for Refund, \"COR\" for Correction, \"COPAY\" for Copay, \"COINSR\" for Coinsurance, \"OTHR\" for Other`","title":"Payment transaction type"},"created_by":{"readOnly":true,"type":"string","description":"","title":"Created by"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"amount":{"type":"number","description":"Amount of cash for this payment, cannot be zero","title":"Amount"},"notes":{"type":"string","description":"","title":"Notes"},"trace_number":{"type":"string","description":"","title":"Trace number"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"received_date":{"type":"string","description":"","title":"Received date"}},"x-verbose-required":[]},"ConsentForm":{"required":["assign_by_default","doctor","is_mandatory","title","uri"],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"","title":"Archived"},"is_mandatory":{"type":"boolean","description":"If true, consent form must be signed prior to appointment check in","title":"Is mandatory"},"uri":{"type":"string","description":"Files are passed using `multipart/form-data` encoding, but returned as URLs.","title":"Uri"},"doctor":{"type":"integer","description":"","title":"Doctor"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"title":{"type":"string","description":"","title":"Title"},"assign_by_default":{"type":"boolean","description":"If true, consent form will always be automatically assigned to appointments","title":"Assign by default"},"order":{"readOnly":true,"type":"integer","description":"The order of consent forms that will show in management screen","title":"Order"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"LabOrderDocument":{"required":["lab_order","document","type"],"type":"object","properties":{"hl7":{"type":"string","description":"The HL7 data that the document was generated from","title":"HL7"},"timestamp":{"readOnly":true,"type":"string","description":"Time at which the document was uploaded","title":"Timestamp"},"lab_order":{"type":"integer","description":"ID of the order this document is associated with","title":"Lab order"},"document":{"type":"string","description":"","title":"Document"},"type":{"enum":["REQ","ABN","R-A","RES"],"type":"string","description":"\nValue | Notes\n----- | -----\n`\"REQ\"` | requisition form                                              |\n`\"ABN\"` | `ABN (Advance Beneficiary Notice)`                            |\n`\"R-A\"` | requisition form and :abbr:`ABN (Advance Beneficiary Notice)` |\n`\"RES\"` | lab results                                                   |\n","title":"Type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"SoapNoteCustomReport":{"required":[],"type":"object","properties":{"archived":{"readOnly":true,"type":"boolean","description":"Indicates that the doctor has soft-deleted this template, and will not use it for future appointments","title":"Archived"},"workflow_key":{"readOnly":true,"type":"string","description":"Identifier for this template. If it's a workflow form, it will be one of `\"hp_cc_history_present_illness\"`, `\"hp_med_fam_social_history\"`, `\"hp_review_of_systems\"`, `\"hp_physical_exam\"`, `\"hp_assessment\"`, `\"hp_plan\"`, `\"hp_meds_allergies\"`, `\"soap_subjective\"`, `\"soap_objective\"`, `\"soap_assessment\"`, `\"soap_plan\"`, `\"onpatient_additional_info\"`, or `\"onpatient_reasons_for_visit\"`. Otherwise, it will be `\"custom_{id}\".`","title":"Workflow Key"},"name":{"type":"string","description":"","title":"Name"},"doctor":{"readOnly":true,"type":"string","description":"","title":"Doctor"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"is_persistent":{"type":"boolean","description":"If this is true, this report will be the same across all notes","title":"Is persistent"},"clinical_note_fields":{"items":{"title":"Clinical Note Field","type":"object","description":"Array of field objects","properties":{"archived":{"type":"boolean","description":"Indicates that the field has been soft-deleted by the doctor","title":"Archived"},"name":{"type":"string","description":"","title":"Name"},"data_type":{"type":"string","description":"One of `\"\"`, `\"Checkbox\"`, `\"NullCheckbox\"`, `\"String\"`, `\"TwoStrings\"`, `\"FreeDraw\"`, `\"Photo\"`, `\"Header\"`, `\"Subheader\"`","title":"Data Type"},"required":{"type":"boolean","description":"Indicates that a note should not be locked unless a value is provided for this field","title":"Required"},"allowed_values":{"items":{"type":"string","description":"","title":""},"type":"array","description":"","title":"Allowed Values"},"clinical_note_template":{"type":"integer","description":"","title":"Clinical Note Template"}}},"type":"array","description":"clinical note fields","title":"Clinical Note Fields"},"is_onpatient":{"type":"boolean","description":"","title":"Is onpatient"},"order":{"title":"SoapNoteCustomReport","type":"object","description":"Order of templates","properties":{"on_complete_note":{"type":"integer","description":"Order of the template on complete notes","title":"On complete note"},"on_ipad":{"type":"integer","description":"Order of the template on iPad","title":"On ipad"}}},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":["clinical_note_fields"]},"LabVendorLocation":{"required":["name","facility_code"],"type":"object","properties":{"vendor_name":{"readOnly":true,"type":"string","description":"","title":"Vendor name"},"facility_code":{"type":"string","description":"Used for identifying the lab in orders and results","title":"Facility code"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"","title":"Name"}},"x-verbose-required":[]},"InventoryVaccine":{"required":["doctor","name","manufacturer_code"],"type":"object","properties":{"category":{"type":"integer","description":"ID of `/api/inventory_categories`","title":"Category"},"lot_number":{"type":"string","description":"","title":"Lot number"},"manufacturer_code":{"type":"string","description":"","title":"Manufacturer code"},"name":{"type":"string","description":"","title":"Name"},"original_quantity":{"type":"integer","description":"Default to zero","title":"Original quantity"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"status":{"enum":["active","inactive","archived","voided"],"type":"string","description":"Status of vaccine, could be one of `active`, `inactive`, `archived`, `voided`, default to `active`","title":"Status"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"price_with_tax":{"type":"number","description":"","title":"Price with tax"},"expiry":{"type":"string","description":"When will the vaccine expire","title":"Expiry"},"note":{"type":"string","description":"","title":"Note"},"sales_tax_applicable":{"type":"boolean","description":"Is sales tax applicable to this service/product? Default to false","title":"Sales tax applicable"},"cost":{"type":"number","description":"Base cost for consumables.","title":"Cost"},"price":{"type":"number","description":"","title":"Price"},"vaccination_type":{"type":"string","description":"Default to `\"standard vaccine\"`","title":"Vaccination type"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"manufacturer":{"type":"string","description":"","title":"Manufacturer"},"current_quantity":{"readOnly":true,"type":"integer","description":"This field can onlyu be changed by creating new patient vaccine record. Current quantity of an inventory vaccine is calculated by subtract number of records pointing to this inventory from the original quantity value.","title":"Current quantity"},"cvx_code":{"type":"string","description":"","title":"Cvx code"}},"x-verbose-required":[]},"Office":{"required":[],"type":"object","properties":{"phone_number":{"readOnly":true,"type":"string","description":"","title":"Phone number"},"city":{"readOnly":true,"type":"string","description":"","title":"City"},"archived":{"type":"boolean","description":"Indicates that the object has been soft-deleted and should not be used","title":"Archived"},"office_work_schedule":{"$ref":"#/components/schemas/WorkSchedule","description":"Office work schedule (beta)","title":"Office Work schedule"},"name":{"readOnly":true,"type":"string","description":"","title":"Name"},"doctor":{"readOnly":true,"type":"string","description":"ID of the doctor who owns the office","title":"Doctor"},"country":{"readOnly":true,"enum":["","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","CYM","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string","description":"Two-letter country code","title":"Country"},"start_time":{"type":"string","description":"Truncated to the hour. Default is `00:00:00`","title":"Start time"},"fax_number":{"readOnly":true,"type":"string","description":"","title":"Fax number"},"online_timeslots":{"items":{"title":"OfficeOnlineHours","type":"object","description":"","properties":{"minute":{"type":"integer","description":"One of `0`, `15`, `30` or `45`","title":"Minute"},"day":{"type":"integer","description":"`0`(Monday), ..., `6`(Sunday)","title":"Day"},"hour":{"type":"integer","description":"From `0` to `23`","title":"Hour"}}},"type":"array","description":"Array of timslots","title":"Online timeslots"},"state":{"readOnly":true,"enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"],"type":"string","description":"Two-letter abbreviation","title":"State"},"end_time":{"type":"string","description":"Truncated to the hour. Default is `24:00`","title":"End time"},"exam_rooms":{"readOnly":true,"type":"string","description":"","title":"Exam rooms"},"address":{"readOnly":true,"type":"string","description":"","title":"Address"},"tax_id_number_professional":{"readOnly":true,"type":"string","description":"Billing Tax ID #","title":"Tax id number professional"},"zip_code":{"readOnly":true,"type":"string","description":"","title":"Zip code"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"online_scheduling":{"type":"boolean","description":"Default is `false`","title":"Online scheduling"}},"x-verbose-required":["online_timeslots"]},"TaskStatus":{"required":["name","practice_group"],"type":"object","properties":{"archived":{"type":"boolean","description":"","title":"Archived"},"name":{"type":"string","description":"","title":"Name"},"status_category":{"enum":["O","P","H","C"],"type":"string","description":"Can be one of the following `O`(open), `P`(In progress), `H`(On hold), `C`(Complete), default to `O`(Open)","title":"Status category"},"practice_group":{"type":"integer","description":"","title":"Practice group"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"task_category":{"type":"integer","description":"ID of `/api/task_categories`","title":"Task category"}},"x-verbose-required":[]},"PatientVaccineRecord":{"required":["patient","cvx_code","name"],"type":"object","properties":{"lot_number":{"type":"string","description":"Lot/batch number of the vaccine dose"},"site":{"type":"string","description":"","title":"Site"},"ordering_doctor":{"type":"integer","description":"","title":"Ordering doctor"},"doses":{"items":{"title":"VaccineDose","type":"object","description":"Vaccine dose ID","properties":{"min_age_months":{"type":"integer","description":"","title":"Min age months"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"max_age_months":{"type":"integer","description":"","title":"Max age months"},"title":{"type":"string","description":"","title":"Title"}}},"type":"array","description":"Vaccine dose IDs received in consent form signed hook","title":"Doses"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"next_dose_date":{"type":"string","description":"Date for next dose of vaccine","title":"Date for next dose"},"cpt_code":{"type":"string","description":"Vaccine cpt code","title":"Cpt code"},"completion_status":{"enum":["CP","RE","NA","PA"],"type":"string","description":"Vaccination status, can be `CP`(Complete), `RE`(Refused), `NA`(Not administered), `PA`(Partially administered)","title":"Vaccination Status"},"administered_at":{"type":"integer","description":"ID of `/api/offices` where the administration happened","title":"Administered at"},"comments":{"type":"string","description":"","title":"Comments"},"funding_eligibility":{"enum":["V01","V02","V03","V04","V05","V07"],"type":"string","description":"The funding program that should pay for a given immunization","title":"Funding Eligibility"},"units":{"type":"string","description":"","title":"Units"},"entered_by":{"readOnly":true,"type":"string","description":"ID of user who created the record","title":"Entered by"},"patient":{"type":"integer","description":"","title":"Patient"},"administration_start":{"type":"string","description":"Datetime when the administration starts","title":"Administration start"},"record_source":{"enum":["00","01","02","03","04","05","06","07","08"],"type":"string","description":"","title":"Record Type"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"consent_form":{"type":"integer","description":"Consent form related with vaccine record","title":"Consent form"},"manufacturer":{"type":"string","description":"Manufacturer of the vaccine"},"administered_by":{"type":"string","description":"ID of `/api/users` who performs the administration","title":"Administered by"},"name":{"type":"string","description":"","title":"Name"},"vis":{"readOnly":true,"type":"string","description":"Related vaccine information statement","title":"Vis"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"observed_immunity":{"enum":["398102009","409498004","397428000","18624000","91428005","271511000","240532009","6142004","52947006","14189004","23511006","36989005","27836007","16814004","14168008","36653000","76902006","66071002","4834000","111852003","38907003","40468003","16541001"],"type":"string","description":"","title":"Observed Immunity"},"amount":{"type":"number","description":"Amount of vaccine administered","title":"Amount"},"vaccine_inventory":{"type":"integer","description":"ID of `/api/vaccine_inventories` the vaccine is from","title":"Vaccine inventory"},"route":{"type":"string","description":"","title":"Route"},"cvx_code":{"type":"string","description":"Vaccine cvx code","title":"Cvx code"}},"x-verbose-required":[]},"PatientIntervention":{"required":["doctor","patient"],"type":"object","properties":{"value_name":{"readOnly":true,"type":"string","description":"Description of value","title":"Value name"},"value_code_system":{"type":"string","description":"Can be `SNOMEDCT`, `ICD10CM`, `LOINC`","title":"Value code system"},"code":{"type":"string","description":"Code from different code system","title":"Code"},"appointment":{"readOnly":true,"type":"string","description":"","title":"Appointment"},"name":{"readOnly":true,"type":"string","description":"Description of intervention","title":"Name"},"doctor":{"type":"integer","description":"","title":"Doctor"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"effective_time":{"type":"string","description":"","title":"Effective time"},"value_code":{"type":"string","description":"Code from different code system represent intervention value","title":"Value code"},"patient":{"type":"integer","description":"","title":"Patient"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"code_system":{"type":"string","description":"Can be `SNOMEDCT`, `HCPCS`, `CPT`, `ICD10CM`","title":"Code system"}},"x-verbose-required":[]},"WorkHours":{"type":"object","properties":{"start_time":{"type":"string","description":"start time of the work hour","title":"Start time"},"enabled":{"type":"boolean","description":"whether the work hour is enabled","title":"Enabled"},"id":{"readOnly":true,"type":"integer","description":"unique ID of the work hour","title":"ID"},"end_time":{"type":"string","description":"end time of the work hour","title":"End time"}}},"DoctorFeeSchedule":{"required":[],"type":"object","properties":{"code_type":{"enum":["CPT","HCPCS","Custom","ICD9","ICD10","Revenue"],"type":"string","description":"","title":"Code type"},"insured_out_of_network_price":{"type":"number","description":"","title":"Insured out of network price"},"office":{"type":"integer","description":"","title":"Office"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"code":{"type":"string","description":"","title":"Code"},"billing_description":{"type":"string","description":"","title":"Billing description"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"picklist_category":{"type":"string","description":"Optional: Category to organize the code into.","title":"Picklist category"},"allowed_amount":{"type":"number","description":"Typical allowed amount for payer. Not used if blank.","title":"Allowed amount"},"ndc_quantity":{"type":"number","description":"","title":"NDC Quantity"},"cash_price":{"type":"number","description":"","title":"Cash price"},"plan_name":{"type":"string","description":"Name of insurance plan.","title":"Plan name"},"description":{"type":"string","description":"","title":"Description"},"ndc_units":{"enum":["F2","GR","ME","ML","UN"],"type":"string","description":"","title":"NDC Units"},"ndc_code":{"type":"string","description":"","title":"NDC Code"},"payer_id":{"type":"string","description":"Fee Schedule pricing specific to this payer, if null, then applies as default to all payers without a more specific fee schedule.","title":"Payer id"},"cpt_hcpcs_modifier2":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #2"},"cpt_hcpcs_modifier3":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #3"},"cpt_hcpcs_modifier1":{"type":"string","description":"","title":"Cpt hcpcs modifier1"},"cpt_hcpcs_modifier4":{"enum":["","17","1D","22","23","24","25","26","27","29","32","33","47","50","51","52","53","54","55","56","57","58","59","62","63","66","73","74","76","77","78","79","80","81","82","83","90","91","92","93","95","96","97","99","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AD","AE","AF","AG","AH","AI","AJ","AK","AM","AO","AP","AQ","AR","AS","AT","AU","AV","AW","AX","AY","AZ","BA","BL","BO","BP","BR","BU","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","DA","E1","E2","E3","E4","EA","EB","EC","ED","EE","EJ","EM","EP","ER","ET","EX","EY","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FS","FP","FQ","FR","FX","FY","G0","G1","G2","G3","G4","G5","G6","G7","G8","G9","GA","GB","GC","GD","GE","GF","GG","GH","GJ","GK","GL","GM","GN","GO","GP","GQ","GR","GS","GT","GU","GV","GW","GX","GY","GZ","H9","HA","HB","HC","HD","HE","HF","HG","HH","HI","HJ","HK","HL","HM","HN","HO","HP","HQ","HR","HS","HT","HU","HV","HW","HX","HY","HZ","J1","J2","J3","J4","JA","JB","JC","JD","JE","JF","JG","JW","JZ","K0","K1","K2","K3","K4","KA","KB","KC","KD","KE","KF","KG","KH","KI","KJ","KK","KL","KM","KN","KO","KP","KQ","KR","KS","KT","KU","KV","KW","KX","KY","KZ","L1","LC","LD","LL","LM","LR","LS","LT","LU","M2","ME","MI","MR","MS","N1","N2","N3","NB","NH","NM","NR","NU","P1","P2","P3","P4","P5","P6","PA","PB","PC","PD","PE","PI","PL","PM","PN","PO","PS","PT","Q0","Q1","Q2","Q3","Q4","Q5","Q6","Q7","Q8","Q9","QA","QB","QC","QD","QE","QF","QG","QH","QJ","QK","QL","QM","QN","QP","QQ","QR","QS","QT","QU","QV","QW","QX","QY","QZ","RA","RB","RC","RD","RE","RI","RP","RR","RT","SA","SB","SC","SD","SE","SF","SG","SH","SJ","SK","SL","SM","SN","SP","SQ","SS","ST","SU","SV","SW","SY","SZ","T1","T2","T3","T4","T5","T6","T7","T8","T9","TA","TB","TC","TD","TE","TF","TG","TH","TJ","TK","TL","TM","TN","TP","TQ","TR","TS","TT","TU","TV","TW","TX","U1","U2","U3","U4","U5","U6","U7","U8","U9","UA","UB","UC","UD","UE","UF","UG","UH","UJ","UK","UN","UP","UQ","UR","US","V1","V2","V3","V4","V5","V6","V7","V8","V9","VP","VR","W1","W5","W6","W7","W8","W9","WC","WH","WP","X1","X2","X3","X4","X5","XE","XP","XS","XU","VM","ZA","ZB","ZL","ZS","1P","2P","3P","8P"],"type":"string","description":"","title":"CPT/HCPCS Modifier #4"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"doctor":{"type":"integer","description":"","title":"Doctor"},"insured_price":{"type":"number","description":"","title":"Insured price"},"base_price":{"type":"number","description":"","title":"Base price"}},"x-verbose-required":[]},"SignedConsentFormUpdate":{"type":"object","properties":{"appointment":{"type":"integer","description":"ID of the appointment that the consent form is signed for","title":"Appointment"},"archived":{"type":"boolean","description":"Indicates that the consent form has been archived and should not be used","title":"Archived"},"consent_form":{"type":"integer","description":"ID of the consent form that is signed","title":"Consent form"},"patient":{"type":"integer","description":"ID of the patient who signed the consent form","title":"Patient"},"signature_file":{"format":"binary","type":"string","description":"File with the signature of the patient","title":"Signature file"}},"x-verbose-required":[]},"PrescriptionMessage":{"required":[],"type":"object","properties":{"message_status":{"readOnly":true,"type":"string","description":"Message status for Incoming and Outgoing values. Success message for message_type are: `NewRx` : `Sent`, `RefillRequest` : `Received`, `RefillResponse` : `Sent`.","title":"Message status"},"patient":{"type":"integer","description":"An optional field which refers to a patient.","title":"Patient"},"doctor":{"type":"integer","description":"","title":"Doctor"},"message_type":{"type":"string","description":"Possible values are `NewRx` for outgoing new prescriptions, `RefillRequest` for incoming refill requests, `RefillResponse` for outgoing refill responses, `Error` for incoming errors, `Status` and `Verify` for incoming status reports from Surescripts.","title":"Message type"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"parent_message":{"readOnly":true,"type":"string","description":"Refers to the parent message, used for refill responses and incoming error/status reports.","title":"Parent message"},"message_direction":{"readOnly":true,"enum":["I","O"],"type":"string","description":"Possible values are `Outgoing` and `Incoming`.","title":"Message direction"},"pharmacy":{"type":"string","description":"NCPDPID allocated #ID of the Pharmacy","title":"Pharmacy"},"json_data":{"readOnly":true,"type":"string","description":"Data sent along with `NewRx`, `RefillRequest`, and `RefillResponses` messages. The format varies, but most likely it will contain `BenefitsCoordination` section with insurance info and `MedicationPrescribed` with medication info. `Patient`, `Pharmacy`, and `Prescriber` are also usually present.","title":"Json data"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"LineItemTransaction":{"required":[],"type":"object","properties":{"insurance":{"properties":{"id_number":{"type":"string","description":"Insurance company ID number","title":"ID number"},"message":{"type":"string","description":"Additional information about the insurance","title":"Message"},"name":{"type":"string","description":"Insurance company name","title":"Name"}},"type":"object","description":"Information about the insurance associated with the transaction.","title":"Insurance"},"ins_paid":{"type":"number","description":"","title":"Ins paid"},"posted_date":{"readOnly":true,"type":"string","description":"Date when transaction is created","title":"Posted date"},"appointment":{"type":"integer","description":"Appointment ID","title":"Appointment"},"ins_name":{"type":"integer","description":"Can be one of the following, `1`(Primary Insurance), `2`(Secondary Insurance)","title":"Ins name"},"doctor":{"type":"integer","description":"Doctor ID","title":"Doctor"},"adjustment_group_code":{"readOnly":true,"enum":["","CO","OA","PI","PR"],"type":"string","description":"Group code for adjustment","title":"Adjustment group code"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"line_item":{"type":"integer","description":"ID of `/api/line_item` object","title":"Line item"},"claim_status":{"readOnly":true,"enum":["","0","1","2","3","4","5","10","13","15","16","17","19","20","21","22","23","25","27"],"type":"string","description":"Status of claim","title":"Claim status"},"check_date":{"readOnly":true,"type":"string","description":"Date of check","title":"Check date"},"trace_number":{"type":"string","description":"Check number","title":"Trace number"},"adjustment_reason":{"enum":["-3","-2","-4","-1","0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","18","19","20","21","22","23","24","26","27","29","31","32","33","34","35","39","40","44","45","49","50","51","53","54","55","56","58","59","60","61","66","69","70","74","75","76","78","85","87","89","90","91","94","95","96","97","100","101","102","103","104","105","106","107","108","109","110","111","112","114","115","116","117","118","119","121","122","125","128","129","130","131","132","133","134","135","136","137","138","139","140","142","143","144","146","147","148","149","150","151","152","153","154","155","157","158","159","160","161","162","163","164","165","166","167","168","169","170","171","172","173","174","175","176","177","178","179","180","181","182","183","184","185","186","187","188","189","190","191","192","193","194","195","197","198","199","200","201","202","203","204","205","206","207","208","209","210","211","212","213","214","215","216","217","218","219","220","221","222","223","224","225","226","227","228","229","230","231","232","233","234","235","236","237","238","239","240","241","242","243","244","245","246","247","248","249","250","251","252","253","254","256","257","258","259","260","261","262","263","264","265","266","267","268","269","270","271","272","273","274","275","276","277","279","286","287","288","297","A0","A1","A5","A6","A7","A8","B1","B4","B5","B7","B8","B9","B10","B11","B12","B13","B14","B15","B16","B20","B22","B23","P1","P2","P3","P4","P5","P6","P7","P8","P9","P10","P11","P12","P13","P14","P15","P16","P17","P18","P19","P20","P21","P22","P23","W1","W2","W3","W4","Y1","Y2","Y3"],"type":"string","description":"Reason for adjustment","title":"Adjustment reason"},"patient":{"type":"integer","description":"","title":"Patient"},"adjustment":{"type":"number","description":"Adjustment from total billed","title":"Adjustment"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"}},"x-verbose-required":[]},"ReminderProfile":{"required":["doctor","reminders"],"type":"object","properties":{"reminders":{"items":{"title":"ReminderTemplate","type":"object","description":"Array of reminders","properties":{"amount":{"type":"integer","description":"","title":"Amount"},"type":{"enum":["email","sms","phone","auto_call"],"type":"string","description":"One of `\"email\"`, `\"sms\"` or `\"auto_call\"`","title":"Type"},"unit":{"enum":["minutes","hours","days","weeks"],"type":"string","description":"One of `\"email\"`, `\"sms\"` or `\"auto_call\"`","title":"Unit"}}},"type":"array","description":"Reminders set in the profile","title":"Reminders"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"","title":"Name"},"doctor":{"type":"integer","description":"Doctor who created the profile. Other doctors in the practice group may have access to their profiles","title":"Doctor"}},"x-verbose-required":[]},"Task":{"required":["title","status"],"type":"object","properties":{"category":{"type":"integer","description":"","title":"Category"},"due_date":{"title":"TaskReminder","type":"object","description":"When the task is due","properties":{"time":{"type":"string","description":"Due date time","title":"Time"}}},"archived":{"type":"boolean","description":"","title":"Archived"},"associated_items":{"items":{"title":"AssociatedTaskItem","type":"object","description":"","properties":{"task":{"type":"integer","description":"","title":"Task"},"type":{"enum":["Document","Message","Lab result","Lab order","Patient","Appointment","Lab document","Communication"],"type":"string","description":"Can be one of `\"Appointment\"`, `\"Patient\"`, `\"Message\"`, `\"Document\"`, `\"Lab order\"`","title":"Type"},"value":{"type":"integer","description":"ID of the specified type object","title":"Value"}}},"type":"array","description":"Associated task items","title":"Associated items"},"assigned_by":{"readOnly":true,"type":"string","description":"ID of `/api/users/` who assigned the task","title":"Assigned by"},"assignee_user":{"type":"string","description":"Either `assignee_user` or `assignee_group` should be set","title":"Assignee user"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"assignee_group":{"type":"integer","description":"Either `assignee_user` or `assignee_group` should be set","title":"Assignee group"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"created_by":{"readOnly":true,"type":"string","description":"ID of `/api/users` who created the task","title":"Created by"},"priority":{"enum":["10","20","30","40"],"type":"string","description":"Can be one of the following 10(Low), 20(Medium), 30(High), 40(Urgent)","title":"Priority"},"status":{"type":"integer","description":"","title":"Status"},"notes":{"items":{"title":"TaskNote","type":"object","description":"Task note object","properties":{"archived":{"type":"boolean","description":"","title":"Archived"},"task":{"type":"integer","description":"ID of `/api/tasks`","title":"Task"},"text":{"type":"string","description":"","title":"Text"},"created_at":{"readOnly":true,"type":"string","description":"","title":"Created at"},"updated_at":{"readOnly":true,"type":"string","description":"","title":"Updated at"},"created_by":{"readOnly":true,"type":"string","description":"","title":"Created by"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}}},"type":"array","description":"Additional notes of the task","title":"Notes"},"title":{"type":"string","description":"","title":"Title"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":["notes","associated_items"]},"LabOrder":{"required":["sublab","doctor","patient"],"type":"object","properties":{"status":{"type":"string","description":"Equivalent to HL7's ORC.5. Defaults to `\"N\"`.\nValue | Notes\n----- | -----\n`\"N\"` | not sent                                          |\n`\"Q\"` | queued for processing                             |\n`\"A\"` | `ABN (Advance Beneficiary Notice)` required       |\n`\"S\"` | send                                              |\n`\"R\"` | results received                                  |\n`\"E\"` | error                                             |\n","title":"Status"},"documents":{"items":{"type":"string","description":"ID of an associated lab document","title":""},"readOnly":true,"type":"array","description":"Associated `/lab_documents` objects","title":"Documents"},"patient":{"type":"integer","description":"","title":"Patient"},"doctor":{"type":"integer","description":"","title":"Doctor"},"timestamp":{"readOnly":true,"type":"string","description":"Time at which the order was submitted. Defaults to now","title":"Timestamp"},"notes":{"type":"string","description":"","title":"Notes"},"accession_number":{"type":"string","description":"For external use only","title":"Accession number"},"requisition_id":{"readOnly":true,"type":"string","description":"The ID printed on the requisition PDF. Generally the same as id.","title":"Requisition id"},"external_requisition_id":{"type":"string","description":"Alternative requisition ID field for orders created outside of DrChrono.","title":"External Requisition ID"},"priority":{"enum":["N","S"],"type":"string","description":"`\"Normal\"` or `\"STAT\"`. Default `\"Normal\"`","title":"Priority"},"icd10_codes":{"items":{"title":"ICD10Code","type":"object","description":"","properties":{"code":{"type":"string","description":"The numeric ICD-10 code","title":"Code"},"description":{"readOnly":true,"type":"string","description":"Short description  of the ICD-10 code","title":"Description"}}},"type":"array","description":"ICD-10 codes of the conditions which the tests concerns.","title":"Icd10 codes"},"sublab":{"type":"integer","description":"","title":"Sublab"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"}},"x-verbose-required":[]},"Insurance":{"required":[],"type":"object","properties":{"payer_name":{"type":"string","description":"","title":"payer_name"},"state":{"type":"string","description":"","title":"state"},"payer_id":{"type":"string","description":"","title":"payer_id"}}},"CustomPatientFieldType":{"required":["doctor","name"],"type":"object","properties":{"archived":{"type":"boolean","description":"Indicates that the object has been soft-deleted, and should not be used","title":"Archived"},"description":{"type":"string","description":"","title":"Description"},"doctor":{"type":"integer","description":"","title":"Doctor"},"template_name":{"type":"string","description":"Custom Patient Demographics with `template_name` set can be inserted into clinical notes via Form Builder. Only letters (a-z or A-Z), numbers (0-9) or underscore(_) are allowed for template name.","title":"Template name"},"allowed_values":{"type":"string","description":"Allowed values if needed. Values must be separated by comma `,`","title":"Allowed values"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"","title":"Name"}},"x-verbose-required":[]},"SoapNoteLineItemFieldType":{"required":[],"type":"object","properties":{"comment":{"type":"string","description":"Comment","title":"Comment"},"archived":{"type":"boolean","description":"Indicates that the field has been soft-deleted by the doctor and will not be used in future notes","title":"Archived"},"clinical_note_template":{"readOnly":true,"type":"string","description":"ID of the `/api/clinical_note_templates` object that the field belongs to","title":"Clinical note template"},"data_type":{"type":"string","description":"One of `\"\"`, `\"Checkbox\"`, `\"NullCheckbox\"`, `\"String\"`, `\"TwoStrings\"`, `\"FreeDraw\"`, `\"Photo\"`, `\"Header\"`, `\"Subheader\"`","title":"Data type"},"required":{"type":"boolean","description":"Indicates that a note should not be locked unless a value is provided for this field","title":"Required"},"allowed_values":{"items":{"type":"string","description":"Value option","title":""},"type":"array","description":"Value options the field type relies on if applicable, otherwise it will be an empty array","title":"Allowed values"},"id":{"readOnly":true,"type":"integer","description":"","title":"ID"},"name":{"type":"string","description":"","title":"Name"}},"x-verbose-required":[]}}},"openapi":"3.0.0"}