[{"_1":2,"_957":-5,"_958":-5},"loaderData",{"_3":4,"_951":952},"root",{"_5":6,"_7":8,"_15":16,"_23":24,"_86":-5,"_87":88,"_98":99,"_763":764,"_786":787,"_941":942,"_943":944,"_945":946,"_947":-5,"_948":30,"_949":30,"_950":-5},"cspNonce","ce3394193a8b2f6481f01ab5173e2a3f4350d8eafb9631e5fd009d7c25abb155","firebaseConfig",{"_9":10,"_11":12,"_13":14},"apiKey","AIzaSyDCG_xdkCxQ0mNJT1LKg2XIf0cHJwSISYU","authDomain","mdintegrations.portal.unthread.io","projectId","unthread","session",{"_17":18,"_21":22},"user",{"_19":20,"_21":22},"uid","anon_1780794405877_f4maepr","anonymous",true,"portal",{"_25":26,"_27":28,"_29":30,"_31":22,"_32":-5,"_33":12,"_34":-5,"_35":-5,"_36":37,"_39":40,"_41":42,"_43":44,"_45":46,"_54":55,"_56":-5,"_57":58,"_65":-5,"_66":22,"_67":22,"_68":69,"_70":71},"id","852699fe-70a3-4b1c-9991-da12986546aa","tenantId","u-mdintegrations-6amg5","isExternal",false,"isEnabled","customDomain","defaultDomain","signInEmailSender","previewUrl","projectIds",[38],"a6f13bd5-78fd-4dec-a892-add6a08db66f","customLinks",[],"featuredCollections",[],"ticketTypeSections",[],"settings",{"_47":48,"_49":50,"_51":52,"_53":22},"logoUrl","https://firebasestorage.googleapis.com/v0/b/trnout-co.appspot.com/o/u-mdintegrations-6amg5%2Fslack%2FLogo.png.png?alt=media","primaryColor","#000000","darkThemeAccentColor","#ffffff","allowDirectTicketCreation","identityPlatformTenantId","i-mdintegrations-p9aho","homepageMetadata","loginMethods",[59,63],{"_60":61,"_62":22},"type","magicLink","enabled",{"_60":64,"_62":30},"sso","statusBanner","requireAuthentication","restrictLoginToAccountDomains","embedAllowedOrigins",[],"tenant",{"_25":28,"_72":73,"_74":75,"_76":77,"_79":80},"name","MD Integrations","subdomain","mdintegrations","allowedEmailDomains",[78],"mdintegrations.com","allowedPriorities",{"_81":30,"_82":22,"_83":22,"_84":22,"_85":22},"1","3","5","7","9","userProfile","projects",[89],{"_72":90,"_91":-5,"_92":-5,"_93":-5,"_94":-5,"_95":96,"_97":96,"_25":38,"_27":28},"Engineering","supportName","supportLogo","description","defaultTriageChannelId","createdAt","2025-07-01T20:24:59.618Z","updatedAt","articles",[100,116,124,132,140,148,157,166,174,182,190,198,206,213,221,229,237,245,254,262,270,278,287,295,303,311,319,327,336,344,352,360,368,376,383,391,399,408,416,424,437,445,454,463,471,483,492,500,508,516,524,532,540,548,557,565,573,581,588,596,605,613,621,630,638,646,654,662,671,680,688,696,704,712,721,729,738,746,754],{"_101":102,"_103":104,"_105":-5,"_106":107,"_108":-5,"_13":-5,"_95":109,"_97":109,"_25":110,"_27":28,"_111":-5,"_112":113,"_114":115},"title","Access to clinicians app and sign-in issue","slug","access-to-clinicians-app-and-sign-in-issue","url","content","To get access to our [Clinicians App](https://app.mdintegrations.com), you'll have to create a support user account from your company's dashboard under Operations > Management > Support Staff > Add new. You'll receive your user credentials via email.","collectionId","2025-08-27T22:01:48.182Z","73097c51-8d73-4ad6-91e9-44972fcaed13","collection","userGroups",[],"channels",[],{"_101":117,"_103":118,"_105":-5,"_106":119,"_108":-5,"_13":-5,"_95":120,"_97":120,"_25":121,"_27":28,"_111":-5,"_112":122,"_114":123},"Address mismatch on RX and Try Ageless file","address-mismatch-on-rx-and-try-ageless-file","We don't share any company address from our partners when transmitting prescriptions over to the pharmacy, so that is probably something you'll have to check with the pharmacy directly.","2025-08-01T15:40:14.625Z","f9758d1b-0655-493f-b27c-d93a31d24289",[],[],{"_101":125,"_103":126,"_105":-5,"_106":127,"_108":-5,"_13":-5,"_95":128,"_97":128,"_25":129,"_27":28,"_111":-5,"_112":130,"_114":131},"API questions on access tokens, rate limits and idempotency","api-questions-on-access-tokens-rate-limits-and-idempotency","\nPartner just need a new API credential ( `client_id` and `client_secret`) for authenticating with our API once. However, the access token generated must be refreshed at least every 24 hours for any API requests.\n\nPatient and Case creation should happen instantaneously as soon as you call the corresponding endpoint. Please note that cases will be set as sync (routine) by default and only be changed to async (extended care) at the doctor's discretion to accommodate specific needs or requirements (like state regulatory requirements).\n\nYes, we support idempotency. If a request fails/returns an error, you can retry it again consecutively. Even though we don't have any API rating limits, if our security monitoring flags any high volumes of errors coming from your API calls for instance, we'll reach out to your team to avoid having your IP blocked.","2026-03-02T17:03:43.030Z","cbdbb039-9a94-4eed-9dd2-6ef0778279a3",[],[],{"_101":133,"_103":134,"_105":-5,"_106":135,"_108":-5,"_13":-5,"_95":136,"_97":136,"_25":137,"_27":28,"_111":-5,"_112":138,"_114":139},"Approval process for Offerings and Intakes (questionnaires)","approval-process-for-offerings-and-intakes-questionnaires","Thank you for submitting your request. Our offerings and intakes review process has been updated and requires through medical review. This can take a minimum of 24 hours","2026-02-25T16:22:20.953Z","8ebb1b30-a75c-459d-bcfb-6171aa6304e6",[],[],{"_101":141,"_103":142,"_105":-5,"_106":143,"_108":-5,"_13":-5,"_95":144,"_97":144,"_25":145,"_27":28,"_111":-5,"_112":146,"_114":147},"Assistance with adding an additional company to MDI Portal","assistance-with-adding-an-additional-company-to-mdi-portal-2"," You can create an additional company account by accessing [http://mdintegrations.com|mdintegrations.com](http://mdintegrations.com%7Cmdintegrations.com) and clicking at the Sign Up button (at the top right hand side). Once you complete the form, let me know and I'll switch your company's status over to Onboarding, so you can complete the onboarding steps.","2025-07-16T15:25:35.661Z","748e163e-822a-4261-a2e3-622ac04d3fe1",[],[],{"_101":149,"_103":150,"_105":-5,"_106":151,"_108":-5,"_13":-5,"_95":152,"_97":153,"_25":154,"_27":28,"_111":-5,"_112":155,"_114":156},"Assistance with resetting MDI password","assistance-with-resetting-mdi-password","To reset your MDI password, go to MDI's portal login page and click the 'forgot password' button, which will send a password reset link to your email.","2025-08-25T21:57:12.624Z","2025-08-27T21:29:25.707Z","3ebc1d25-0670-43f2-ac96-8e829493d7a7",[],[],{"_101":158,"_103":159,"_105":-5,"_106":160,"_108":-5,"_13":-5,"_95":161,"_97":162,"_25":163,"_27":28,"_111":-5,"_112":164,"_114":165},"Async (Routine cases) vs. Sync (Extended Care) cases","routine-cases-async-vs-extended-care-sync-cases","By default, all encounters will be considered as Routine (Async). Moreover, Under the US law, some states require some sort of audio/video interaction between the doctor and the patient. While some states may accept an introduction video recording from the patient as an evidence of the sync visit being executed (AV states), others require that interaction to be completely live (Sync states).\\\nFor the first scenario, the consult/encounter will still be considered as a Routine (Async) visit. For the second scenario, doctors have the discretion, in terms of modality of care, if the encounter should be treated as synchronous or asynchronous. If they deem appropriate, they will set the encounter as synchronous (Extended Care), which could be because a video or phone call took place with the patient (the doctor will initiate it).\n\nTo find out which states require an intro video from the patient (AV states), you may use the Get States endpoint and look for the field is_av_flow.\n\nWe don't have a pre-defined list of the sync states though, as these states will be classified as such based on the state licensing details from the doctor.","2026-03-05T20:52:21.417Z","2026-03-05T22:10:21.737Z","b7c7111d-4143-4df2-86ce-7fa27493564a",[],[],{"_101":167,"_103":168,"_105":-5,"_106":169,"_108":-5,"_13":-5,"_95":170,"_97":170,"_25":171,"_27":28,"_111":-5,"_112":172,"_114":173},"AV states x Sync states","av-states-x-sync-states","\n**Sync** and **AV state** have distinct requirements.\\\nUnder the US law, some states require some sort of audio/video interaction between the doctor and the patient. While some states may accept an introduction video recording from the patient as an evidence of the sync visit being executed (**AV states**), others require that interaction to be completely live **(Sync states**). For this second scenario, doctors have the discretion, in terms of modality of care, if the encounter should be treated as **synchronous** or **asynchronous** . If they deem appropriate, they will set the encounter as **synchronous (extended care)**, which could be because a video or phone call took place with the patient (the doctor will initiate it).\n\nTo find out which states **require** an intro video from the patient **(AV states**), you may use the [Get States](https://api.mdintegrations.com/#7a1c2ee5-4d37-4941-8efd-c16f23627699) endpoint and look for the field `is_av_flow`\\\nWe don't have a pre-defined list of the **sync states** though, as these states will be classified as such based on the state licensing details from the doctor.\\\n\\\nFor the AV states, the consult/encounter will still be considered as an async (routine) visit.","2026-01-26T18:24:14.221Z","37d13d35-25f8-4fca-82c7-7e2aab34298f",[],[],{"_101":175,"_103":176,"_105":-5,"_106":177,"_108":-5,"_13":-5,"_95":178,"_97":178,"_25":179,"_27":28,"_111":-5,"_112":180,"_114":181},"Case and Patient Tags","case-and-patient-tags","\n**Tags** are brief, descriptive labels used to categorize or highlight important details about a patient or an encounter. They act as visual elements that allow users to identify a patient’s status or needs at a glance, without having to read through entire clinical notes.\\\n\\\n**Common uses include:**\n\n- **Clinical Urgency:** Labeling a case as *Critical* or *Urgent*.\n- **Action Required:** Indicating a status like *Awaiting Documents* or *Pending Info*.\n- **Special Precautions:** Highlighting the need for *Extra Care* or *Caution*.\\\n \\\n Partners can create and manage Tags from their company's dashboard or using [this](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#1fe7edee-d205-46d3-8d05-f34e85f1b8d3) Endpoint.\\\n [Here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#fdb6c60f-a1fa-4dca-8d81-934f41d6a892) and [Here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#3d0643a1-63d6-4592-99b3-2e435799b4a4) are the Endpoints for attaching/detaching tags to Patients and Encounters. ","2026-02-06T00:53:19.278Z","8179e5da-d493-4d66-aa3f-1547b97b093c",[],[],{"_101":183,"_103":184,"_105":-5,"_106":185,"_108":-5,"_13":-5,"_95":186,"_97":186,"_25":187,"_27":28,"_111":-5,"_112":188,"_114":189},"Case reassignment rules","case-reassignment-rules","For cases reassignment, our algorithm will check the following rules:\\\n- Partner reassignment settings\\\n- Doctors licensing details\\\n- Doctors priority level (exclusive, normal, non-preferred, etc.)\\\n- Doctors availability (OOO or online)\\\n- Case type (new or follow-up)\\\n- Case priority level (expedited or not)","2026-04-09T14:53:25.810Z","2e5444bd-f263-4b6a-8720-8cb82bfea887",[],[],{"_101":191,"_103":192,"_105":-5,"_106":193,"_108":-5,"_13":-5,"_95":194,"_97":194,"_25":195,"_27":28,"_111":-5,"_112":196,"_114":197},"Cases sitting in Created","cases-sitting-in-created","We don't want to assign cases to doctors if they're not complete/have all the required information for the doctor to starting working it and we don't move cases to any queue without assigning them to a doctor first. That will apply not only to the AV video, but to any missing information from the patient.\n\nIf we detect that the patient has not uploaded the requested files within **72 hours**, the case will get automatically moved to the **Assigned** queue. This ensures that the doctor can proactively reach out to the patient and attempt to connect with them, helping move the process forward and avoid leaving the patient without assistance. \n\nCases will move to the Waiting Patient queue whenever the doctor messages the patient and are waiting for their response.","2026-04-10T15:26:14.129Z","52aaed23-47d7-4d4e-94a7-6d528003abc4",[],[],{"_101":199,"_103":200,"_105":-5,"_106":201,"_108":-5,"_13":-5,"_95":202,"_97":202,"_25":203,"_27":28,"_111":-5,"_112":204,"_114":205},"Clarification on API Workflow for Patient and Case Management","clarification-on-api-workflow-for-patient-and-case-management","We don't manage the order and fulfillment flow on our side. We'll only manage the e-prescribing part of the process. For the *pharmacies that require an order to be sent to them,* you'll have to put additional systems/development work to receive a webhook notification from us (normally the *Offering Submitted* webhook) and put an electronic order with the pharmacy using their ordering API. Some pharmacies may also support receiving the order manually through their EHR system or email.\n\nPlease check the \"How to integrate with a pharmacy\" step from your company's integration steps for more details on how the order and fulfillment process will normally work at the pharmacies.","2026-01-23T17:09:45.324Z","4172055e-82d1-43a9-9f07-6bc09a62e06b",[],[],{"_101":199,"_103":207,"_105":-5,"_106":208,"_108":-5,"_13":-5,"_95":209,"_97":209,"_25":210,"_27":28,"_111":-5,"_112":211,"_114":212},"clarification-on-api-workflow-for-patient-and-case-management-2","We don't manage the order and fulfillment flow on our side. We'll only manage the e-prescribing part of the process, which will end once the prescription gets submitted over to the pharmacy. For the *pharmacies that require an order to be sent to them,* you'll have to put additional systems/development work to receive a webhook notification from us (normally the *Offering Submitted* webhook) and put an electronic order with the pharmacy using their ordering API. Some pharmacies may also support receiving the order manually through their EHR system or email.\n\nPlease check the \"How to integrate with a pharmacy\" step from your company's integration steps for more details on how the order and fulfillment process will normally work at the pharmacies.","2026-01-23T17:11:38.119Z","e9efcf02-5506-4c51-ad81-50f8ea63c6ef",[],[],{"_101":214,"_103":215,"_105":-5,"_106":216,"_108":-5,"_13":-5,"_95":217,"_97":217,"_25":218,"_27":28,"_111":-5,"_112":219,"_114":220},"Clarification on Identity Score for Prescription","clarification-on-identity-score-for-prescription","The minimum score for Vouched 0,9. If Vouched is run and the patient's resulting score is equal to 0.9 or higher, the patient's ID will not be required.","2026-01-12T20:01:07.158Z","0b527e3f-c990-40db-8550-22d3c543c547",[],[],{"_101":222,"_103":223,"_105":-5,"_106":224,"_108":-5,"_13":-5,"_95":225,"_97":225,"_25":226,"_27":28,"_111":-5,"_112":227,"_114":228},"Clarification on information that MDI sends over to pharmacies","clarification-on-information-that-mdi-sends-over-to-pharmacies","We don't send any patient or prescription IDs over to pharmacies. We'll basically just send patient profile and prescription details over to them, along with the Pharmacy Notes. Normally pharmacies will use the Pharmacy notes details that we send within every prescription to match prescriptions with orders.\n\nBy default, we'll send the following information within this field:\\\n**Company:** your_company_name **Patient ID:** [patientemail@email.com](mailto:patientemail@email.com) **Case ID:** c0ef5368-1094-4d28-9eaa-65feed6abcd.\n\nPlease note that if any text is added to the Pharmacy notes field (either from the offering settings or via API), it'll overwrite this default information.","2026-01-16T14:54:50.801Z","683320bc-70ed-4dee-9626-6f48e41f6f61",[],[],{"_101":230,"_103":231,"_105":-5,"_106":232,"_108":-5,"_13":-5,"_95":233,"_97":233,"_25":234,"_27":28,"_111":-5,"_112":235,"_114":236},"Clarification on User-Flow and Integration Queries","clarification-on-user-flow-and-integration-queries","\n\\\nOur doctors will normally prescribe only whatever has been attached to the patient's encounter. If they want/need to prescribe a different offering, they'll normally request your Support team's approval first and your team will manage the offering updates.\n\n\\\nOur plug-in doesn't manage anything related to payment (it's all within Shopify) and we'll still charge your company if the patient's treatment is rejected by the doctor. If you decide to reimburse the patient in those scenarios, you'll have to manage it on your side.\n\n\\\nPlease note that we don't have any order, fulfillment or delivery integration with pharmacies yet, which means we'll only manage the e-prescribing part of the process. As for the prescriptions transmission to the pharmacy, you'll receive both *Case Completed* and *Offering Submitted* once the pharmacy acknowledges receipt of the prescriptions we sent them.\n\n\\\nFor GLP-1 medications, we normally have both an Initial and a Refills intake, but whenever a returning user use the same email address during checkout, we'll recognize them as a returning patient. Even outside of the Shopify integration, whenever users use an existing email address when filling out an intake, we'll recognize them as a returning patient.","2025-12-15T23:08:38.625Z","1506cdaf-921c-4c46-8c7e-890a712150fe",[],[],{"_101":238,"_103":239,"_105":-5,"_106":240,"_108":-5,"_13":-5,"_95":241,"_97":241,"_25":242,"_27":28,"_111":-5,"_112":243,"_114":244},"Clarify difference between message_created and notification_sent webhooks","clarify-difference-between-message-created-and-notification-sent-webhooks","The **Notification Sent** webhook corresponds to the message notifications events that are generated within our Clinicians App and will be dispatched when a \"new message\" notification is created in one of the inboxes below:\\\n• `triage`\\\n• `clinician`\\\n• `support_staff`\\\n• `internal_support_staff`\\\n• `dismissed`\n\nPartner can only refer to the **Message Created** webhook for tracking messages sent over to patients from MDI.","2026-03-06T16:21:11.098Z","908909e9-121e-4ad3-a847-c24832409cf2",[],[],{"_101":246,"_103":247,"_105":-5,"_106":248,"_108":-5,"_13":-5,"_95":249,"_97":250,"_25":251,"_27":28,"_111":-5,"_112":252,"_114":253},"Custom domain validation","custom-domain-validation","If your company's domain is still being validated on MDI, please review your DNS entries set-up and click 'Validate' again.\\\nIs case it still doesn't work, you can use tools like mxtoolbox or easydmarc to test your domain for SPF, DMARC and DKIM checks to make sure it's recognized properly.\n\nIn addition to those validations, make sure you check the following ones:\n\n1. *Cached or Conflicting Records*\\\n • If old SPF/DKIM/DMARC records still exist, they may conflict with the new ones.\\\n • Multiple SPF records instead of a single combined record (SPF only supports one record).\n2. *Wrong Domain Level*\\\n • Records applied at the root domain instead of the subdomain (e.g., [http://example.com|example.com](http://example.com%7Cexample.com) vs. [http://mail.example.com|mail.example.com](http://mail.example.com%7Cmail.example.com)).\\\n • Validation often fails if you’re validating [http://mail.example.com|mail.example.com](http://mail.example.com%7Cmail.example.com) but only updated [http://example.com|example.com](http://example.com%7Cexample.com).\n3. *Email Service Provider Issues*\\\n • Check for formatting errors (quotes, semicolons, spaces) will cause validation failures.\n4. *Domain Restrictions or Registry Issues*\\\n • If the domain is new, some registrars impose temporary restrictions.\\\n • Some country-code TLDs have quirks (like `.br` or `.uk`) that affect TXT record formats.\n\nBesides the 2 SPS (TXT) records, you’ll also need to add the 3 DKIM CNAME records exactly as shown in the MDI portal (they’ll look like `xxxx._domainkey.digbihealth.com` pointing to `xxxx.amazonses.com`).\n\nOnce those are in place, validation should go through.Typically DNS updates propagate pretty quickly, often within 15-20 minutes, though we usually say up to about an hour to be safe.\n\nIf you believe these records are already in place, feel free to send over a screenshot of your DNS and we'll be happy to take a look at those for you. \n\nAlso, if you're using a subdomain, make sure you update the TXT record name from `amazonses` to `_amazonses.mdi`, as the records need to include the subdomain prefix.","2025-08-29T23:29:49.614Z","2026-03-18T22:07:52.302Z","fce20400-e185-40b3-addc-9bb57ef0c1f1",[],[],{"_101":255,"_103":256,"_105":-5,"_106":257,"_108":-5,"_13":-5,"_95":258,"_97":258,"_25":259,"_27":28,"_111":-5,"_112":260,"_114":261},"Custom email domain configuration","custom-email-domain-configuration","\\\nFrom our end, we'll basically just validate if the information provided is accurate by validating it after the records propagate.\n\nTherefore, can you please follow these steps below to ensure proper configuration?\n\n1. *Verify DNS Entries*: Ensure that the DNS records for SPF, DKIM, and DMARC are correctly configured for your domain. You can use tools like MXToolbox or EasyDMARC to validate these settings.\n\n2. *Check for Cached or Conflicting Records*:\\\n • Look for any old or conflicting DNS records, such as multiple SPF entries (SPF only supports one record).\\\n • Remove outdated DKIM or DMARC records that may interfere with validation.\n\n3. *Confirm Domain Level*:\\\n • Ensure that the DNS records are applied at the correct domain level (e.g., root domain vs. subdomain). For example, if you are validating [http://mail.example.com|mail.example.com](http://mail.example.com%7Cmail.example.com), ensure the records are not mistakenly applied to [http://example.com|example.com](http://example.com%7Cexample.com).\n\n4. *Check for Formatting Errors*:\\\n • Verify that there are no formatting issues in the DNS entries, such as misplaced quotes, semicolons, or extra spaces.\n\n5. *Domain-Specific Restrictions*:\\\n • If the domain is newly registered, check with your registrar for any temporary restrictions or specific requirements for your domain's TLD (e.g., .uk, .br).\n\n6. *Revalidate the Domain*:\\\n • After making the necessary adjustments, click the \"Validate\" button again in the domain settings interface.\n\nIf the issue persists after completing these steps, please let us know so we can share more insights.","2026-03-03T21:36:38.752Z","90dd521e-ae68-48a4-8eab-9024875f3ad1",[],[],{"_101":263,"_103":264,"_105":-5,"_106":265,"_108":-5,"_13":-5,"_95":266,"_97":266,"_25":267,"_27":28,"_111":-5,"_112":268,"_114":269},"Direct-to-Pharmacy Order API Endpoints and Webhook Events","direct-to-pharmacy-order-api-endpoints-and-webhook-events","**Order Management Overview**\\\nIn our ecosystem, an \"Order\" typically refers to the fulfillment stage of a treatment plan. Once a clinician reviews and approves a case, it transitions into the ordering phase where prescriptions are submitted for fulfillment. We provide both synchronous endpoints to manage these orders and asynchronous webhooks to keep your application's database in sync with fulfillment status changes.\\\n\\\n**Order API Endpoints**\\\nThese endpoints allow the partner's system to interact directly with the fulfillment lifecycle within the Direct-to-Pharmacy integration:\\\nMethod\\\nEndpoint\\\nDescription\\\nGET\\\nGet Case Orders\\\nReturn a list of case's orders.\n\nGET\\\nGet Case Order Events\\\nReturn a list of order's events.\n\nPOST\\\nSubmit Case Order\\\nSubmit the order to be created in the Pharmacy API.\n\nPOST\\\nCancel Case Order\\\nCancel the order created in the Pharmacy API.\n\nPATCH\\\nUpdate Case Order\\\nUpdates the case order.\n\n**Order Webhook Events**\\\nWhen these trigger, our system sends a POST request to the partner's registered HTTPS endpoint:\\\norder_status_changed: This event will be dispatched when a order status changes.\\\norder_tracking_number_changed: This event will be dispatched when a order tracking number changes.\\\nOrder Webhook Payload Breakdown\\\nWhen an event like order_tracking_number_changed or order_status_changed triggers, the partner will receive a POST request containing the following JSON object:\\\ntimestamp: the Unix timestamp of when the event first occurred. Note: For retries, this timestamp remains consistent with the original attempt.\\\nevent_type: the specific identifier for the action (e.g., order_tracking_number_changed or order_status_changed).\\\nencounter_id: unique identifier for the specific medical encounter associated with the order.\\\ncase_id: unique identifier for the specific medical encounter associated with the order, synonymous with encounter_id.\\\norder_status: The current lifecycle stage of the order (e.g., \"fulfilled\").\\\norder_details: A string containing additional context, such as the tracking number.","2026-05-28T23:42:11.038Z","8d84ed41-b43e-44bb-b9c9-49b9e0da133c",[],[],{"_101":271,"_103":272,"_105":-5,"_106":273,"_108":-5,"_13":-5,"_95":274,"_97":274,"_25":275,"_27":28,"_111":-5,"_112":276,"_114":277},"Encounter status report","encounter-status-report","Partners can extract an encounters report from their company's dashboard (under Account > Reconcile/Export) and filter by encounter status.\n\nThe reason notes added when cancelling/rejecting an encounter can be retrieved by calling the [Get Case](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#e52dacfd-8052-472c-9b48-84030f13b976) Endpoint.","2026-01-26T23:35:26.157Z","4c18762b-54dc-40ce-81b9-f5accf4e9e07",[],[],{"_101":279,"_103":280,"_105":-5,"_106":281,"_108":-5,"_13":-5,"_95":282,"_97":283,"_25":284,"_27":28,"_111":-5,"_112":285,"_114":286},"FAQ - MDI flows and business processes 2","faq-mdi-flows-and-business-processes-2","FAQ - MDI flows and business processesRefills and monthly subscriptionsWe don't have any logic in place to calculate the remaining number of refills pending for a patient and then trigger an event (like a reorder reminder or a new case) based on that.\\\n\\\n**For use cases like hair loss and ED**: we'll do up to a year supply of refills. Considering that we'll only manage the e-prescribing flow, once the prescription is at the pharmacy you would just initiate orders through the pharmacy ordering API on your side (as you would for traditional e-commerce fulfillment). The pharmacies will tick down our refills over the course of the year to zero without additional action from the doctor. On MDI, the doctor would be available for the patient any time during that year for messaging (with no additional charge). Once the prescriptions expires (after the one-year period), you’ll need to create a new encounter for the patient. This means that patients will likely need to repeat the initial process: select a product from your store, complete the checkout and fill out the intake form associated with the product.\\\n\\\n**For weight-loss**: when using our Shopify plug-in, one option is to create separate products specifically for refills. You can then set up an email automation to send patients a link to that refill product on Shopify after a certain period following the original order. When they check out, they’ll be prompted to complete a refill intake (which you'll associate with the refill product on MDI), ensuring everything is processed correctly. As for the subscriptions, currently, our plug-in doesn’t include any logic for subscription models or for tracking the remaining supplies on multi-month products. The process is straightforward: it simply links a product to an intake and presents that intake to the patient after they go through the checkout process. That said, you can still handle multi-month products by either collecting payment upfront and/or using third-party vendors or other plug-ins that manage subscriptions within Shopify (I'm not familiar with how that works in details, though).\n\n**Shopify payment processors:** Visa and Mastercard are starting to make threats to banks that do the underwriting for merchant accounts. We have seen it happening with general payment processors, so Shopify doing it is not a surprise. First, if Shopify is creating obstacles for you to launch your store, you definitely want to explain that you do not sell medications, you book consultations for the Doctor whom makes a medical decision as to whether or not they will prescribe the medication. If the doctor decides not to prescribe the medication, the client is not charged and the hold is released and goes back to their card. Tell Shopify's support team that it is illegal to sell medications and therefore, your company does not participate in that. Medication may only be prescribed by a doctor and that is what your company coordinates.\u000b\u000b Next, explain to them that your company is LegitScript certified (if that's the case), and authorized to work with doctors to give the patient an opportunity to receive a prescription and that you abide by all laws and regulations, which is what was necessary to obtain your LegitScript certification.\u000b\u000b If that fails, ask to be escalated to a supervisor for the opportunity to provide your LegitScript documentation so that you can clear this up. If they push back, you can always offer them the opportunity to speak to your healthcare attorney if you have one. So that you can clear this up. If that fails, you may need to look for a bank that uses [authorize.net](http://authorize.net/) or something similar to go through the Shopify storefront who is willing to take on that type of risk with you offering those products.\n\n**Figma dashboard (Partners Onboarding Steps, MDI Integration Options, End-to-end User Journey and White Labeled Email Notifications)**\n\n**Partners Sign Up and Onboarding Steps:** \n\n**MDI Integration options:** \n\n**End-to-end user journey for partners that plan to use MDI's white labeled intakes:** \n\n**White Labeled email notifications:** \n\n**Shopify plug-in: set-up and user flow**\n\nOur Shopify plug-in designed for partners that already have or plan to create a Shopify store for marketing their products. It allows for a seamless and quick integration of your Shopify store with MDI white-labeled intake forms. For detailed information about the steps required for installing the Shopify Plug-in and getting your integration started, you can access your company's dashboard from our [Partners Website](https://mdintegrations.com/) and go to **Integration > App Setup > Shopify**. You can get started by first creating a Shopify test store and attempting to install and set up the plug-in by following the steps from our website. The integration process primarily involves following the provided instructions on the plug-in screen to install it and complete all the integration steps.\n\nIt's also mandatory to use our white labeled solutions (intake forms and messaging app) when integrating via our plug-in. If that's the chosen integration, you'll then have to do the **product - intake - offering** associations from your Company's dashboard under **Integration > Shopify**. You have to make sure each one of your company's products in Shopify is associated with one intake. Also, you'll have to select the corresponding MDI offering if you want the patient's encounter to get created on MDI with that offering once the patient completes the intake form (in case the offering is not already part of the intake's logic).\n\nUsers will be redirected to the correspondent intake form link immediately after completing the checkout process from your Shopify store and this intake should be associated with the product that users have selected from your store. After going through the checkout and filling out the medical intake, we'll create a profile and an encounter (virtual visit) for that user on MDI. The end-to-end flows and API calls will work the same as a regular API integration in the background, remaining transparent to partners\n\n**Pharmacy integration/set-up**\n\nWe're agnostic when it comes to pharmacy choices, which means you can choose whatever pharmacy you want to. We integrate with pharmacies via Dosespot (our e-prescribing partner), which then forwards the e-prescriptions over to pharmacies via Surescripts, so as long as your pharmacies use Surescripts, we'll be able to send the e-prescriptions over to them once the encounter gets submitted by a doctor. Once you click at any offering from your company's dashboard, you'll see a specific field for entering the pharmacy and all the pharmacies that use Surescripts in the US will be listed there.\u000b\u000b If you're using our white labeled intakes (outside of the Shopify or WooCommerce flows), you can also pass us the pharmacy_id when creating an intake voucher for the patient rather than hardcoding it with the offering.\n\n**White Labeled solutions: Messaging App and Intake Form**\n\nIf you plan to use our white labeled solution for messaging, once the case/encounter prescription(s) get submitted by the doctor (or even while reviewing the case), patients will normally receive a message from their doctor. This message will trigger a '[New Message Notification](https://miro.com/app/board/uXjVN7tFH1c=/)' via email to the patient with a link they can click to view and message their doctor from our Messaging App. Doctors will message patients from the case and this chat will be active regardless the status of the encounter, meaning that patients will be able to message their doctor even after their case is completed.\u000b For viewing the UX/UI from our **white labeled Messaging App**: you can create a test patient and a case for the patient from our Sandbox environment and then send them a message from the patient messages thread (inside the case) from our [Clinicians App.](https://app.mdintegrations.com/) This will trigger a 'new message' notification to the patient via email. When clicking the email link, you'll be able to see how the patient chat (Messaging App) works.\u000b For viewing the UX/UI from our **white labeled Intake Forms**: make sure your have it turned on for your company under Integration > Notifications > White Label.\n\nYou can then create a test patient and a case for the patient from our Sandbox environment and send them a message from the patient messages thread (inside the case) from our [Clinicians App.](https://app.mdintegrations.com/) This will trigger a 'new message' notification to the patient via email. When clicking the email link, you'll be able to see how the patient chat (Messaging App) works.\n\nIn order to activate our white labeled solutions, all you'll need to do is to configure your Apps settings under Integration > App Setup from your [company's dashboard.](https://mdintegrations.com/)\n\nYour company's white labeled customization options are available under Account > Branding from your [company's dashboard.](https://mdintegrations.com/) These options will include using your company's domain, embedding our apps into your website, changing the visuals and patient experience of your company's intakes and messaging App, changing the visuals and contents of the email notifications we send over to patients, and more.\n\nPlease find below instructions on how to test from our Sandbox environment:\n\nAfter generating Sandbox API credentials, you'll be able to check the patient profiles and encounters you created from our [Clinicians App](https://app.mdintegrations.com/) Sandbox environment via API. In order to access it, make sure you do the following:\n\nHave a Support user account (you can create support user accounts from your [company's dashboard](https://mdintegrations.com/) under Operations > Management > Support Staff); Select the right permissions for users (click at the support user profile > edit > permissions and select the permission you want); Once you log into our [Clinicians App](https://app.mdintegrations.com/), click at your user name's initials (top left hand side) > Environment > switch to Sandbox.\n\nAs for testing our end-to-end flows, you can access our Test Bench from your [company's dashboard](https://mdintegrations.com/) and simulate any MDI event by following the steps below:\n\nGo to the top menu and click at Integration > Resources > Test Bench; Scroll all the way down to the 'Test Bench' section; Click at 'Simulate Events'; Select the event you want to run (e.g. Submit Prescription); Fill out the information required.\n\nIf you plan on embedding the intake forms on your own page, you may append the query parameters available [here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#1beb92b7-68f6-432d-b50d-5dab9fb966eb), so you can remove borders, add your branding and other visual elements for a seamless experience.\n\n**What partners should complete before going live**\n\nIn a nutshell, before going live, you just have to make sure you complete all the onboarding steps available under your company's dashboard, including testing the end-to-end flow of the different business scenarios you may have in your company. Once you complete all the 'Integration Plan' steps, when clicking \"Next\", next step would be to submit testing scenario evidence, so our medical team can evaluate it to make sure you've got all covered before going live. Once your company is switched over to 'Live' status by our medical team, you'll be able to test from our Live environment as well, following some best practices that we can share with you at this point.\n\n**Best Practices for testing in our Live environment**\n\nIf you want to test a real scenario where the prescriptions should be sent over to a real pharmacy, you'll have to create an encounter from our Live environment following the best practices below:\n\nAdd the Tag 'Test Case' to the case, either manually or via [API](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#2a51b42f-e283-4d1b-b85a-4c452068d31b) (tag_id: c456872d-af8d-45e9-a1fe-8db619a369f7); Add as a Case Question (via [Post Case question](https://documenter.getpostman.com/view/14212272/2s9YXbAmEG#0ff0a20e-0688-499a-8741-53ed573e5e5b) Endpoint) or Chart Notes (manually) a note saying what you want the doctor to do with it, e.g. : *\"This is a test encounter. Please submit the prescription to the pharmacy\".* If you're using our white labeled intakes, you can add this info as an answer to a question.\u000b Add the word \"Test\" to the patient's name (if the patient is not a real one).\n\n**Sync and Async states/visits**\n\nUnder the US law, some states require some sort of audio/video interaction between the doctor and the patient. While some states may accept an introduction video recording from the patient as an evidence of the sync visit being executed, others require that interaction to be completely live. For this second scenario, doctors have the discretion, in terms of modality of care, if the encounter should be treated as **synchronous** or **asynchronous** . If they deem appropriate, they will set the encounter as **synchronous (extended care)**, which could be because a video or phone call took place with the patient (the doctor will initiate it), but that would rarely happen. By default, all cases are set as **asynchronous** (**routine**).\n\nTo find out which states **require** an intro video from the patient, you may use the [Get States](https://api.mdintegrations.com/#7a1c2ee5-4d37-4941-8efd-c16f23627699) endpoint and look for the field is_av_flow . These states will be also listed under the Step 6 (Accounting for sync states) from your company's Integration Plan page.\n\n**Patient's identity validation**\n\nDoctors must have a way to verify a patient’s identity - either by reviewing a valid ID, an intro video or by using Vouched (which is internal to our platform and costs $1 per patient we need to use that on). You can enable Vouched for your company by navigating to **Integrations >** **Workflows > Manage**. You can also run the identity verification on your end and provide us with the patient’s resulting score (via [Post Case question](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#4663b91f-abbc-4025-946e-a844febbe3c7) Endpoint).\n\n**How can one export doctors' licensing details?**\n\nTo extract our doctors' licensing details, click at Operations > Management > Clinicians > Export All from your company’s dashboard. An excel spreadsheet will be downloaded with all licensing details (separated in tabs) of the doctors associated with that company.\n\n**How to test from our Sandbox environment**\n\nPlease find below instructions on how to test from our Sandbox environment:\n\nAfter generating Sandbox API credentials, you'll be able to check the patient profiles and encounters you created from our Clinicians App Sandbox environment via API. In order to access it, make sure you do the following:\n\nHave a Support user account (you can create support user accounts from your company's dashboard under Operations > Management > Support Staff); Select the right permissions for users (click at the support user profile > edit > permissions and select the permission you want); Once you log into our Clinicians App, click at your user name's initials (top left hand side) > Environment > switch to Sandbox.\n\nAs for testing our end-to-end flows, you can access our Test Bench from your company's dashboard and simulate any MDI event by following the steps below:\n\nGo to the top menu and click at Integration > Resources > Test Bench; Scroll all the way down to the 'Test Bench' section; Click at 'Simulate Events'; Select the event you want to run (e.g. Submit Prescription); Fill out the information required (like Sandbox Case ID).\n\nOur Test Bench also offers the option to manually trigger some Webhook events by clicking at the 'Send Webhooks' option.\n\n**Pharmacies that don't accept electronic prescriptions (normally the ones that use LifeFile, like Chemistry Rx**)\n\nThat's correct. For pharmacies that don't accept electronic prescriptions (normally the ones that use LifeFile, like Chemistry Rx), you'll have to pass your company's offerings over to us using Service prescriptions, which will generate a pdf file that you can download when the case is completed by a doctor (using the 'Get Services PDF' Endpoint). We don't know in details how LifeFile works, but for every medication/compound created for your company, you'll probably have to create a correspondent Service, including all the offerings details, like name, dose, quantity, dispense unity, directions, etc.. Those Services will not be electronically sent over to the pharmacy via Dosespot, as Services are not part of our e-prescribing flow, so you'd have to download the PDFs and upload them to your LifeFile instance.\n\nAnother option that some of our partners have chosen is to generate the PDF prescriptions on their end and send them over to the pharmacy via API, based on the information we'll send within the 'Offering Submitted' Webhook. I'd suggest you to reach out to your pharmacies to get more clarification on what they'll need from you.\n\n**Using partner's custom domain and embedding our URLs**The customization options of our white labeled solutions include embedding MDI URLs into your website so you can use your company's own domain. Please follow the instructions available under [this](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#1beb92b7-68f6-432d-b50d-5dab9fb966eb) link from our API docs on how to embed our URLs.\n\nYou can also use your company's domain as the sender email we send out from MDI, which is available for configuration under the following path: Account > Branding > Custom Domain.\n\n**How to hold and encounter before it gets assigned to a doctor**\n\nYou can hold an encounter when creating it (by setting the [hold status flag](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#f70ac28d-074f-406d-9e4b-03e535c5d14c) to true). This will make the encounter get stuck into the Created folder (where you'll be able to make any updates to it) and only get assigned to a doctor after you release the encounter. You can release an encounter either manually (by moving it to Assigned) or via [API](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#f70ac28d-074f-406d-9e4b-03e535c5d14c).\n\n**How to hande underage patient (19 and younger**)\n\nOur system will consider 19 year old and younger as a minor (we consider 19 years old patients as minors as well because sometimes underage teens lie about their age). From a tech perspective, only Height and Weight are mandatory fields for underage patients,How to use the special_necessities (reason for compounding) fieldAll you'll need to do is to update the patient record and pass us the special_necessities field (available in the Patient Endpoints) with the reasoning provided by the patient for personalized dosing.\n\nOnce the special_necessities field is set in the patient object, the wildcards that we have mapped under the Directions fields for weight loss medications will pick up the information you have provided.\n\n**Email and SMS notifications that may be sent over to patients from MDI**We may send email and SMS notifications over to patients for a variety of reasons (these notifications are mostly optional though). In order to see all the scenarios where we may send these notifications over to patients, please check [this](https://www.figma.com/board/CCh4N3N5pzWcbKy9WpwJu1/White-Label-Email-Notifications?node-id=0-1&p=f&t=GrtnZYT8r2S13C8p-0) dashboard. Also, from your company's dashboard (under **Account > Branding > Templates)**, you can view and update the content and wording from all the email and system notifications we may send over to patients.\n\n**How to get started with integrating with MDI**\n\nTo integrate with MDI, the first step is to choose the integration type that best fits your needs. We currently offer four options:\n\n1. Full API Integration\n2. White-Labeled Integration\n3. Shopify Plug-in Integration\n4. WooCommerce Plug-in Integration\n\nOnce you've selected your preferred option, go to the **Integration Plan** page (available within the onboarding steps from your company’s dashboard) and select the \"suggest path\" from there. Once selected, we'll display all the necessary steps to complete the integration using your chosen integration path.\n\nFor a detailed comparison of each integration type - including their key requirements, pros and cons, etc., please refer to [this](https://www.figma.com/board/qYD4Kbh8rWBPq9Kq0c2CDG/Integration-options?node-id=215-45&t=7aA4umgShL1teKmX-0) dashboard.\n\n**Partners Welcome (Onboarding) message**\n\nTo help onboard your company as quick and efficiently as possible, please **read and complete the below IN FULL.**\n\n 1. Make sure that you have signed up for our [Partners Website](http://mdintegrations.com/) and received your **user credentials.**\n\n 2. On the [Partners Website](http://mdintegrations.com/) please **complete all onboarding actions listed in order page by page.** Here is a step by step view of the [**onboarding process**](https://www.figma.com/board/euRGNzIyCiafgrDntrEYuU/Partner-Sign-Up-and-Onboarding-Steps?node-id=0-160&t=uc8JTdEOayL1qwfX-0)**.**\n\n 3. There you will be able to **manage your partner profile settings,** **create admin and support user accounts** for your team, **generate API credentials,** etc.\n\n 4. Please fill out all of these completely (including support email, operations email, and make sure every support user has their own login as an individual person (**NO group logins**).\n\n 5. Attach your **general liability insurance policy** to the portal as well.\n\n 6. Let us know on slack when you are finished, so we can have our medical team work on your **medical intakes, attach clinicians to your co,** etc.\n\n 7. Here is a link to our [API documentation](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8). Please **watch the** **short onboarding video** at the top which will help you to get started with the integration process and understand our products.\n\n 8. Please view this link to understand the main differences between our [integration options,](https://www.figma.com/board/qYD4Kbh8rWBPq9Kq0c2CDG/Integration-options?node-id=0-1&p=f&t=Y8CyrYT57pMgh3qe-0) including their tech requirements and how to enable each one.\n\n 9. Here is an example of the [end-to-end user journey](https://www.figma.com/board/1KHuZxh640OzX72JahKPNp/E2E-Patient-Journey?node-id=0-329&t=whNG2xYCiKc1qVWh-0) of how the user journey would look for partners that intend to use our **white label intake forms.**\n\n10. Click the “**Get Updates**” button at the top of our [status page](https://status.mdintegrations.com/) to subscribe to our status page and receive email notifications whenever MDI creates, updates, or resolves incidents or scheduled maintenance. These are important notifications that could impact your business and **should not be missed.**\n\n11. Please find our **MDI telemedicine consent agreement** [here](https://mdintegrations.com/tos). Please be aware that it is a **mandatory regulation requirement for patients to acknowledge the MDI telemedicine consent agreement prior to having their case reviewed by a physician.** You may change “M&D Integrations” to your company’s name but all other content must remain the same. The patient acknowledgement should be passed with a case as a part of the intake answers. (*Example*: Question: MDI telemedicine consent acknowledgement. Answer\\*\\*:\\*\\* Yes.) This is a mandatory regulation requirement that is for our mutual benefit. For partners using our white label solutions (*like our white labeled intake form*), patient acknowledgment is already included, so no further actions are required.\n\n12. **Protected Health Information (PHI)** reminder: Because we are practicing telemedicine, we would like to remind you that at **no time should protected health information (PHI) of any patient (ex. name, date of birth, phone numbers, email, photos, etc.) should be messaged**. This is including Direct Messaging. Once you go live in our production environment, please make sure to use MDI’s patient or encounter ID’s only to help us identify patients/encounters.\n\n13. For your reference, here is a list of MDI team members that can be helpful, along with who to tag on slack if needed. **PLEASE tag the proper person when posting a question, etc. or it may not be visible to have your question answered in a timely manner.**\n\n14. **Marc Serota** – MDI’s CEO and Medical Director.\n\n15. **Conrad Withrow** – Medical Director for weight loss. If you have clinical questions, please reach out to Dr. Withrow.\n\n16. **Ana C. Ramos** – Integration Lead and point of contact for MDI’s tech team. If you have tech questions, please reach out to Ana.\n\n17. **Felipe Tadra** – Chief Technology Officer. He may be able to help with tech questions as well, but please direct initial tech questions to Ana C. Ramos.\n\n18. **Corey Abramson** – Community and Onboarding Manager. He can help with non-tech and non-medical onboarding questions. If you are unsure who to tag, please tag Corey and he will get you to the proper person for assistance.\n\n19. We kindly ask that you do **NOT** message our team via **DM**. We need the whole team to have visibility of any questions or requests.\n\n20. After you go “Live”, if you have an issue with an encounter, the first thing you should do is **flag the doctor from the case**. You can do that from the app. Just click the flag icon from the top of the case, select the doctor, and add your comments. You can also **tag us in slack.** When doing so, please always include the **case link** (by copying your browsers URL when inside the case) if you want us to help or reference a case.\n\nLet us know if you have any questions. We look forward to working together!","2025-11-18T16:51:03.908Z","2025-11-18T16:58:12.487Z","06f02d0f-1059-4948-9a7a-fb133e17ee53",[],[],{"_101":288,"_103":289,"_105":-5,"_106":290,"_108":-5,"_13":-5,"_95":291,"_97":291,"_25":292,"_27":28,"_111":-5,"_112":293,"_114":294},"Generate API credentials","generate-api-credentials"," API credentials can be generated by navigating to Integration > Credentials > Add new from the top menu in your company's admin dashboard.\n\n### Steps to Authenticate with our API:\n\n1. **Obtain Credentials**: Ensure you have your **Client ID** and **Client Secret**.\n2. **Generate Access Token**: Use the provided credentials to request an access token. This token will be used in the headers of your API requests for authentication.\n3. **Secure Your Credentials**: Keep your **Client Secret** safe and do not share it, as it is sensitive information.","2026-01-30T15:43:57.588Z","6f12ea82-d09c-458b-b373-1904e8fb6e0a",[],[],{"_101":296,"_103":297,"_105":-5,"_106":298,"_108":-5,"_13":-5,"_95":299,"_97":299,"_25":300,"_27":28,"_111":-5,"_112":301,"_114":302},"Hold_status flag to hold encounters in Created","hold-status-flag-to-hold-encounters-in-created","You can use the hold_status flag when creating an encounter to hold the encounter in the Created folder until you perform any required actions on your side (like acknowledging payment receipt). That will make the encounter get stuck in the Created folder before being assigned to a doctor. Once you perform the required action, you'll use this Endpoint to release the encounter, so it'll get automatically assigned to an available doctor. If the case is sitting in the Created folder for longer than 30 days, we'll automatically cancel it.","2026-03-12T23:13:42.639Z","1fd9479f-8597-43ae-a446-4ee68a23ac10",[],[],{"_101":304,"_103":305,"_105":-5,"_106":306,"_108":-5,"_13":-5,"_95":307,"_97":307,"_25":308,"_27":28,"_111":-5,"_112":309,"_114":310},"How ChemistryRx flow works for receiving electronic prescriptions","how-chemistryrx-flow-works-for-receiving-electronic-prescriptions","\nIf you're using ChemistryRx, please note that they do not integrate with Surescripts. Therefore, for pharmacies that don’t integrate with Surescripts for receiving electronic prescriptions from us (typically those using LifeFile), you have two available options:\n\nUse Service prescriptions:\n\n You can send your company’s offerings to us as Service prescriptions (instead of Compounds and Medications), which will generate a PDF file once a doctor completes the case. This file can be downloaded using the Get Services PDF endpoint. While we're not fully familiar with LifeFile’s workflow, you’ll need to create a corresponding Service for each medication or compound your company offers. This includes entering all relevant details - such as name, dosage, quantity, dispense unit, directions, etc.\n\nKeep in mind that Services are not part of our e-prescribing integration via Dosespot, so these prescriptions won't be sent electronically to pharmacies. Instead, you'll need to manually download the PDFs and upload them to your LifeFile instance or share them with the pharmacy (via fax, email, API, etc.). Due to the manual work required, this option may not be ideal for partners with a large number of offerings.\n\nGenerate PDF prescriptions on your end:\n\nSome partners choose to generate the PDF prescriptions themselves and send them directly to the pharmacy (via API, fax, email, etc.), or upload them directly into LifeFile. This approach is based on the data we provide within the Offering Submitted webhook and the Get Case and Get Patient Endpoints. ","2025-09-17T19:09:27.086Z","0b6787bc-389d-47d3-ad4c-61d92ec7e46b",[],[],{"_101":312,"_103":313,"_105":-5,"_106":314,"_108":-5,"_13":-5,"_95":315,"_97":315,"_25":316,"_27":28,"_111":-5,"_112":317,"_114":318},"how do i access my company's dashboard?","how-do-i-access-my-companys-dashboard","To be able to access your company's dashboard at [http://mdintegrations.com](http://mdintegrations.com%7Cmdintegrations.com) someone from your team who already has access to it will have to add you as an admin user under Account > Company > Admins Users > Add new from your company's dashboard.\n\nIf you're already registered as admin user within MDI, click the 'forgot password' button from the login page, which will send a password reset link to your email.","2025-08-28T00:00:59.376Z","a6757a37-860b-45f8-8108-33b512c322a4",[],[],{"_101":320,"_103":321,"_105":-5,"_106":322,"_108":-5,"_13":-5,"_95":323,"_97":323,"_25":324,"_27":28,"_111":-5,"_112":325,"_114":326},"How to link a questionnaire to an offering","how-to-link-a-questionnaire-to-an-offering","Since you are proceeding with the white-labeled integration, the responsibility for managing the *product–intake associations* will be on your side. The process involves the following steps:\n\n1. *Create an Intake Form under your company’s dashboard*\\\n • This will serve as the entry point for users to provide the necessary information.\\\n • You already have this step completed.\n\n2. *Associate each product in your store with the correct intake form*\\\n • For every product you offer, link it to the corresponding intake form.\\\n • This ensures that when users purchase or initiate a flow involving a product, they are directed to the appropriate intake form for that specific product.\n\n3. *Generate a unique voucher URL for each user*\\\n • Use the *Voucher Generation API* to create a new voucher for every individual user.\\\n • This voucher provides the unique link/URL that allows the user to securely access and complete the intake form.\n\n4. *Incorporate the voucher URLs into your company’s website*\\\n • Place the generated voucher links within your site, typically connected to a button or call-to-action.\\\n • For example, when a user selects a product and clicks “Fill Out Intake,” they are redirected via the voucher URL to the correct intake form.\n\n5. *Monitor the ‘Voucher Used’ Webhook to capture Case IDs*\\\n • Once a user completes their intake using a generated voucher, the *‘Voucher Used’ Webhook* will fire.\\\n • This webhook provides you with the *Case and Patient ID* tied to that voucher, which you can then use to track, process, or manage the case within your system.","2025-09-15T16:36:12.351Z","dd6f6351-f21b-4c0e-93f9-0e408337af4e",[],[],{"_101":328,"_103":329,"_105":-5,"_106":330,"_108":-5,"_13":-5,"_95":331,"_97":332,"_25":333,"_27":28,"_111":-5,"_112":334,"_114":335},"Identity verification process for patients","identity-verification-process-for-patients","\nIn a nutshell, our identity verification process for patients will work as follows:\n\n**For partners using the API integration:**\n\nIf no valid ID is uploaded for the patient, you'll have to use one of the 3 methods below:\n\n- Run Vouched: A third-party validation tool that can be enabled from your company's admin dashboard for identity verification. We'll integrate with them via API and they just use patient's data for identity validation purposes.\n\n- Use their own third-party validation tool for identity verification and then pass us the resulting score via Post Case Question endpoint.\n\n- Introduction Video: Patients may also upload an intro video (instead of a valid ID) as part of the verification process.\n\n**For partners using the white label intakes:**\n\nSince we'll already ask patients to upload an ID during the intake flow, if partners select the option to \"Run Vouched for every patient\", we'll skip the ID upload slide and use Vouched instead.\n\n\\\n**Vouched Cross-check API** \n\nWe use Vouched Cross-check API for patient's profile data validation, so our knowledge is limited on how it works in details. But essentially, Vouched takes the user’s details and runs them against their internal database/logic to see if they match. For instance, for name and address, it checks if the physical address exists and if it is associated with the person’s name in their records. Vouched also verifies if the phone number and email address are active and registered to the user. All these items generate an **Identity Score** from 0 to 1 that will be displayed within the patient's profile, helping us determine how legitimate the profile is (we'll consider that the patient has passed Vouched if their final score is equal to 0.9 or higher). If you enable Vouched for your company, it should be transparent to you, meaning that you won't have to manage anything on your side regarding patients' identity validation and we'll just expose the final score within the patient's chart.\\\n\\\nIt's also totally fine if you integrate directly with Vouched on your end and just pass us the resulting validation score (via Post [Case Question](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#4663b91f-abbc-4025-946e-a844febbe3c7)). In this case, you'd just have to disable the \"Email patients for missing drivers license\" option from [this](https://partners.mdintegrations.com/partner/e8285b8e-641c-40be-8a8f-6e7969fb877b/settings#notifications) page, so we don't ask patients to upload their ID.","2026-01-27T15:47:55.786Z","2026-01-30T18:18:52.626Z","7e3e108d-eaa2-408d-971d-825bb351194b",[],[],{"_101":337,"_103":338,"_105":-5,"_106":339,"_108":-5,"_13":-5,"_95":340,"_97":340,"_25":341,"_27":28,"_111":-5,"_112":342,"_114":343},"Inquiry about AV flow true case for customers","inquiry-about-av-flow-true-case-for-customers","You can update the content of all the automated email notifications we send over to patients (including the one for the AV flow) by accessing you company's dashboard and clicking at *Account > Branding > Templates* from the top menu.","2025-08-14T19:54:31.762Z","476224fe-888c-4e85-a5d1-6d1c09f025da",[],[],{"_101":345,"_103":346,"_105":-5,"_106":347,"_108":-5,"_13":-5,"_95":348,"_97":348,"_25":349,"_27":28,"_111":-5,"_112":350,"_114":351},"Inquiry about Disabling Driver's License Requirement","inquiry-about-disabling-drivers-license-requirement","Doctors must have a way to validate the patient's identity when working their encounter.\n\nWe offer partners three distinct methods for patient identity verification:• *Any valid ID upload,*\\\n• \\*Enabling Vouched for your company \\*(or a comparable third-party validation tool of the partner's choice) or\\\n• *Introduction video upload*\n\nThat patient workflow from your screenshot will be automatically triggered from MDI if no ID was uploaded for the patient and you're not using Vouched either.","2026-01-08T17:29:15.252Z","6c3753ee-a1f3-478c-9069-4cc59ceb02e7",[],[],{"_101":353,"_103":354,"_105":-5,"_106":355,"_108":-5,"_13":-5,"_95":356,"_97":356,"_25":357,"_27":28,"_111":-5,"_112":358,"_114":359},"Inquiry about downloading a digital Rx for a customer","inquiry-about-downloading-a-digital-rx-for-a-customer","Note that this will apply to offerings created as Services only. For offerings/prescriptions submitted as medications, compounds or supplies, we won't generate any digital version/file of it. The prescriptions will simply get sent over to the pharmacy electronically.","2025-07-16T20:50:39.972Z","a3ddb301-79ec-4f84-b494-9659f60837e9",[],[],{"_101":361,"_103":362,"_105":-5,"_106":363,"_108":-5,"_13":-5,"_95":364,"_97":364,"_25":365,"_27":28,"_111":-5,"_112":366,"_114":367},"Inquiry about information sent to Pharmacy hub via Surescript","inquiry-about-information-sent-to-pharmacy-hub-via-surescript","When a prescription is submitted to the pharmacy on our end, we'll basically send the prescriptions details over to the pharmacy (including name, quantity, dispense units, number of refills, directions, etc.) and the pharmacy notes.\n\nPharmacy Notes is a field available in the offerings form. Whatever text you add under this field will be sent over to the pharmacy. If no text is hardcoded there, we'll send (by default) the following information:\\\n*Company: company_name Patient ID*: [mailto:patientemail@email.com|patientemail@email.com](mailto:patientemail@email.com%7Cpatientemail@email.com) *Case ID*: c0ef5368-1094-4d28-9eaa-65feed6abcd.\n\nIf you hardcode any text (up to 140 characters) withing the Pharmacy Notes field from offerings, your text will \\*overwrite \\*the one above.","2025-07-18T19:32:14.137Z","f5da806f-2e9d-4914-b3bb-13e8c6e6aa4e",[],[],{"_101":369,"_103":370,"_105":-5,"_106":371,"_108":-5,"_13":-5,"_95":372,"_97":372,"_25":373,"_27":28,"_111":-5,"_112":374,"_114":375},"Inquiry about listed items usability","inquiry-about-listed-items-usability","After you go live and are ready to test from our Live environment, you'll also have to clearly state to our doctors what you want them to do with your test cases. To do that, you'll have to follow the best practices below:\n\n1- Add the Tag 'Test Case' to the case, either manually or via [API](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#2a51b42f-e283-4d1b-b85a-4c452068d31b) (tag_id: c456872d-af8d-45e9-a1fe-8db619a369f7).\n\n2- Add a message as a new 'Chart Notes' or Case Question (via [Post Case question](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#4663b91f-abbc-4025-946e-a844febbe3c7) Endpoint) saying what you want the doctor to do with the case, e.g. : *\"This is a test encounter. Please submit the prescription to the pharmacy\"*. If you're using our white labeled intakes, you can also just *add this information as an answer to a question when filling out the intake.*\n\n3- Add the word \"Test\" to the patient's name (if the patient is not a real one).","2025-10-08T16:47:08.870Z","bb2fc9c9-481c-4790-ad9c-c30131fa0d89",[],[],{"_101":369,"_103":377,"_105":-5,"_106":378,"_108":-5,"_13":-5,"_95":379,"_97":379,"_25":380,"_27":28,"_111":-5,"_112":381,"_114":382},"inquiry-about-listed-items-usability-2","Those events are only available for testing your technical integration with MDI in our Sandbox environment only, and you can trigger any them as much as you’d like. However, submitting prescriptions to an actual pharmacy requires a licensed doctor to review the encounter and issue the prescription, so you won’t be able to simulate that process on your end. Pharmacies also typically don’t have a dedicated “test” environment. They treat all prescriptions as real ones, unless you’ve made prior arrangements with them to accept and evaluate test orders you'll be issuing.","2025-10-08T16:45:37.316Z","f5d8ecc7-1bf6-487c-a2e3-4825cceee5bd",[],[],{"_101":384,"_103":385,"_105":-5,"_106":386,"_108":-5,"_13":-5,"_95":387,"_97":387,"_25":388,"_27":28,"_111":-5,"_112":389,"_114":390},"Inquiry about process for GLP-1 sync appointments","inquiry-about-process-for-glp-1-sync-appointments","When using the API, for the AV states, you'll just have Include `intro_video_id` when creating/updating a patient in sync states.\\\nThe video should include:\\\n• Full name\\\n• Date of birth\\\n• State\\\n• Condition being treated\\\n• Use the Get States endpoint to find states requiring `is_av_flow = true`\n\nIn the majority of cases this video will be under 10 seconds. We recommend adding an inline webcam plugin to allow for video recording within your page as a way of reducing friction for the patient to sign up. If a video is not uploaded as you create the patient record, we may set up your partner account to automatically send an email with a white label experience for patients to record and upload their video.","2025-09-10T15:57:41.124Z","8a445032-b612-46cb-ac5d-beaf6b75498d",[],[],{"_101":392,"_103":393,"_105":-5,"_106":394,"_108":-5,"_13":-5,"_95":395,"_97":395,"_25":396,"_27":28,"_111":-5,"_112":397,"_114":398},"Inquiry about 'sent to support' page functionality and notifications","inquiry-about-sent-to-support-page-functionality-and-notifications","\\*Sent to Support \\*cases are the ones requiring Support intervention (e.g., prescription needs to be added to the case). Support users must manually move the case back to Assigned once resolved.\\\nYou can keep track of cases sent to this queue by monitoring the Support queue from the Clinicians App. You'll also receive a Webhook whenever there is a case status update.","2025-07-21T20:40:16.290Z","125bef54-90fd-4bff-916d-268d9e405051",[],[],{"_101":400,"_103":401,"_105":-5,"_106":402,"_108":-5,"_13":-5,"_95":403,"_97":404,"_25":405,"_27":28,"_111":-5,"_112":406,"_114":407},"Inquiry about user name restrictions","inquiry-about-user-name-restrictions","For Middle name, you can consider the same characters limitation. *Middle Name*: Limited to a maximum of 35 characters.\n\nMoreover, for patient names validation, we only accept strings based on the following regular expression: a-zA-ZÀ-ÖØ-öø-ÿ0-9\\\\s-''\\\n\\\nWe also accept lower case and 1 letter only.","2025-07-16T15:41:08.267Z","2025-07-16T15:42:10.669Z","8b281f01-c489-41d2-bb64-902b8f3f2ede",[],[],{"_101":409,"_103":410,"_105":-5,"_106":411,"_108":-5,"_13":-5,"_95":412,"_97":412,"_25":413,"_27":28,"_111":-5,"_112":414,"_114":415},"Intake reminders","intake-reminders","We'll send a reminder email to the patient (+ SMS if enabled) after 4, 24 and 48 hours a voucher is created but not yet completed.","2026-05-14T16:21:22.946Z","3a9e6494-33be-4122-8f22-9a20d9893d04",[],[],{"_101":417,"_103":418,"_105":-5,"_106":419,"_108":-5,"_13":-5,"_95":420,"_97":420,"_25":421,"_27":28,"_111":-5,"_112":422,"_114":423},"Intake Vouchers","intake-vouchers","- Vouchers have expiration dates \"built-in\" to them. Once the expiration time passes, the voucher is no longer valid by the MDI system. (I found a voucher I generated that had expired and I've attached a screenshot to this message. It appears to show \"We couldn't validate your token\")\n- If they generate a new voucher for every click and the patient leaves, that voucher remains in a created but unused state. They simply sit in the database until they hit their expires_at date. If they are generating via API, they can specify a datetime value parameter to expire the voucher via [Create voucher](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#dc1a9c28-a32f-4171-8729-df7a75fac7f6) endpoint.\n- If the voucher hasn't been completed, they can return to continue their progress with the same voucher link. If the voucher has been completed, that voucher is used and cannot be accessed again.\n- After the intake has been submitted, the voucher becomes \"used\". It only expires if it is generated and reaches it's \"expiration time\".\n- Vouchers are generated on a user basis and will be valid and usable as long as it hasn't reached its expiration date yet and no encounter has been created for the patient (which will happen as soon as the patient completes the intake). \n- We'll also store the patient's answers so they can continue filling out the intake from where they've dropped off (when accessing the same intake link).","2026-03-05T02:36:59.621Z","7b35cdd6-f158-4d22-8950-269e6ea81afd",[],[],{"_101":425,"_103":426,"_105":427,"_106":428,"_108":429,"_13":-5,"_95":430,"_97":431,"_25":432,"_27":28,"_111":433,"_112":435,"_114":436},"Integration Options for MDI","integration-options-for-mdi","https://mdintegrations.unthread.io/dashboard/inbox/all/conversations/44eebfd4-57dc-4e0d-b23e-1b77b81f46f9","To understand the integration options available for MDI, including their technical requirements and how to enable each one for your company, please refer to the following link: [Integration Options Overview](https://www.figma.com/board/qYD4Kbh8rWBPq9Kq0c2CDG/Integration-options?node-id=0-1&p=f&t=Y8CyrYT57pMgh3qe-0). This resource provides a detailed comparison of the main integration options.","7c686a31-c2c7-452b-9a30-ca85fe7eed60","2025-07-10T23:55:47.997Z","2025-07-11T00:11:19.390Z","85bfeb7c-df95-4cb8-b297-06013736bd10",{"_25":429,"_72":434},"FAQs",[],[],{"_101":438,"_103":439,"_105":-5,"_106":440,"_108":-5,"_13":-5,"_95":441,"_97":441,"_25":442,"_27":28,"_111":-5,"_112":443,"_114":444},"Interesting\n\nNot sure how Pharmacy hub is matching the order id with the correct case id","interesting-not-sure-how-pharmacy-hub-is-matching-the-order-id-with-the-correct-case-id","I'd double check it with the pharmacy. We don't send any Shopify information over to them.\\\nPharmacies will normally use the pharmacy_notes field to match our prescription with the order on their end, but we don't send any Shopify data over to them.","2025-08-19T19:58:01.992Z","8b66157b-43a1-446d-ae0b-e9bb3e7e3a48",[],[],{"_101":446,"_103":447,"_105":-5,"_106":448,"_108":-5,"_13":-5,"_95":449,"_97":450,"_25":451,"_27":28,"_111":-5,"_112":452,"_114":453},"Issue with script visibility in Empower for case","issue-with-script-visibility-in-empower-for-case","If the pharmacy claims not having received the case prescriptions, that's usually because some sort of issue happened between them and Surescripts and the prescription was faxed over to the pharmacy. Therefore, can you please ask them to look at their fax? If the pharmacy still claims not having received it, you can use the Resubmit prescription functionality by accessing the case and clicking at Manage > \"Resubmit\".","2025-08-01T15:39:23.058Z","2025-08-01T15:39:30.944Z","5a34e525-43fc-4ca5-9a21-9c9e1e705b11",[],[],{"_101":455,"_103":456,"_105":-5,"_106":457,"_108":-5,"_13":-5,"_95":458,"_97":459,"_25":460,"_27":28,"_111":-5,"_112":461,"_114":462},"Lab orders","lab-orders","We don't have any integration with lab companies on our end.\\\nIf you'd like to send the lab request PDF over to the lab company, you'll have to download the Service PDF as soon as the case is completed. You can do it either manually from the case or by calling the [Get Case Services/Precriptions PDF](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#9b39134b-40a2-476c-b7fc-1a4e0566341d) endpoint.\\\nLab companies will normally fax/email their results to our medical support team and they'll upload it into the patients chart for the doctor to review them.\n\n\\\nNote that lab orders are normally not mandatory for the patient to get a prescription, they're just recommended. There are a couple of medications, though, for which a lab order is required prior to prescribing (like enclomiphene and methylene blue). These would require an encounter for labs first and an encounter for review and prescription submission.\\\n\\\nNormally the lab order requests process will work as follows: if a lab order is needed for the patient, the Service PDF will be sent to them via messaging, so they can take it to their preferred lab company. The results are then faxed back to our support team when ready and they'll upload it to the patient's chart and ping the doctor so they can review them. The doctor should message the patient if everything looks good/normal or if anything comes back high or concerning. ","2026-02-13T14:44:16.158Z","2026-02-13T15:01:04.421Z","45f6cfb7-36e4-43a8-9d5c-42d2941e3678",[],[],{"_101":464,"_103":465,"_105":-5,"_106":466,"_108":-5,"_13":-5,"_95":467,"_97":467,"_25":468,"_27":28,"_111":-5,"_112":469,"_114":470},"MDI Clinicians address details","mdi-clinicians-address-details","\nYou can use the following address details and phone numbers for all MDI clinicians:\n\n100 Powell Place #1859\n\nNashville, TN 37204\n\nUnited States\n\nP: 629-777-5752\n\nF: 650-254-0800 ","2025-09-26T15:52:31.785Z","c43bfc61-961d-4aad-b80b-2b675d551e99",[],[],{"_101":472,"_103":473,"_105":-5,"_106":474,"_108":475,"_13":-5,"_95":476,"_97":477,"_25":478,"_27":28,"_111":479,"_112":481,"_114":482},"MD Integrations API External Only (Manually Created)","md-integrations-api-external-only-manually-created","\n# Project: MD Integrations API\n\n## Intro\n\nThe MD Integrations API is a set of HTTP endpoints that help your app integrate with MD Integrations.\n\nThe API is integrated with [DoseSpot](https://www.dosespot.com/), an e-Prescribing system. Our API acts as proxy to DoseSpot: all the required actions on DoseSpot side are handled under the hood by our API.\n\n**##** Base URL\n\n- \n\n## Request and Response Formats\n\nAll API access is over HTTPS. All data is sent and received as JSON.\n\n## Headers\n\nPlease note that all requests require at least these two headers:\n\nContent-Type: application/json\n\nAccept: application/json\n\n## API Errors\n\n*Error Codes*\n\nThe following table describes all the possible HTTP error codes.\n\nCode\n\nDescription\n\n400\n\nBad request\n\n401\n\nUnauthorized. This can happen if the access token is invalid, expired or has been revoked\n\n403\n\nThe access token doesn’t have access to perform the requested action\n\n404\n\nResource not found\n\n418\n\nAPI under maintenance\n\n5XX\n\nAn error occurred on the MD Integrations servers. Check MD Integrations Status API for more details or contact the support team\n\n*Error Format*\n\nThe following table describes the top-level JSON object attributes present in the body of error messages.\n\nkey\n\nvalue\n\nerror\n\nA detailed error message \\* *on production this field is not returned*\n\nmessage\n\nFriendly error message. This error message can be used to be displayed to the final user on the app\n\n## Authentication\n\nTo make any request to the MD Integrations API for Partners, you must first generate a\\\nbrand new access token using your **Client ID** and **Client Secret**.\n\nBoth the **Client ID** and **Client Secret** should be provided to you by the MD Integrations Team.\n\n⚠️ Be careful with the Client Secret! It should not be shared and should be kept safe.\n\n## Issuing an access token\n\nThe expected flow is shown in the image below:\n\n[Image source](https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html)\n\nAs our authorization API you should use the **Partners > Request access token** endpoint - see it’s description for more details.\n\nAfter you’ve created a new access token, you should be ready to make authenticated requests using the HTTP Authorization header with the value Bearer . E.g.:\n\nGET /partner HTTP/1.1\\\n...\\\nAuthorization: Bearer eyJ0eXAiOiJKV1Q...\n\n## Expired tokens\n\nWhenever your token gets expired, you should create a brand new token using the same flow described above.\n\n## Terminology\n\n- **patient**: person in need of treatment by a physician;\n\n- **clinician**: a qualified practitioner of medicine. Alias to MD, doctor and physician;\n\n- **partner**: a partner is a company who sells medications and compounds directly to its patients;\n\n- **medication**: a substance used for medical treatment, especially a medicine or drug, regularly made by pharmaceutical companies;\n\n- **compound**: drug that is specifically mixed and prepared for an individual patient, meaning they are not readily available like a regular OTC medication;\n\n- **prescription**: an instruction written by a clinician that authorizes a patient to be provided by a medication;\n\n- **case**: set of medication prescriptions requests that the partner sends to MD-Integrations on behalf of a patient.\n\n## Contact Support\n\n- Email: [support@mdintegrations.com](mailto:support@mdintegrations.com) # 📁 Collection: Partners # MD Integrations API for Partners\n\n## Intro\n\nThe MD Integrations API for partners is a set of HTTP endpoints that allows partners to perform all the required actions in order to create cases for patients on MD Integrations.\n\n## 📁 Collection: States\n\nundefined\n\n## End-point: Get cities from a given state\n\nReturn a list of all cities from a given state from USA. ### Method: GET >>{{url}}/v1/partner/metadata/states/:state_id/cities?search=Denver > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nsearch\n\nDenver\n\n### Response: undefined\n\n\\[\\\n {\\\n \"name\": \"Leetonia\",\\\n \"city_id\": \"3f23c4f1-3ed2-4e6d-bd91-ba6bf5130f00\"\\\n },\\\n {\\\n \"name\": \"Payne\",\\\n \"city_id\": \"05c995b6-2002-406c-b2e0-e21e2d25e9a0\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get all states\n\nReturn a list of all states from USA. ### Method: GET >>{{url}}/v1/partner/metadata/states > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nsearch\n\nCalifornia\n\n### Response: undefined\n\n\\[\\\n {\\\n \"name\": \"Ohio\",\\\n \"abbreviation\": \"OH\",\\\n \"is_sync\": **false**,\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"46238293-fe51-40b6-8e1a-807bff482450\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n },\\\n {\\\n \"name\": \"Pennsylvania\",\\\n \"abbreviation\": \"PA\",\\\n \"is_sync\": **false**,\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Diseases undefined\n\n## End-point: Get all Disease Codes\n\nReturn a list of all diseases codes. ### Method: GET >>{{baseUrl}}/partner/metadata/diseases > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\ndescription\n\nPsychotic symptoms in dementia\n\nicd\n\n6D86.0\n\npage\n\n3\n\nper_page\n\n100\n\n### Response: undefined\n\n{\\\n \"data\": \\[\\\n {\\\n \"disease_id\": \"82cc9a95-6926-41a8-8776-90871783df96\",\\\n \"icd\": \"1A00\",\\\n \"description\": \"Cholera\"\\\n },\\\n {\\\n \"disease_id\": \"f915136a-c777-430a-ba95-65a134dbda0b\",\\\n \"icd\": \"1A01\",\\\n \"description\": \"Intestinal infection due to other Vibrio\"\\\n },\\\n {\\\n \"disease_id\": \"6572aaff-0f8d-495f-b972-3b24073f6d9c\",\\\n \"icd\": \"1A02\",\\\n \"description\": \"Intestinal infections due to Shigella\"\\\n },\\\n {\\\n \"disease_id\": \"d08c300e-9391-4396-b489-b2e3fa711348\",\\\n \"icd\": \"1A03\",\\\n \"description\": \"Intestinal infections due to Escherichia coli\"\\\n },\\\n {\\\n \"disease_id\": \"a82b63a8-4375-4eaa-b82e-10a98740d81f\",\\\n \"icd\": \"1A03.0\",\\\n \"description\": \"Enteropathogenic Escherichia coli infection\"\\\n },\\\n {\\\n \"disease_id\": \"174e1411-6272-4a45-8025-e830b1e54e68\",\\\n \"icd\": \"1A03.1\",\\\n \"description\": \"Enterotoxigenic Escherichia coli infection\"\\\n },\\\n {\\\n \"disease_id\": \"edec57c9-39f3-4f1d-b491-3ea486a06441\",\\\n \"icd\": \"1A03.2\",\\\n \"description\": \"Enteroinvasive Escherichia coli infection\"\\\n },\\\n {\\\n \"disease_id\": \"1c42e152-5b8f-41e8-80bf-273e9ec8eaf7\",\\\n \"icd\": \"1A03.3\",\\\n \"description\": \"Enterohaemorrhagic Escherichia coli infection\"\\\n },\\\n {\\\n \"disease_id\": \"415dd9d2-94d9-4a90-abe3-c345502fd734\",\\\n \"icd\": \"1A03.Y\",\\\n \"description\": \"Intestinal infections due to other specified Escherichia coli\"\\\n },\\\n {\\\n \"disease_id\": \"3456a088-9bfd-41ee-b068-96233f72da41\",\\\n \"icd\": \"1A03.Z\",\\\n \"description\": \"Intestinal infections due to Escherichia coli, unspecified\"\\\n },\\\n {\\\n \"disease_id\": \"1bd4ab5e-f489-455e-8511-d722a7c737cc\",\\\n \"icd\": \"1A04\",\\\n \"description\": \"Intestinal infections due to Clostridioides difficile\"\\\n },\\\n {\\\n \"disease_id\": \"9a818e20-d1fd-4f4a-b886-77bae80f83da\",\\\n \"icd\": \"1A05\",\\\n \"description\": \"Intestinal infections due to Yersinia enterocolitica\"\\\n },\\\n {\\\n \"disease_id\": \"b56fcee3-633b-4b70-bb51-0939d1204569\",\\\n \"icd\": \"1A06\",\\\n \"description\": \"Gastroenteritis due to Campylobacter\"\\\n },\\\n {\\\n \"disease_id\": \"390e034e-9e66-4587-bbe3-e39a96050769\",\\\n \"icd\": \"1A07\",\\\n \"description\": \"Typhoid fever\"\\\n },\\\n {\\\n \"disease_id\": \"cc6286a7-7e6e-47a6-9ee5-f20f616682f9\",\\\n \"icd\": \"1A07.0\",\\\n \"description\": \"Typhoid peritonitis\"\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=1\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=1\\\",)\\\n \"last\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=1960\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=1960\\\",)\\\n \"prev\": **null**,\\\n \"next\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=2\"](http://api.localhost:8000/v1/partner/metadata/diseases?page=2\\\")\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 1960,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=1\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=2\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=2\\\",)\\\n \"label\": \"2\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=3\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=3\\\",)\\\n \"label\": \"3\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=4\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=4\\\",)\\\n \"label\": \"4\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=5\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=5\\\",)\\\n \"label\": \"5\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=6\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=6\\\",)\\\n \"label\": \"6\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=7\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=7\\\",)\\\n \"label\": \"7\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=8\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=8\\\",)\\\n \"label\": \"8\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=9\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=9\\\",)\\\n \"label\": \"9\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=10\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=10\\\",)\\\n \"label\": \"10\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": **null**,\\\n \"label\": \"...\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=1959\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=1959\\\",)\\\n \"label\": \"1959\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=1960\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=1960\\\",)\\\n \"label\": \"1960\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/metadata/diseases?page=2\",](http://api.localhost:8000/v1/partner/metadata/diseases?page=2\\\",)\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"[http://api.localhost:8000/v1/partner/metadata/diseases\",](http://api.localhost:8000/v1/partner/metadata/diseases\\\",)\\\n \"per_page\": 15,\\\n \"to\": 15,\\\n \"total\": 29391\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get diseases by ID\n\nReturn the disease data by its ID. ### Method: GET >>{{baseUrl}}/partner/metadata/diseases/:disease_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A000\",\\\n \"description\": \"Cholera due to Vibrio cholerae 01, biovar cholerae\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Cities and States from Zipcode\n\nReturns Cities and State for each City that matches the Zipcode passed. ### Method: GET >>{{baseUrl}}/partner/metadata/zipcodes?search=47106 > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nsearch\n\n47106\n\n### Response: undefined\n\n\\[\\\n {\\\n \"zipcode\": \"47106\",\\\n \"city\": {\\\n \"name\": \"Borden\",\\\n \"city_id\": \"fffa8789-d375-479e-ba10-113968b337b2\",\\\n \"state\": {\\\n \"name\": \"Indiana\",\\\n \"abbreviation\": \"IN\",\\\n \"is_sync\": **false**,\\\n \"is_av_flow\": **false**\\\n }\\\n }\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get all license types\n\n### Method: GET\n\n{{baseUrl}}/partner/metadata/license-types\n\n### Response: 200\n\n\\[\\\n {\\\n \"type\": \"npi\",\\\n \"description\": \"National Provider Identifier\"\\\n },\\\n {\\\n \"type\": \"dea\",\\\n \"description\": \"DEA Registration Number\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Files undefined\n\n## End-point: Update case files\n\nUpdate cases files.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\ncase_files\n\narray(uuid)\\*\n\nFiles ID to be attached to the case. The files must be uploaded before creating a case. To upload files check **Partners > Files**\n\n### Method: PATCH\n\n{{baseUrl}}/partner/cases/:case_id/files\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"case_files\": \\[\\\n \"71a8d737-05bd-53eb-9af5-5b4900947fa4\",\\\n \"c2bc014b-81fd-1828-b3cf-2bfaf159054e\"\\\n \\]\\\n}\n\n### Response: undefined\n\n\\[\\\n {\\\n \"file_id\": \"1fff9ac9-c896-4145-9ea3-cdc152e82f2f\",\\\n \"path\": \"partners/PeLGM0MiFDW5zIfLOTvYwyGeGVvLvflNOnQMOZo9.png\",\\\n \"name\": \"face - left side\",\\\n \"mime_type\": \"image/png\",\\\n \"url\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"url_thumbnail\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"created_at\": \"2022-12-15T18:08:08.000000Z\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Attach a file to a case\n\nAttach a file to a case. ### Method: POST >>{{baseUrl}}/partner/cases/:case_id/files/:file_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n{\\\n \"file_id\": \"1fff9ac9-c896-4145-9ea3-cdc152e82f2f\",\\\n \"path\": \"partners/PeLGM0MiFDW5zIfLOTvYwyGeGVvLvflNOnQMOZo9.png\",\\\n \"name\": \"face - left side\",\\\n \"mime_type\": \"image/png\",\\\n \"url\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"url_thumbnail\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"created_at\": \"2022-12-15T18:08:08.000000Z\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Detach a file from a case\n\nAttach a file to a case. ### Method: DELETE >>{{baseUrl}}/partner/cases/:case_id/files/:file_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get case files\n\nReturns a list of all attached files to the case. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/files > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: undefined\n\n\\[\\\n {\\\n \"file_id\": \"1fff9ac9-c896-4145-9ea3-cdc152e82f2f\",\\\n \"path\": \"partners/PeLGM0MiFDW5zIfLOTvYwyGeGVvLvflNOnQMOZo9.png\",\\\n \"name\": \"face - left side\",\\\n \"mime_type\": \"image/png\",\\\n \"url\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"url_thumbnail\": \"[http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\",](http://api.localhost:8000/v1/files/1fff9ac9-c896-4145-9ea3-cdc152e82f2f/redirect?thumbnail=1&token=e4b6b7a54e94320c21ea5e87f8f6a2cc\\\",)\\\n \"created_at\": \"2022-12-15T18:08:08.000000Z\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Events undefined\n\n## End-point: Get case events\n\nReturns a list of events related to the case. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/events > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: undefined\n\n\\[\\\n {\\\n \"event_id\": \"093fecd6-b7e3-4b30-8a26-3cb3c728d592\",\\\n \"date_time\": \"2022-08-25T21:33:51.000000Z\",\\\n \"model\": \"casemodel\",\\\n \"type\": \"viewed\",\\\n \"by_model\": \"clinician\",\\\n \"by\": \"John Snow\",\\\n \"title\": \"Viewed by Clinician\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Offerings undefined\n\n## End-point: Delete case offering\n\nDelete a specific case offering. ### Method: DELETE >>{{baseUrl}}/partner/cases/:case_id/offerings/:offering_id > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: undefined\n\n\\[\\\n {\\\n \"case_prescription_id\": \"4564bd63-eb14-4d2f-b95b-1dfd31d6d801\",\\\n \"title\": \"Title example\",\\\n \"is_additional_approval_needed\": **true**,\\\n \"name\": \"Name example\",\\\n \"dosespot_prescription_id\": **null**,\\\n \"effective_date\": \"2023-05-10\",\\\n \"status\": \"pending\",\\\n \"prescription_status_details\": \"Prescription delivery verified\",\\\n \"refills\": 15,\\\n \"quantity\": 1779333.59,\\\n \"days_supply\": 87,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"thank_you_note\": \"Lorem ipsum\",\\\n \"clinical_note\": \"Lorem ipsum\",\\\n \"directions\": \"Maxime sed voluptate autem pariatur sed quasi.\",\\\n \"dispense_unit_id\": 73,\\\n \"pharmacy_id\": 76,\\\n \"pharmacy_name\": \"White Oak Pharmacy\",\\\n \"medication\": **null**,\\\n \"partner_compound\": {\\\n \"partner_compound_id\": \"57e6b905-2c69-40e5-9c69-56c7e8b6a76f\",\\\n \"title\": \"Clindamycin\",\\\n \"metadata\": \"Lorem ipum\"\\\n }\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update case offerings statuses\n\nUpdate cases offerings statuses. ### Method: PATCH >>{{baseUrl}}/partner/cases/:case_id/offerings/status > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n\\[\\\n {\\\n \"case_prescription_id\": \"4564bd63-eb14-4d2f-b95b-1dfd31d6d801\",\\\n \"title\": \"Title example\",\\\n \"is_additional_approval_needed\": **true**,\\\n \"name\": \"Name example\",\\\n \"dosespot_prescription_id\": **null**,\\\n \"status\": \"pending\",\\\n \"prescription_status_details\": \"Prescription delivery verified\",\\\n \"refills\": 15,\\\n \"order\": 1,\\\n \"quantity\": 1779333.59,\\\n \"days_supply\": 87,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"thank_you_note\": \"Lorem ipsum\",\\\n \"clinical_note\": \"Lorem ipsum\",\\\n \"directions\": \"Maxime sed voluptate autem pariatur sed quasi.\",\\\n \"dispense_unit_id\": 73,\\\n \"pharmacy_id\": 76,\\\n \"pharmacy_name\": \"White Oak Pharmacy\",\\\n \"medication\": **null**,\\\n \"partner_compound\": {\\\n \"partner_compound_id\": \"57e6b905-2c69-40e5-9c69-56c7e8b6a76f\",\\\n \"title\": \"Clindamycin\",\\\n \"name\": \"Clindamycin\",\\\n \"metadata\": \"Lorem ipum\"\\\n }\\\n },\\\n {\\\n \"dosespot_prescription_id\": **null**,\\\n \"title\": \"Title example\",\\\n \"name\": \"Name example\",\\\n \"status\": \"pending\",\\\n \"prescription_status_details\": \"Prescription delivery verified\",\\\n \"refills\": 15,\\\n \"order\": 2,\\\n \"quantity\": \"92442.271\",\\\n \"days_supply\": 87,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"thank_you_note\": \"Lorem ipsum\",\\\n \"clinical_note\": \"Lorem ipsum\",\\\n \"directions\": \"Maxime sed voluptate autem pariatur sed quasi.\",\\\n \"dispense_unit_id\": 73,\\\n \"pharmacy_id\": 76,\\\n \"pharmacy_name\": \"White Oak Pharmacy\",\\\n \"medication\": {\\\n \"dosespot_medication_id\": \"1495316\",\\\n \"dispense_unit_id\": 26,\\\n \"dose_form\": \"tablet\",\\\n \"route\": \"sublingual\",\\\n \"strength\": \"2800 BAU\",\\\n \"generic_product_name\": \"timothy grass pollen allergen extract 2800 BAU sublingual tablet\",\\\n \"lexi_gen_product_id\": 29589,\\\n \"lexi_drug_syn_id\": 219792,\\\n \"lexi_synonym_type_id\": 60,\\\n \"lexi_gen_drug_id\": \"d08256\",\\\n \"rx_cui\": \"1495316\",\\\n \"otc\": **false**,\\\n \"ndc\": \"52709150103\",\\\n \"schedule\": \"0\",\\\n \"display_name\": \"Grastek 2800 BAU sublingual tablet\",\\\n \"monograph_path\": **null**,\\\n \"drug_classification\": \"allergenics\",\\\n \"state_schedules\": \\[\\],\\\n \"metadata\": \"Lorem ipum\",\\\n \"partner_medication_id\": \"29394cf1-379d-4767-abc0-982343980646\",\\\n \"title\": \"tim grass\"\\\n },\\\n \"partner_compound\": **null**\\\n },\\\n {\\\n \"dosespot_prescription_id\": **null**,\\\n \"title\": \"Title example\",\\\n \"name\": \"Name example\",\\\n \"status\": \"pending\",\\\n \"prescription_status_details\": \"Prescription delivery verified\",\\\n \"refills\": 15,\\\n \"order\": 3,\\\n \"quantity\": \"92442.271\",\\\n \"days_supply\": 87,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"thank_you_note\": \"Lorem ipsum\",\\\n \"clinical_note\": \"Lorem ipsum\",\\\n \"directions\": \"Maxime sed voluptate autem pariatur sed quasi.\",\\\n \"dispense_unit_id\": 73,\\\n \"pharmacy_id\": 76,\\\n \"medication\": **null**,\\\n \"partner_compound\": **null**,\\\n \"partner_supply\": {\\\n \"ndc\": \"83490044052\",\\\n \"name\": \"Mask Vortex Miscellaneous\",\\\n \"active\": **true**,\\\n \"refills\": 1,\\\n \"metadata\": \"teste metadata\",\\\n \"quantity\": 1,\\\n \"supply_id\": 13279,\\\n \"directions\": \"test\",\\\n \"days_supply\": **null**,\\\n \"pharmacy_id\": \"13012\",\\\n \"rx_required\": **false**,\\\n \"clinical_note\": **null**,\\\n \"dispense_unit\": \"Film\",\\\n \"pharmacy_name\": \"Curexa\",\\\n \"pharmacy_notes\": **null**,\\\n \"thank_you_note\": **null**,\\\n \"dispense_unit_id\": \"52\",\\\n \"partner_supply_id\": \"1415fa7f-af2e-4d56-81e0-a4bef15b7c51\"\\\n }\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get case offerings\n\nReturn all offerings for a given case ID. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/offerings > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: undefined\n\n\\[\\\n {\\\n \"id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"case_offering_id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"title\": \"supply example\",\\\n \"name\": \"supply example\",\\\n \"directions\": \"directions\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"19e21647-e5bf-4996-b9b4-154aab1963ad\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"ndc\": **null**,\\\n \"otc\": **null**,\\\n \"upc\": **null**,\\\n \"name\": \"supply example\",\\\n \"title\": \"supply example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"directions\",\\\n \"updated_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"days_supply\": **null**,\\\n \"is_obsolete\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"dosespot_supply_id\": 21\\\n },\\\n \"product_id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotSupply\"\\\n },\\\n {\\\n \"id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"case_offering_id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"title\": \"compound example\",\\\n \"name\": \"compound example\",\\\n \"directions\": \"abc\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"5ff1eae1-1566-4dd5-ad1a-457b105d59ac\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"name\": \"compound example\",\\\n \"title\": \"compound example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"abc\",\\\n \"updated_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"days_supply\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"allow_substitutions\": **true**\\\n },\\\n \"product_id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotCompound\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update case offering\n\nUpdate a specific case offering. ### Method: PATCH >>{{baseUrl}}/partner/cases/:case_id/offerings/:offering_id > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"product\": {\\\n \"quantity\": 3,\\\n \"directions\": \"One per day\",\\\n \"day_supply\": 2\\\n }\\\n}\n\n### Response: undefined\n\n\\[\\\n {\\\n \"id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"case_offering_id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"title\": \"supply example\",\\\n \"name\": \"supply example\",\\\n \"directions\": \"directions\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"19e21647-e5bf-4996-b9b4-154aab1963ad\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"ndc\": **null**,\\\n \"otc\": **null**,\\\n \"upc\": **null**,\\\n \"name\": \"supply example\",\\\n \"title\": \"supply example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"directions\",\\\n \"updated_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"days_supply\": **null**,\\\n \"is_obsolete\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"dosespot_supply_id\": 21\\\n },\\\n \"product_id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotSupply\"\\\n },\\\n {\\\n \"id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"case_offering_id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"title\": \"compound example\",\\\n \"name\": \"compound example\",\\\n \"directions\": \"abc\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"5ff1eae1-1566-4dd5-ad1a-457b105d59ac\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"name\": \"compound example\",\\\n \"title\": \"compound example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"abc\",\\\n \"updated_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"days_supply\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"allow_substitutions\": **true**\\\n },\\\n \"product_id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotCompound\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create case offering\n\nCreate a case offering. ### Method: POST >>{{baseUrl}}/partner/cases/:case_id/offerings > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"offering_id\": \"dbcc21c5-53d4-4da2-8cf6-7156563a035c\",\\\n \"product\": {\\\n \"name\": \"Semaglutide\",\\\n \"sku\": \"1010\",\\\n \"dispense_unit\": \"tablet\",\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"quantity\": 4,\\\n \"days_supply\": 2,\\\n \"directions\": \"One per day.\"\\\n }\\\n}\n\n### Response: undefined\n\n{\\\n \"id\": \"b0fe79cb-d766-4416-b997-92f3866fdc75\",\\\n \"case_offering_id\": \"b0fe79cb-d766-4416-b997-92f3866fdc75\",\\\n \"title\": \"supply title\",\\\n \"name\": \"supply name\",\\\n \"directions\": \"new directions\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"211fa3d8-f257-47d4-8de3-1e39d8c8832a\",\\\n \"order_status\": \"not-applicable\",\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-06-10T12:57:45.000000Z\",\\\n \"updated_at\": \"2025-06-10T12:57:45.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"bdbf38f9-b85c-43b2-802a-81741581bc15\",\\\n \"dosespot_supply_id\": 21,\\\n \"name\": \"nme test\",\\\n \"ndc\": **null**,\\\n \"refills\": 3,\\\n \"quantity\": \"8\",\\\n \"days_supply\": **null**,\\\n \"directions\": \"directions\",\\\n \"pharmacy_name\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"dispense_unit\": \"Tablet\",\\\n \"dispense_unit_id\": 26,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"metadata\": **null**,\\\n \"created_at\": \"2025-04-25T13:48:52.000000Z\",\\\n \"updated_at\": \"2025-04-25T13:52:59.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"title\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"upc\": **null**,\\\n \"otc\": **null**,\\\n \"is_obsolete\": **null**\\\n },\\\n \"product_id\": \"bdbf38f9-b85c-43b2-802a-81741581bc15\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotSupply\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Questions undefined\n\n## End-point: Post case question\n\nCreate a case question.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nquestion\n\ntext\\*\n\nQuestion\n\nanswer\n\ntext\\*\n\nAnswer\n\ntype\n\nstring\\*\n\nQuestion type. Available options: boolean, number or string\n\nimportant\n\nboolean\n\nFlag to set a question as important\n\ndisplay_in_pdf\n\nboolean\n\nFlag to set if this question will be displayed in the case PDF file\n\ndescription\n\ntext\n\nA description for your question\n\nlabel\n\nstring(50)\n\nThe question label\n\nmetadata\n\ntext\n\nA metadata field\n\ndisplayed_options\n\narray\n\nAn array of options that were displayed to the patient\n\nis_critical\n\nboolean\n\nMark question as critical\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/questions\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"question\": \"Are you pregnant?\",\\\n \"answer\": \"true\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **true**,\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #123 for question\",\\\n \"displayed_options\": \\[\\\n \"yes\",\\\n \"no\"\\\n \\]\\\n}\n\n### Response: 200\n\n{\\\n \"question\": \"Do you smoke?\",\\\n \"answer\": \"true\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"case_question_id\": \"02592944-ba4a-4d93-87d9-daa7d256faf4\",\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #222 for question\",\\\n \"displayed_options\": \\[\\\n \"yes\",\\\n \"no\"\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get case questions\n\nReturn all questions for a given case ID. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/questions > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"prioritized\": **true**,\\\n \"prioritized_reason\": \"The prescription is urgent!\"\\\n}\n\n### Response: undefined\n\n\\[\\\n {\\\n \"question\": \"Are you pregnant?\",\\\n \"answer\": \"true\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **true**,\\\n \"case_question_id\": \"774f6741-afd1-40a5-aa60-0ddf635472cb\",\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #222 for question\",\\\n \"displayed_options\": \\[\\\n \"yes\",\\\n \"no\"\\\n \\]\\\n },\\\n {\\\n \"question\": \"Do you smoke?\",\\\n \"answer\": \"true\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **true**,\\\n \"case_question_id\": \"02592944-ba4a-4d93-87d9-daa7d256faf4\",\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #222 for question\",\\\n \"displayed_options\": \\[\\\n \"true\",\\\n \"false\"\\\n \\]\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Diseases undefined\n\n## End-point: Get case diseases\n\nList all diseases for a given case ID. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/diseases > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A000\",\\\n \"description\": \"Cholera due to Vibrio cholerae 01, biovar cholerae\",\\\n \"is_primary\": **true**\\\n },\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A001\",\\\n \"description\": \"Cholera due to Vibrio 02\",\\\n \"is_primary\": **false**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Delete diseases\n\nDelete disease from a case. ### Method: DELETE >>{{baseUrl}}/partner/cases/:case_id/diseases/:disease_id > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A000\",\\\n \"description\": \"Cholera due to Vibrio cholerae 01, biovar cholerae\",\\\n \"is_primary\": **true**\\\n },\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A001\",\\\n \"description\": \"Cholera due to Vibrio 02\",\\\n \"is_primary\": **false**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Attach new diseases\n\nAttach a Disease to the given Case.\n\n# Payload\n\n**Note**: Use the “Get all Disease Codes” endpoint under the metadata folder to find a list of all availables UUID to be used. Once you know a disease id, you can also retrieve its information through the API using the Get Disease route\n\n**field**\n\n**type**\n\ndisease_id\n\nUUID (**required)**\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/diseases\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"disease_id\": \"0b333a71-8e31-4b5d-834c-27f724ac14ff\"\\\n}\n\n### Response: 200\n\n\\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A000\",\\\n \"description\": \"Cholera due to Vibrio cholerae 01, biovar cholerae\",\\\n \"is_primary\": **true**\\\n },\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A001\",\\\n \"description\": \"Cholera due to Vibrio 02\",\\\n \"is_primary\": **false**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Set primary disease\n\nSet a case disease as primary to be sent to Dosespot. ### Method: POST >>{{baseUrl}}/partner/cases/:case_id/diseases/:disease_id/primary > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\neyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIwOWQ5OGEwMC02YzBjLTRiOTctOTMzOC0wOTBmY2U3NmU4NDUiLCJqdGkiOiIxNDA2Y2VkMTg4YzBhMzI1NDExMzJjZTA3N2ZlNDNjNWRmNDVhNGQ2MTVkZmNhYWE5MTNlYzEyYjliZmYzMDAzMjc1MGYwNzY2NDk5MDNkNCIsImlhdCI6MTc0MTc5OTU0MC4yMTAzNjMsIm5iZiI6MTc0MTc5OTU0MC4yMTAzNjUsImV4cCI6MTc0MTg4NTk0MC4xOTQyODQsInN1YiI6IiIsInNjb3BlcyI6WyIqIl19.eDiRQ-gCvB8c33eNCKew8bWPdKY_bOMs-d0edWkfZ8j_3qGS75Ai7FD9VAlu5NFW9D7VEirfZt7P_y9hKp2cGkak62D4b2UZBVx5PlK97V0howheZf_QBQBMX4UDv5MwkBiAwH8nyujLIE7IQor4sj1Zzvba54Y-nqLcsxUnZtR2473u8-2iKXhcYL3DI00jzUFNTaspj3s3a_8nlSFhLzLxdVnlcwzVhA-h2z8XOocO8lem81giqJbZn_kkEHw31UvHaIvsEQJAFl-z7U_mjSR3vrTHuq3YY017pr1r_Cb1W9VStGuePZMB07ADJNIh4iZijO5kwqWzmmG5wfOOF_xm8jLW0-8afaGQ7gk5T-p2dkbKRMb4wGz_9SW3n-fFrEK4bCBREXSNIhlhMNYxOjy7qxkn_xy5qIUyiC3G0h88fHTX8doXojDXdf1h3TPwXpuYnb-6szDJNZBtl1fnS-Nh2JIqVofsZUy7uFVxepoAb-dvY_P0YycIzndTTlNgBRoPcD5cB7cwSimP4ajbAd9EtQPvvUA3ih2jx91B0d8jQ2ehSPgGGzQK6JGYEUi8WXZiKL4l3ayPdHP8qLPiRaBuJHzAevUfUoovjiTfVmuy9YWyRCCCtd6aUXW_QpSnK9eQvVOC41Nd9B0q074tcwIlFX4SKcUr-3IOGLzMH8g\n\nstring\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Case Status undefined\n\n## End-point: Send case to Support\n\nSet a given case as in support.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nreason\n\nstring\n\nA reason description\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/support\n\n### Body (**raw**)\n\n{\\\n \"reason\": \"Needs customer support attention\"\\\n}\n\n### Query Params\n\nParam\n\nvalue\n\n### Response: undefined\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"is_additional_approval_needed\": **false**,\\\n \"created_at\": \"2021-06-07T17:01:32.000000Z\",\\\n \"is_sync\": **true**,\\\n \"metadata\": \"case number 15\",\\\n \"patient_exam_id\": **null**,\\\n \"is_chargeable\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"case_id\": \"45e1e159-163d-4bba-9fb5-436db4222ac5\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"support\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-06-17T17:14:59.000000Z\"\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Repellat quisquam sed distinctio sit id et. Unde et doloremque quas ducimus harum perferendis. Officia sapiente velit necessitatibus deleniti. Velit error inventore ut ipsam officia id dolorem.\",\\\n \"created_at\": \"2021-02-03T19:30:18.000000Z\",\\\n \"case_assignment_id\": \"227ed29c-044a-41d7-bb68-caa2e6c5ee63\",\\\n \"clinician\": {\\\n \"first_name\": \"Parisian\",\\\n \"last_name\": \"Schultz\",\\\n \"suffix\": \"M.D\",\\\n \"is_online\": **true**,\\\n \"npi\": \"1598738916\",\\\n \"specialty\": \"General Practice\",\\\n \"dea\": \"RM1234567\",\\\n \"photo\": {\\\n \"path\": \"clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",\\\n \"name\": \"under_construction.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",](http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"22a03259-b2de-4255-9d2e-48a9dc368633\"\\\n },\\\n \"clinician_id\": \"65e4f8da-e5f7-44b3-a3d4-c9dc74981f4f\",\\\n \"full_name\": \"Seamus Parisian\"\\\n }\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"Valentine\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Blick\",\\\n \"email\": \"[alverta13@example.org](mailto:alverta13@example.org)\",\\\n \"date_of_birth\": \"1977-07-10\",\\\n \"gender\": 0,\\\n \"height\": 6,\\\n \"metadata\": \"patient number 15\",\\\n \"weight\": 170,\\\n \"phone_number\": \"468.287.0822\",\\\n \"phone_type\": \"2\",\\\n \"active\": **true**,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"patient_id\": \"b9d75141-b78a-428c-ad41-c7df6307f6db\",\\\n \"gender_label\": \"Not known\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"pregnancy\": **true**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"state\": {\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Langworth, Heaney and Mills\",\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"support_message_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"thank_you_note_header\": \"Header Thank you note example\",\\\n \"thank_you_note_footer\": \"Footer Thank you note example\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update hold status flag\n\nUpdate the hold status flag.\n\n**Field**\n\n**Type**\n\n**Description**\n\nhold_status\n\nboolean\\*\n\nIf the case is in **created** status you can update the flag hold status, that way you can choose when the case will enter the MDI flow.\n\n### Method: PATCH\n\n{{baseUrl}}/partner/cases/:case_id/status\n\n### Body (**raw**)\n\n{\\\n \"hold_status\": **true**\\\n}\n\n### Response: undefined\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Cancel case\n\nSet case as cancelled.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nreason\n\nstring\n\nA reason description (optional)\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/cancel\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"reason\": \"This is an example of a cancelled case.\"\\\n}\n\n### Response: 200\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"is_additional_approval_needed\": **true**,\\\n \"created_at\": \"2021-09-01T17:04:46.000000Z\",\\\n \"is_sync\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"metadata\": \"asdadssa\",\\\n \"patient_exam_id\": \"8cc8e948-1578-409b-9e18-0a771d349355\",\\\n \"case_id\": \"23a987ec-a724-46e3-8642-6cb44c18397c\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"cancelled\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-09-01T17:05:01.000000Z\"\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"support_message_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"thank_you_note_header\": \"Header Thank you note example\",\\\n \"thank_you_note_footer\": \"Footer Thank you note example\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"Kamille\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Dickens\",\\\n \"suffix\": \"M.D\",\\\n \"email\": \"[green92@example.org](mailto:green92@example.org)\",\\\n \"date_of_birth\": \"1975-01-03\",\\\n \"gender\": 0,\\\n \"phone_number\": \"541-754-3010\",\\\n \"phone_type\": \"4\",\\\n \"active\": **true**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"current_medications\": **null**,\\\n \"allergies\": **null**,\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"pregnancy\": **false**,\\\n \"metadata\": **null**,\\\n \"patient_id\": \"410af41d-e02b-4b54-a707-725141937ec8\",\\\n \"gender_label\": \"Not known\",\\\n \"driver_license\": **null**,\\\n \"is_live\": **true**,\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"77058\",\\\n \"city_name\": \"Nassau Bay\",\\\n \"address_id\": \"01ed51d1-4173-4165-be32-21887da32ffb\",\\\n \"state\": {\\\n \"name\": \"Texas\",\\\n \"abbreviation\": \"TX\",\\\n \"state_id\": \"7ff4d81b-18b3-4dc8-a243-6da992b962d2\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n }\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Initial assignment.\",\\\n \"created_at\": \"2021-09-01T17:04:47.000000Z\",\\\n \"case_assignment_id\": \"122a0251-9bad-4cde-811c-fa17c6c1f694\",\\\n \"clinician\": {\\\n \"first_name\": \"Madisen\",\\\n \"last_name\": \"Schultz\",\\\n \"is_online\": **true**,\\\n \"npi\": \"1598738916\",\\\n \"specialty\": \"General Practice\",\\\n \"dea\": \"RM1234567\",\\\n \"clinician_id\": \"fbace403-f846-4411-a7eb-f4067860723e\",\\\n \"full_name\": \"Jaclyn Ledner\",\\\n \"photo\": **null**\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Set case as Assigned\n\nSet a given case as assigned. ### Method: POST >>{{baseUrl}}/partner/cases/:case_id/assigned > ### Response: undefined\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"is_additional_approval_needed\": **true**,\\\n \"created_at\": \"2021-06-07T17:01:32.000000Z\",\\\n \"is_sync\": **true**,\\\n \"metadata\": \"case number 15\",\\\n \"patient_exam_id\": **null**,\\\n \"is_chargeable\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"case_id\": \"45e1e159-163d-4bba-9fb5-436db4222ac5\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"created\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-06-17T17:14:59.000000Z\"\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Repellat quisquam sed distinctio sit id et. Unde et doloremque quas ducimus harum perferendis. Officia sapiente velit necessitatibus deleniti. Velit error inventore ut ipsam officia id dolorem.\",\\\n \"created_at\": \"2021-02-03T19:30:18.000000Z\",\\\n \"case_assignment_id\": \"227ed29c-044a-41d7-bb68-caa2e6c5ee63\",\\\n \"clinician\": {\\\n \"first_name\": \"Parisian\",\\\n \"last_name\": \"Schultz\",\\\n \"suffix\": \"M.D\",\\\n \"is_online\": **true**,\\\n \"npi\": \"1598738916\",\\\n \"specialty\": \"General Practice\",\\\n \"dea\": \"RM1234567\",\\\n \"photo\": {\\\n \"path\": \"clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",\\\n \"name\": \"under_construction.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",](http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"22a03259-b2de-4255-9d2e-48a9dc368633\"\\\n },\\\n \"clinician_id\": \"65e4f8da-e5f7-44b3-a3d4-c9dc74981f4f\",\\\n \"full_name\": \"Seamus Parisian\"\\\n }\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"Valentine\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Blick\",\\\n \"email\": \"[alverta13@example.org](mailto:alverta13@example.org)\",\\\n \"date_of_birth\": \"1977-07-10\",\\\n \"gender\": 0,\\\n \"height\": 6,\\\n \"metadata\": \"patient number 15\",\\\n \"weight\": 170,\\\n \"phone_number\": \"468.287.0822\",\\\n \"phone_type\": \"2\",\\\n \"active\": **true**,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"patient_id\": \"b9d75141-b78a-428c-ad41-c7df6307f6db\",\\\n \"gender_label\": \"Not known\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"pregnancy\": **true**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"state\": {\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Langworth, Heaney and Mills\",\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"support_message_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"vouched_integration_type\": \"disabled\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Send an Approved Case to Processing\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/processing\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Clinical Notes undefined\n\n## End-point: Get notes\n\nReturn all the clinical notes for a given case. ### Method: GET >>{{baseUrl}}/partner/cases/:case_id/notes > ### Response: undefined\n\n\\[\\\n {\\\n \"case_note_id\": \"9b12e8ca-ee58-41e0-ac49-44d541194d47\",\\\n \"text\": \"This is an example of a clinical note.\",\\\n \"case_id\": \"82f194ab-e400-4719-86d5-a734eed02841\",\\\n \"clinician\": {\\\n \"clinician_id\": \"682d152c-6f94-4955-9b30-1ca976817e63\",\\\n \"is_online\": **false**,\\\n \"specialty\": \"General Practice\",\\\n \"full_name\": \"John Snow\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Snow\",\\\n \"suffix\": **null**,\\\n \"email\": \"[snow@mail.com](mailto:snow@mail.com)\",\\\n \"date_of_birth\": \"1990-12-31\",\\\n \"phone_number\": \"541-754-3010\",\\\n \"phone_type\": \"2\",\\\n \"fax_number\": \"212-9876543\",\\\n \"profile_url\": \"[http://profileurlexample.com\",](http://profileurlexample.com\\\",)\\\n \"active\": **true**,\\\n \"case_assignment_availability\": **true**,\\\n \"photo\": {\\\n \"file_id\": \"6f54001f-86b7-439e-9979-029046ebd457\",\\\n \"path\": \"partners/WhjBMtAw7SkjHlW08XHyHcU49e2pYyQPkPDnoUYZ.jpg\",\\\n \"name\": \"e11797_791981497f454e0098365e642f710343_mv2_d_2000_1333_s_2.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[https://api.mdintegrations.com/s3/files/6f54001f-86b7-439e-9979-029046ebd457/file?signature=f226677487404233f0475c801feea2f1bc6af10909d6441ace3c23ce94fe7049\",](https://api.mdintegrations.com/s3/files/6f54001f-86b7-439e-9979-029046ebd457/file?signature=f226677487404233f0475c801feea2f1bc6af10909d6441ace3c23ce94fe7049\\\",)\\\n \"url_thumbnail\": \"[https://api.mdintegrations.com/s3/files/6f54001f-86b7-439e-9979-029046ebd457/thumbnail?signature=1dae991082051402d96095d2bc06431c8d2a346a841024f32e98e173776952ac\",](https://api.mdintegrations.com/s3/files/6f54001f-86b7-439e-9979-029046ebd457/thumbnail?signature=1dae991082051402d96095d2bc06431c8d2a346a841024f32e98e173776952ac\\\",)\\\n \"created_at\": \"2022-11-08T20:56:55.000000Z\"\\\n },\\\n \"bio_details\": **null**\\\n },\\\n \"created_at\": \"2021-08-19T13:08:33.000000Z\",\\\n \"updated_at\": \"2021-08-19T13:08:33.000000Z\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Tags undefined\n\n## End-point: Attach tag\n\nAttach a tag to case.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nnotes\n\nstring\n\nAllow to add a note when attaching tags\n\n### Method: POST\n\n{{baseUrl}}/partner/cases/:case_id/tags/:tag_id\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"notes\": \"Notes to add to tag\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Detach tag\n\nDetach a tag from case. ### Method: DELETE >>{{baseUrl}}/partner/cases/:case_id/tags/:tag_id > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update tag note\n\nAllow to update the tag note related to case.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nnotes\n\nstring\\*\n\nAllow to add a note when attaching tags\n\n### Method: PATCH\n\n{{baseUrl}}/partner/cases/:case_id/tags/:tag_id\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"notes\": \"Notes to add to tag\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get case\n\nGet the following case details:\n\n- Patient\n\n- Partner\n\n- Priority status and reason\n\n- Status (if is cancelled or not)\n\nTo get details from prescriptions, files and questions you must use specific API endpoints:\n\n- Files: check **“Partners > Cases > Files”**\n\n- Prescriptions: check **“Partners > Cases > Prescriptions”**\n\n- Questions: check **“Partners > Cases > Questions”** ### Method: GET >>{{baseUrl}}/partner/cases/:case_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"is_additional_approval_needed\": **false**,\\\n \"created_at\": \"2021-06-10T16:34:40.000000Z\",\\\n \"metadata\": \"case number 15\",\\\n \"patient_exam_id\": \"8cc8e948-1578-409b-9e18-0a771d349355\",\\\n \"is_chargeable\": **true**,\\\n \"is_sync\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"case_id\": \"e02ebf38-147a-419b-bfc8-87e88d29f161\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"created\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-06-17T17:14:59.000000Z\"\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Snow\",\\\n \"email\": \"[johnsnow@doe.com](mailto:johnsnow@doe.com)\",\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"gender\": 1,\\\n \"phone_number\": \"(415) 555-2671\",\\\n \"phone_type\": \"2\",\\\n \"active\": **true**,\\\n \"metadata\": \"patient number 200\",\\\n \"weight\": \"50.000\",\\\n \"height\": 180,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"current_medications\": \"paracetamol\",\\\n \"allergies\": \"polen\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"patient_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"gender_label\": \"Male\",\\\n \"pregnancy\": **false**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"state\": {\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Langworth, Heaney and Mills\",\\\n \"partner_id\": \"b9c80740-cf71-4a34-8523-987edf221f75\",\\\n \"support_message_capability\": \"integrated\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"thank_you_note_header\": \"Header Thank you note example\",\\\n \"thank_you_note_footer\": \"Footer Thank you note example\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"enable_icd_bmi\": **false**,\\\n \"is_auto_dl_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"av_flow\": **false**,\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n },\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n }\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Repellat quisquam sed distinctio sit id et. Unde et doloremque quas ducimus harum perferendis. Officia sapiente velit necessitatibus deleniti. Velit error inventore ut ipsam officia id dolorem.\",\\\n \"created_at\": \"2021-02-03T19:30:18.000000Z\",\\\n \"case_assignment_id\": \"227ed29c-044a-41d7-bb68-caa2e6c5ee63\",\\\n \"clinician\": {\\\n \"first_name\": \"Parisian\",\\\n \"last_name\": \"Schultz\",\\\n \"suffix\": \"M.D\",\\\n \"profile_url\": \"[http://profileurlexample.com\",](http://profileurlexample.com\\\",)\\\n \"is_online\": **true**,\\\n \"clinician_id\": \"65e4f8da-e5f7-44b3-a3d4-c9dc74981f4f\",\\\n \"full_name\": \"Seamus Parisian\",\\\n \"specialty\": \"General Practice\",\\\n \"licenses\": \\[\\\n {\\\n \"license_id\": \"14212272-251550e0-5af7-433d-a14b-1d3c51361fc3\",\\\n \"type\": \"dea\",\\\n \"value\": \"RM1234567\"\\\n },\\\n {\\\n \"license_id\": \"0bf566d7-bf01-4290-ab8e-1f3cf71a8da6\",\\\n \"type\": \"npi\",\\\n \"value\": \"1598738916\"\\\n }\\\n \\],\\\n \"photo\": {\\\n \"path\": \"clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",\\\n \"name\": \"under_construction.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",](http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"22a03259-b2de-4255-9d2e-48a9dc368633\"\\\n }\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Services PDF\n\n### Method: GET\n\n{{baseUrl}}/partner/cases/:case_id/pdf\n\n### Response: undefined\n\n{\\\n \"file\": \"[https://mdintegrations-api-temp.s3.us-east-2.amazonaws.com/rushi-k-ff206ab688f245ccacb3a444782aa8e3.zip?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAV2X27B62BDA72DWM%2F20220331%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20220331T174244Z&X-Amz-SignedHeaders=host&X-Amz-Expires=180&X-Amz-Signature=444ecbf1c4ddd04ceecc9314c2b30c2528e07f4e716a8d5540b6b51384df2146\"](https://mdintegrations-api-temp.s3.us-east-2.amazonaws.com/rushi-k-ff206ab688f245ccacb3a444782aa8e3.zip?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAV2X27B62BDA72DWM%2F20220331%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20220331T174244Z&X-Amz-SignedHeaders=host&X-Amz-Expires=180&X-Amz-Signature=444ecbf1c4ddd04ceecc9314c2b30c2528e07f4e716a8d5540b6b51384df2146\\\")\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create case\n\nCreate a new case for a given patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nhold_status\n\nboolean\n\nFlag to hold the status to not enter into the MDI flow. It will be **false** by default.\n\nis_additional_approval_needed\n\nboolean\n\nIt defines if the case needs an additional approve,\n\nreference_case_id\n\nuuid\n\nThe referenced case UUID\n\npatient_id\n\nuuid\\*\n\nPatient ID. Check **Partners > Cases > Patients** to create new patients\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the case. (e.g., an ID that will be used to identify this case in another database)\n\nclinician_id\n\nuuid\n\nClinician to assign the case to, in case there is a preference for a specific clinician in a specific case. If the field is not sent, a clinician will be assigned according to MDIntegrations algorithm.\n\ncase_offerings\n\narray(Offering)\n\nList of offerings to be reviewed by a clinician\n\ndiseases\n\narray(Disease)\n\nList of diseases to be attached to the case (ICD).\n\ncase_files\n\narray(uuid)\n\nFiles ID to be attached to the case. The files must be uploaded before creating a case. To upload files check **Partners > Files**\n\ncase_questions\n\narray(Question)\n\nQuestions and answers list\n\nis_chargeable\n\nboolean\n\nWhether or not the case should be charged\n\ntags\n\narray(object(uuid))\n\nTag ID to be attached to the case.\n\n## Diseases Properties\n\n**Important**: Every disease object will add the disease with the ICD (International Classification of Disease) to the case.\n\n\\[{disease_id}, {disease_id}\\]\n\n**Note**: Use the “Get all Disease Codes” endpoint under the metadata folder to find a list of all availables UUID to be used. Once you know a disease id, you can also retrieve its information through the API using the Get Disease route.\n\nfield\n\ntype\n\ndescription\n\ndisease_id\n\nUUID\n\nDisease ID. It can be found through the diseases endpoints.\n\n## Tag Properties\n\n\\[{tag_id}, {tag_id}\\]\n\nfield\n\ntype\n\ndescription\n\ntags\n\narray\n\nTag UUID. It can be found through the tags endpoints.\n\n## Offering Properties\n\n**Note**: Please ask our medical team to add medications to your company’s dashboard so it’s easier to manage prescriptions details from there.\n\nfield\n\ntype\n\ndescription\n\noffering_id\n\nuuid\n\nThe offering ID. Check **Partners > Offerings** to get an offering_id for a given offering. **Required.**\n\nproduct\n\nobject\n\nSpecific offering fields to be overwritten when provided. Not required. Note each offering type has specific fields that can be overwritten with this payload.\n\nproduct.refills\n\ninteger (from 0 to 99)\n\nTotal of amount refills for the given offering\n\nproduct.quantity\n\nstring\n\nOffering quantity string representing a float number (from 0 to 9999999999)\n\nproduct.days_supply\n\ninteger (from 0 to 365)\n\nNumber of days of supply of the offering provided - Allows null value\n\nproduct.directions\n\nstring(140)\n\nInstructions about how the offering is administered\n\n[product.pharmacy](http://product.pharmacy)\\_notes\n\nstring(210)\n\nAdditional information about the offering\n\n[product.no](http://product.no)\\_substitutions\n\nboolean\n\nWhether or not an offering can be replaced to a similar formula/compound if needed.\n\nproduct.dispense_unit_id\n\ninteger\n\nThe dispense unit ID. For a list of all available dispense units check **Partners > Dispense Units**. \\*\n\n[product.pharmacy](http://product.pharmacy)\\_id\n\ninteger\n\nPharmacy where the prescription must be sent to. Check **Partners > Pharmacies > Get pharmacies** to get a list of all pharmacies available. **Important note**: Dosespot works with **different IDs** for pharmacies according to the environment. Example: - Curexa pharmacy ID in **staging** environment: 133012 - Curexa pharmacy ID in **production** environment: 29992\n\nproduct.effective_date\n\nstring\n\nDate from which the offering will become fulfillable (time will always be 00:00:00). Format: Y-m-d\n\ntitle\n\nstring\n\nOffering title\n\n[product.name](http://product.name)\n\nstring\n\nOffering name\n\norder\n\ninteger\n\nThe offering ordering\n\n### Prescription Status Flow\n\npending: When an offering is created on MDI side and not synced with Dosespot yet;\\\nprocessing: When MDI receives the Dosespot ID and send through the Dosespot the prescription to Pharmacy;\\\ncompleted: When Dosespot responds to the MDI that this prescription has been verified by the pharmacy;\\\ncancelled: When a doctor cancel the prescription (*when it was synced with Dosespot we try to cancel it there too*)\n\n# Question Properties\n\nFor more information about questions and how they affect prescriptions, contact us via Slack or send an email to:\\\n[mserota@mdintegrations.com](mailto:mserota@mdintegrations.com) and [jeff@mdintegrations.com](mailto:jeff@mdintegrations.com)\n\nWe are also available through Slack (partner’s channel).\n\nfield\n\ntype\n\ndescription\n\nquestion\n\nstring(255)\\*\n\nQuestion\n\nanswer\n\ntext\\*\n\nAnswer\n\ntype\n\nstring\\*\n\nQuestion type. Available options: boolean, number or string\n\nimportant\n\nboolean\n\nFlag to set a question as important. **Important Note**: This flag is used to identify which questions could affect the final prescription. You could also implement custom logic to set this flag only when specific answers are selected.\n\ndisplay_in_pdf\n\nboolean\n\nFlag to set if this question will be displayed in the case PDF file\n\ndescription\n\ntext\n\nA description for your question\n\nlabel\n\nstring(50)\n\nThe question label\n\nmetadata\n\ntext\n\nA metadata field\n\ndisplayed_options\n\narray\n\nAn array of options that were displayed to the patient\n\nis_critical\n\nboolean\n\nMark question as critical\n\n### Method: POST\n\n{{baseUrl}}/partner/cases\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"hold_status\": **false**,\\\n \"patient_id\": \"a0299125-9d2e-4d73-831f-9f94d5950e86\",\\\n \"metadata\": \"case number 15\",\\\n \"is_chargeable\": **true**,\\\n \"is_additional_approval_needed\": **true**,\\\n \"case_files\": \\[\\],\\\n \"case_offerings\": \\[\\\n {\\\n \"offering_id\": \"dbcc21c5-53d4-4da2-8cf6-7156563a035c\",\\\n \"product\": {\\\n \"dispense_unit\": \"tablet\",\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"quantity\": 4,\\\n \"days_supply\": 2,\\\n \"directions\": \"One per day.\"\\\n }\\\n }\\\n \\],\\\n \"case_questions\": \\[\\\n {\\\n \"question\": \"Are you pregnant?\",\\\n \"answer\": \"false\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **true**,\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #123 for question\",\\\n \"displayed_options\": \\[\\\n \"yes\",\\\n \"no\"\\\n \\]\\\n }\\\n \\],\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\"\\\n }\\\n \\],\\\n \"tags\": \\[\\]\\\n}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"is_additional_approval_needed\": **false**,\\\n \"metadata\": \"case number 15\",\\\n \"patient_exam_id\": **null**,\\\n \"created_at\": \"2021-06-10T16:34:40.000000Z\",\\\n \"is_sync\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"case_id\": \"e02ebf38-147a-419b-bfc8-87e88d29f161\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"created\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-06-17T17:14:59.000000Z\"\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Snow\",\\\n \"email\": \"[johnsnow@doe.com](mailto:johnsnow@doe.com)\",\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"gender\": 1,\\\n \"phone_number\": \"(415) 555-2671\",\\\n \"phone_type\": \"2\",\\\n \"active\": **true**,\\\n \"metadata\": \"patient number 200\",\\\n \"weight\": \"50.000\",\\\n \"height\": 180,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"current_medications\": \"paracetamol\",\\\n \"allergies\": \"polen\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"patient_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"gender_label\": \"Male\",\\\n \"pregnancy\": **false**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"state\": {\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Langworth, Heaney and Mills\",\\\n \"partner_id\": \"b9c80740-cf71-4a34-8523-987edf221f75\",\\\n \"support_message_capability\": \"integrated\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"thank_you_note_header\": \"Header Thank you note example\",\\\n \"thank_you_note_footer\": \"Footer Thank you note example\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"enable_icd_bmi\": **false**,\\\n \"is_auto_dl_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"is_av_flow\": **false**,\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Repellat quisquam sed distinctio sit id et. Unde et doloremque quas ducimus harum perferendis. Officia sapiente velit necessitatibus deleniti. Velit error inventore ut ipsam officia id dolorem.\",\\\n \"created_at\": \"2021-02-03T19:30:18.000000Z\",\\\n \"case_assignment_id\": \"227ed29c-044a-41d7-bb68-caa2e6c5ee63\",\\\n \"clinician\": {\\\n \"first_name\": \"Parisian\",\\\n \"last_name\": \"Schultz\",\\\n \"suffix\": \"M.D\",\\\n \"is_online\": **true**,\\\n \"npi\": \"1598738916\",\\\n \"clinician_id\": \"65e4f8da-e5f7-44b3-a3d4-c9dc74981f4f\",\\\n \"full_name\": \"Seamus Parisian\",\\\n \"specialty\": \"General Practice\",\\\n \"dea\": \"RM1234567\",\\\n \"photo\": {\\\n \"path\": \"clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",\\\n \"name\": \"under_construction.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",](http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"22a03259-b2de-4255-9d2e-48a9dc368633\"\\\n }\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Messages # Messages Source\n\nA message can be sent from the following sources and you can find who sent the message through the user_type parameter.\n\n- **support**: message sent by support;\\\n The user_type will be App\\\\Models\\\\SupportStaff\n\n- **patient**: message sent by the patient;\\\n The user_type will be App\\\\Models\\\\Patient\n\n- **clinician**: message sent by the clinician.\\\n The user_type will be App\\\\Models\\\\Clinician\n\nYou can check the field user_type from the payload response to get who sent the message.\n\n### User object\n\nThe user object is related to the user that sent the message (*user from message*).\n\nThis object is mutable depending on the user_type However, there are some parameters in common, for example:\n\n- [user.id](http://user.id)\n\n- users.first_name\n\n- user.last_name\n\n- [user.email](http://user.email)\n\nNote that many other parameters will change considerably since they are totally different user types.\n\nFor example, a Patient could have a driver_license_id whereas a Clinician or a Support does not.\n\n### Dismissed by object\n\nIt works exactly the same way for the dismissed_by_type dismissed_by_id dismissed_by parameter that is related to the user that dismissed the message.\n\n# Messages Channel\n\nA message can be sent to the following channels:\n\n- **patient**: channel for exchanging messages between patient and clinicians;\n\n- **support**: channel for exchanging messages between support and clinicians.\n\nYou can check the field channel from the payload response to get the corresponding message channel.\n\nMessages originated from patients are automatically sent to **patient** channel while messages from support are automatically sent to **support** channel.\n\n## End-point: Get Messages\n\nGet the patient’s messages (paginated). ### Method: GET >>{{baseUrl}}/partner/patients/:patient/messages?channel=patient > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### Query Params\n\nParam\n\nvalue\n\npage\n\n1\n\nper_page\n\n15\n\nchannel\n\npatient\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"data\": \\[\\\n {\\\n \"id\": \"90e96706-7620-4b3f-b0fc-8f7d520a013b\",\\\n \"patient_id\": \"757479af-30a7-4725-a46a-4a31fb2b813a\",\\\n \"channel\": \"patient\",\\\n \"text\": \"\\*\\*\\*\\*\\*\\\\r\\\\nFor any non-medical questions (such as account questions, billing, shipping, etc.) please reach out to ScoreBlue support directly at: [support@ScoreBlue.com](mailto:support@ScoreBlue.com) as support would be the ones to handle those questions. \\\\r\\\\n\\*\\*\\*\\*\\*\\\\r\\\\n\\\\r\\\\n\\\\r\\\\nHi Mark , I’m Dr. Thomas Bottoni MD , a board certified physician who is licensed in Florida. I’ve reviewed your health information and I think you likely have ED, which can benefit from the following:   Sildenafil 20mg tablets. Start with 1-2 tablets and do not exceed a maximum of 100 mg of sildenafil (5 tablets) per day based on how you respond to treatment.\\\\r\\\\n\\\\r\\\\nThe treatment plan including other important information is below Please make sure you review it, as it will help you decide if the benefits of the plan outweigh the risks.\\\\r\\\\n\\\\r\\\\nDon’t forget that there is always a package insert that comes with your prescription which you should review.\\\\r\\\\n\\\\r\\\\nPlease feel free to contact me here directly if you have any medical questions.\\\\r\\\\n\\\\r\\\\nSincerely,\\\\r\\\\nDr. Thomas Bottoni MD \\\\r\\\\nBoard-certified physician licensed in Florida \\\\r\\\\n\\\\r\\\\nHow to use the medication: Start with two tablets of the medication by mouth for your first time one hour before sex as needed. You may then go up by 1 tablet each future sexual encounter if you feel you need to. DO NOT TAKE MORE THAN FIVE TABLETS AT A TIME OR WITHIN A 24 HOUR PERIOD.\\\\r\\\\n\\\\r\\\\nDo not use this in combination with any illegal drugs. Taking with alcohol may make the medication less effective and increase the chances of side effects such as headache or flushing. Never take erectile dysfunction medication with nitrates for chest pain.\\\\r\\\\n\\\\r\\\\nSIDE EFFECTS: Here's your reference chart - don't panic if you experience these. They're ultra-normal. Most side effects only last as long as the medication is still in the system. That means it's a shorter duration for Viagra, Sildenafil, and Levitra...but longer for Cialis.\\\\r\\\\n \\\\r\\\\nSymptom\\\\t\\\\t\\\\t\\\\tFrequency\\\\r\\\\n\\* Headache 16-28% vs 7% for placebo \\\\r\\\\n\\* Upset stomach 10-29% vs 2% for placebo\\\\r\\\\n\\* Flushing 10-29% vs 2% for placebo\\\\r\\\\n\\* Stuffy nose 4% vs 2% for placebo\\\\r\\\\n\\* Dizziness. 3-4% vs 2% for placebo\\\\r\\\\n\\* Muscle aches 3-4% vs 2% for placebo\\\\r\\\\n\\* Dyspepsia (‘reflux’) 3-17% vs 2% for placebo\\\\r\\\\n\\\\r\\\\nLess common side effects include:\\\\r\\\\n\\* Rash\\\\r\\\\n\\* Abnormal vision (blue tint, blurry vision light sensitivity)\\\\r\\\\n\\\\r\\\\nSevere Side Effects (very uncommon)\\\\r\\\\n\\* Erections that last several hours. Tell your doctor right away if you have an erection that lasts more than 4 hours.\\\\r\\\\n\\* Decreased eyesight or loss of sight in one or both eyes.\\\\r\\\\n\\* Sudden decrease or loss of hearing.\\\\r\\\\n\\* Heart attack, stroke, irregular heartbeats, and death. Most of these happened in people who already had heart problems.\\\\r\\\\n\\* Seizures\\\\r\\\\n\\* Low blood pressure causing dizziness\\\\r\\\\n\\* Allergic reaction\\\\r\\\\n\\* Stevens-Johnson syndrome\\\\r\\\\n\\* Anemia\\\\r\\\\nIf any of these SEVERE side effects occur, seek medical care immediately.\\\\r\\\\n\\\\r\\\\nWe require that you continue to follow up regularly (at least once a year) with your primary care doctor for in person check ups. It is important that you inform them of your ED symptoms and treatment so that they can investigate any additional contributors and optimize treatment for any underlying conditions/triggers which may include: heart disease, atherosclerosis, high cholesterol, high blood pressure, diabetes, obesity, metabolic syndrome, Parkinson’s disease, multiple sclerosis, sleep apnea, prostate disease, other GU diseases, low testosterone, psychological conditions, certain medications, smoking, drug and alcohol use. Please remember to let us know of any changes in your health. If you have any anatomic problems or urology surgeries that could impact erectile dysfunction or if there is any change to your cardiovascular health please always let myself and your primary doctor know as this may impact the treatment recommendations for your ED.\\\\r\\\\n\\\\r\\\\nFOR OTHER HELPFUL INFORMATION INCLUDING ALTERNATIVES TO THERAPY, please read the following:   \\\\r\\\\n\\\\r\\\\nIf you do not have a PCP, please click on the following link: [https://www.google.com/search?q=primary+care+doctor+near+me\",](https://www.google.com/search?q=primary+care+doctor+near+me\\\",)\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"5de2dff4-192c-4b26-bf10-7f65a80161cd\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"dismissed_at\": \"2023-02-20 16:02:08\",\\\n \"dismissed_by_type\": **null**,\\\n \"dismissed_by_id\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-02-06T19:19:58.000000Z\",\\\n \"updated_at\": \"2023-02-20T16:02:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_message_info\": **null**,\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"5de2dff4-192c-4b26-bf10-7f65a80161cd\",\\\n \"first_name\": \"Thomas\",\\\n \"last_name\": \"Bottoni\",\\\n \"suffix\": \"MD\",\\\n \"email\": \"[tnbottoni@gmail.com](mailto:tnbottoni@gmail.com)\",\\\n \"phone_number\": \"6297775752\",\\\n \"phone_type\": \"2\",\\\n \"photo_id\": \"cc7af83d-a5c1-40a9-873a-c1300ed468a2\",\\\n \"active\": **true**,\\\n \"bio_details\": \"I have been a licensed physician since 1994, and Board Certified since 2000. I have trained with and served the US Navy for 21 years, and worked in a variety of settings - academic, urban, and community clincal roles. I have much clinical experience to offer!\",\\\n \"date_of_birth\": \"1966-01-16\",\\\n \"address_id\": \"8d30781a-a673-4176-b69e-57986e27042a\",\\\n \"specialty\": \"M.D.\",\\\n \"fax_number\": \"6502540800\",\\\n \"profile_url\": **null**,\\\n \"signature_id\": \"2ec8bae2-edf1-4f7e-bd5d-6d9994b2b93b\",\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": **null**,\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2022-11-25T15:49:38.000000Z\",\\\n \"updated_at\": \"2023-08-02T23:49:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Thomas Bottoni\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"dismissed_by\": **null**,\\\n \"files\": \\[\\],\\\n \"readings\": \\[\\]\\\n },\\\n {\\\n \"id\": \"f5cb6bdf-8aac-4ed6-900e-bc47aaf6091b\",\\\n \"patient_id\": \"757479af-30a7-4725-a46a-4a31fb2b813a\",\\\n \"channel\": \"patient\",\\\n \"text\": **null**,\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"5de2dff4-192c-4b26-bf10-7f65a80161cd\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"dismissed_at\": \"2023-02-20 16:02:08\",\\\n \"dismissed_by_type\": **null**,\\\n \"dismissed_by_id\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-02-06T19:19:58.000000Z\",\\\n \"updated_at\": \"2023-02-20T16:02:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_message_info\": \"Read\",\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"5de2dff4-192c-4b26-bf10-7f65a80161cd\",\\\n \"first_name\": \"Thomas\",\\\n \"last_name\": \"Bottoni\",\\\n \"suffix\": \"MD\",\\\n \"email\": \"[tnbottoni@gmail.com](mailto:tnbottoni@gmail.com)\",\\\n \"phone_number\": \"6297775752\",\\\n \"phone_type\": \"2\",\\\n \"photo_id\": \"cc7af83d-a5c1-40a9-873a-c1300ed468a2\",\\\n \"active\": **true**,\\\n \"bio_details\": \"I have been a licensed physician since 1994, and Board Certified since 2000. I have trained with and served the US Navy for 21 years, and worked in a variety of settings - academic, urban, and community clincal roles. I have much clinical experience to offer!\",\\\n \"date_of_birth\": \"1966-01-16\",\\\n \"address_id\": \"8d30781a-a673-4176-b69e-57986e27042a\",\\\n \"specialty\": \"M.D.\",\\\n \"fax_number\": \"6502540800\",\\\n \"profile_url\": **null**,\\\n \"signature_id\": \"2ec8bae2-edf1-4f7e-bd5d-6d9994b2b93b\",\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": **null**,\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2022-11-25T15:49:38.000000Z\",\\\n \"updated_at\": \"2023-08-02T23:49:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Thomas Bottoni\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"dismissed_by\": **null**,\\\n \"files\": \\[\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"name\": \"Score Blue - Message from Dr. [Bottoni.mov](http://Bottoni.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"path\": \"partners/[0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov](http://0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov)\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"updated_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\",](http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"message_id\": \"f5cb6bdf-8aac-4ed6-900e-bc47aaf6091b\",\\\n \"created_at\": \"2023-08-22T03:31:41.000000Z\",\\\n \"updated_at\": \"2023-08-22T03:31:41.000000Z\"\\\n }\\\n }\\\n \\],\\\n \"readings\": \\[\\]\\\n },\\\n {\\\n \"id\": \"07e83f83-382c-4cf1-873b-c783bbd64dac\",\\\n \"patient_id\": \"757479af-30a7-4725-a46a-4a31fb2b813a\",\\\n \"channel\": \"patient\",\\\n \"text\": \"Has my order shipped?\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"user_id\": \"757479af-30a7-4725-a46a-4a31fb2b813a\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"dismissed_at\": \"2023-02-08 14:35:15\",\\\n \"dismissed_by_type\": **null**,\\\n \"dismissed_by_id\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-02-08T14:01:27.000000Z\",\\\n \"updated_at\": \"2023-02-08T14:35:15.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_message_info\": \"Read by Me\",\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"757479af-30a7-4725-a46a-4a31fb2b813a\",\\\n \"first_name\": \"Mark\",\\\n \"last_name\": \"Gilliam\",\\\n \"email\": \"[gilliammark08@gmail.com](mailto:gilliammark08@gmail.com)\",\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"gender\": 1,\\\n \"phone_number\": \"4042176932\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"40d4d631-650c-4e32-b7ab-56073ea9c93c\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"No Allergies\",\\\n \"current_medications\": \"No Medications\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"c6b73433-b756-4dd9-9770-4509e94a5e07\",\\\n \"environment_id\": \"5698c890-e79b-4d27-9a92-500dfffb1ae6\",\\\n \"clinician_id\": \"5de2dff4-192c-4b26-bf10-7f65a80161cd\",\\\n \"metadata\": \"e65385d1-a63e-11ed-8b0b-5d0c55836116\",\\\n \"intro_video_file_id\": **null**,\\\n \"created_at\": \"2023-02-06T19:19:01.000000Z\",\\\n \"updated_at\": \"2023-08-25T17:28:04.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Mark Gilliam\",\\\n \"abbreviated_name\": \"Mark G.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**\\\n },\\\n \"dismissed_by\": **null**,\\\n \"files\": \\[\\],\\\n \"readings\": \\[\\]\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"[http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\",](http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\\\",)\\\n \"last\": \"[http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\",](http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\\\",)\\\n \"prev\": **null**,\\\n \"next\": **null**\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 1,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\",](http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": **null**,\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"[http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages\",](http://localhost/api/patients/757479af-30a7-4725-a46a-4a31fb2b813a/messages\\\",)\\\n \"per_page\": 15,\\\n \"to\": 3,\\\n \"total\": 3\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create Message\n\nCreates a patient’s message, and attaches its files.\n\n# Payload\n\n**field**\n\n**type**\n\nchannel\\*\n\nstring\n\ntext\n\nstring\n\nreference_message_id\n\nuuid\n\nfiles\n\narray\n\n# Payload (files)\n\n**field**\n\n**type**\n\nid\\*\n\nuuid\n\n### Method: POST\n\n{{baseUrl}}/partner/patients/:patient/messages\n\n### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### Body (**raw**)\n\n{\\\n \"channel\": \"patient\",\\\n \"text\": \"Message text.\",\\\n \"reference_message_id\": \"ce36bba7-3932-4197-9d92-4565a890edf8\",\\\n \"files\": \\[\\\n {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\"\\\n },\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\"\\\n }\\\n \\]\\\n}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": \"c3f29d8c-0da9-42a9-9eb1-b72ef399a25a\",\\\n \"patient_id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"channel\": \"patient\",\\\n \"text\": \"Message text.\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"reference_message_id\": \"ce36bba7-3932-4197-9d92-4565a890edf8\",\\\n \"reply_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"dismissed_at\": **null**,\\\n \"dismissed_by_type\": **null**,\\\n \"dismissed_by_id\": **null**,\\\n \"emailed_at\": \"2023-08-30T15:11:21.422025Z\",\\\n \"created_at\": \"2023-08-30T15:11:20.000000Z\",\\\n \"updated_at\": \"2023-08-30T15:11:21.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_at\": **null**,\\\n \"user\": {\\\n \"id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"first_name\": \"Guilherme\",\\\n \"last_name\": \"Medeiros\",\\\n \"suffix\": **null**,\\\n \"email\": \"[guilherme+clinician@mdintegrations.com](mailto:guilherme+clinician@mdintegrations.com)\",\\\n \"phone_number\": **null**,\\\n \"phone_type\": **null**,\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"bio_details\": **null**,\\\n \"date_of_birth\": \"1991-12-14\",\\\n \"address_id\": \"4a24e0f4-92d3-4a66-8184-74d8974677ed\",\\\n \"specialty\": **null**,\\\n \"fax_number\": **null**,\\\n \"profile_url\": **null**,\\\n \"signature_id\": **null**,\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": \"58d6f0c5-6bae-4682-b12b-00c98b9b5fa5\",\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2023-02-15T12:27:03.000000Z\",\\\n \"updated_at\": \"2023-08-30T14:39:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Guilherme Medeiros\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"patient\": {\\\n \"id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"first_name\": \"Joseph\",\\\n \"last_name\": \"Alaban\",\\\n \"email\": \"[joealaban65@gmail.com](mailto:joealaban65@gmail.com)\",\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"gender\": 1,\\\n \"phone_number\": \"4086554410\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"6e40f8e5-9238-4886-83cc-ef2f59964d29\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"No Allergies\",\\\n \"current_medications\": \"No Medications\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"c6b73433-b756-4dd9-9770-4509e94a5e07\",\\\n \"environment_id\": \"5698c890-e79b-4d27-9a92-500dfffb1ae6\",\\\n \"clinician_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"metadata\": \"f3e78a40-64fb-11ed-8339-6577e8df5042\",\\\n \"intro_video_file_id\": **null**,\\\n \"created_at\": \"2023-01-12T00:42:48.000000Z\",\\\n \"updated_at\": \"2023-08-25T17:39:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Joseph Alaban\",\\\n \"abbreviated_name\": \"Joseph A.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**\\\n },\\\n \"readings\": \\[\\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Message\n\nGet the patient’s message details. ### Method: GET >>{{baseUrl}}/partner/patients/:patient/messages/:message > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"patient_id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"channel\": \"patient\",\\\n \"text\": **null**,\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": \"8dfe4a90-26e1-47b3-9016-fa31301f2bb5\",\\\n \"replied_at\": \"2023-08-30 04:01:30\",\\\n \"dismissed_at\": \"2023-08-29 12:14:10\",\\\n \"dismissed_by_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"dismissed_by_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-01-12T03:11:54.000000Z\",\\\n \"updated_at\": \"2023-08-30T04:01:30.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_at\": \"2023-08-30 03:45:41\",\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"first_name\": \"Maura\",\\\n \"last_name\": \"Holcomb\",\\\n \"suffix\": \"MD\",\\\n \"email\": \"[mauraholcomb@gmail.com](mailto:mauraholcomb@gmail.com)\",\\\n \"phone_number\": \"6297775752\",\\\n \"phone_type\": \"2\",\\\n \"photo_id\": \"4ba765cd-c5d6-4818-91f5-070ac7794f2f\",\\\n \"active\": **true**,\\\n \"bio_details\": \"Maura J. Holcomb, M.D. is the author of more than 60 papers on clinical interests that include psoriasis, acne, melanoma, tropical dermatology, and photosensitive skin disorders. Her work has been published in the International Journal of Dermatology, Dermatology Online Journal, Journal of Cutaneous Pathology, and other dermatological publications, including numerous Continuing Medical Education articles for [ClinicalAdvisor.com](http://ClinicalAdvisor.com)’s Dermatology Clinic. Dr. Holcomb has also collaborated on several presentations of dermatological research at conferences of the Texas Dermatological Society, American Society of \\\\r\\\\n dermatopathology, and American Academy of Dermatology.\\\\r\\\\n\\\\r\\\\nA native Texan, Dr. Holcomb graduated at the top of her high school class in East Texas before attending Texas A&M University, where she graduated magna cum laude, obtaining degrees in\\\\r\\\\nboth biology and psychology. \\\\r\\\\n\\\\r\\\\nDr. Holcomb received her M.D. from Baylor College of Medicine on a full scholarship. She completed her medical internship at The Methodist Hospital in Houston and her dermatology residency at Baylor. She conducted clinical research at the Department of Dermatology at The University of Texas M.D. Anderson Cancer Center, Houston, and received the Debra Chester Kalter Award for Outstanding Student Research in Dermatology. Graduating in the top 10% of her class, she was elected into the Alpha Omega Alpha Medical Honor Society.\\\\r\\\\n\\\\r\\\\nDuring medical school, Dr. Holcomb spent two months volunteering at a leprosy hospital in Nepal. In her spare time, she enjoys hiking, running, camping, travelling off the beaten path, and scuba diving.\",\\\n \"date_of_birth\": \"1985-07-25\",\\\n \"address_id\": \"5a179d19-d096-4179-8b2a-c80383b53014\",\\\n \"specialty\": \"M.D.\",\\\n \"fax_number\": \"6502540800\",\\\n \"profile_url\": **null**,\\\n \"signature_id\": \"4081ef1e-dbb2-4016-b9ad-d517dbe6e449\",\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": **null**,\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2022-06-25T15:06:23.000000Z\",\\\n \"updated_at\": \"2023-08-02T23:49:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Maura Holcomb\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**,\\\n \"photo\": {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54_Pro.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n },\\\n \"dismissed_by\": {\\\n \"id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"first_name\": \"Guilherme\",\\\n \"last_name\": \"Medeiros\",\\\n \"suffix\": **null**,\\\n \"email\": \"[guilherme+clinician@mdintegrations.com](mailto:guilherme+clinician@mdintegrations.com)\",\\\n \"phone_number\": **null**,\\\n \"phone_type\": **null**,\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"bio_details\": **null**,\\\n \"date_of_birth\": \"1991-12-14\",\\\n \"address_id\": \"4a24e0f4-92d3-4a66-8184-74d8974677ed\",\\\n \"specialty\": **null**,\\\n \"fax_number\": **null**,\\\n \"profile_url\": **null**,\\\n \"signature_id\": **null**,\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": \"58d6f0c5-6bae-4682-b12b-00c98b9b5fa5\",\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2023-02-15T12:27:03.000000Z\",\\\n \"updated_at\": \"2023-08-30T14:39:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Guilherme Medeiros\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"files\": \\[\\\n {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54\\_[Pro.mp](http://Pro.mp)4\",\\\n \"mime_type\": \"video/mp4\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\",](http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-22T03:31:09.000000Z\",\\\n \"updated_at\": \"2023-08-22T03:31:09.000000Z\"\\\n }\\\n },\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"name\": \"Score Blue - Message from Dr. [Bottoni.mov](http://Bottoni.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"path\": \"partners/[0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov](http://0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov)\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"updated_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\",](http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-29T15:15:26.000000Z\",\\\n \"updated_at\": \"2023-08-29T15:15:26.000000Z\"\\\n }\\\n }\\\n \\],\\\n \"patient\": {\\\n \"id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"first_name\": \"Joseph\",\\\n \"last_name\": \"Alaban\",\\\n \"email\": \"[joealaban65@gmail.com](mailto:joealaban65@gmail.com)\",\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"gender\": 1,\\\n \"phone_number\": \"4086554410\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"6e40f8e5-9238-4886-83cc-ef2f59964d29\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"No Allergies\",\\\n \"current_medications\": \"No Medications\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"c6b73433-b756-4dd9-9770-4509e94a5e07\",\\\n \"environment_id\": \"5698c890-e79b-4d27-9a92-500dfffb1ae6\",\\\n \"clinician_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"metadata\": \"f3e78a40-64fb-11ed-8339-6577e8df5042\",\\\n \"intro_video_file_id\": **null**,\\\n \"created_at\": \"2023-01-12T00:42:48.000000Z\",\\\n \"updated_at\": \"2023-08-25T17:39:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Joseph Alaban\",\\\n \"abbreviated_name\": \"Joseph A.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**\\\n },\\\n \"readings\": \\[\\\n {\\\n \"id\": \"a9b1c2f4-5409-4da6-822d-9ac8ec1dec66\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"created_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"updated_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Read Message\n\nReads the patient’s message. ### Method: POST >>{{baseUrl}}/partner/patients/:patient/messages/:message/read > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"patient_id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"channel\": \"patient\",\\\n \"text\": **null**,\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": \"8dfe4a90-26e1-47b3-9016-fa31301f2bb5\",\\\n \"replied_at\": \"2023-08-30 04:01:30\",\\\n \"dismissed_at\": \"2023-08-29 12:14:10\",\\\n \"dismissed_by_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"dismissed_by_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-01-12T03:11:54.000000Z\",\\\n \"updated_at\": \"2023-08-30T04:01:30.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_at\": \"2023-08-30 03:45:41\",\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"first_name\": \"Maura\",\\\n \"last_name\": \"Holcomb\",\\\n \"suffix\": \"MD\",\\\n \"email\": \"[mauraholcomb@gmail.com](mailto:mauraholcomb@gmail.com)\",\\\n \"phone_number\": \"6297775752\",\\\n \"phone_type\": \"2\",\\\n \"photo_id\": \"4ba765cd-c5d6-4818-91f5-070ac7794f2f\",\\\n \"active\": **true**,\\\n \"bio_details\": \"Maura J. Holcomb, M.D. is the author of more than 60 papers on clinical interests that include psoriasis, acne, melanoma, tropical dermatology, and photosensitive skin disorders. Her work has been published in the International Journal of Dermatology, Dermatology Online Journal, Journal of Cutaneous Pathology, and other dermatological publications, including numerous Continuing Medical Education articles for [ClinicalAdvisor.com](http://ClinicalAdvisor.com)’s Dermatology Clinic. Dr. Holcomb has also collaborated on several presentations of dermatological research at conferences of the Texas Dermatological Society, American Society of \\\\r\\\\n dermatopathology, and American Academy of Dermatology.\\\\r\\\\n\\\\r\\\\nA native Texan, Dr. Holcomb graduated at the top of her high school class in East Texas before attending Texas A&M University, where she graduated magna cum laude, obtaining degrees in\\\\r\\\\nboth biology and psychology. \\\\r\\\\n\\\\r\\\\nDr. Holcomb received her M.D. from Baylor College of Medicine on a full scholarship. She completed her medical internship at The Methodist Hospital in Houston and her dermatology residency at Baylor. She conducted clinical research at the Department of Dermatology at The University of Texas M.D. Anderson Cancer Center, Houston, and received the Debra Chester Kalter Award for Outstanding Student Research in Dermatology. Graduating in the top 10% of her class, she was elected into the Alpha Omega Alpha Medical Honor Society.\\\\r\\\\n\\\\r\\\\nDuring medical school, Dr. Holcomb spent two months volunteering at a leprosy hospital in Nepal. In her spare time, she enjoys hiking, running, camping, travelling off the beaten path, and scuba diving.\",\\\n \"date_of_birth\": \"1985-07-25\",\\\n \"address_id\": \"5a179d19-d096-4179-8b2a-c80383b53014\",\\\n \"specialty\": \"M.D.\",\\\n \"fax_number\": \"6502540800\",\\\n \"profile_url\": **null**,\\\n \"signature_id\": \"4081ef1e-dbb2-4016-b9ad-d517dbe6e449\",\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": **null**,\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2022-06-25T15:06:23.000000Z\",\\\n \"updated_at\": \"2023-08-02T23:49:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Maura Holcomb\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**,\\\n \"photo\": {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54_Pro.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n },\\\n \"dismissed_by\": {\\\n \"id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"first_name\": \"Guilherme\",\\\n \"last_name\": \"Medeiros\",\\\n \"suffix\": **null**,\\\n \"email\": \"[guilherme+clinician@mdintegrations.com](mailto:guilherme+clinician@mdintegrations.com)\",\\\n \"phone_number\": **null**,\\\n \"phone_type\": **null**,\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"bio_details\": **null**,\\\n \"date_of_birth\": \"1991-12-14\",\\\n \"address_id\": \"4a24e0f4-92d3-4a66-8184-74d8974677ed\",\\\n \"specialty\": **null**,\\\n \"fax_number\": **null**,\\\n \"profile_url\": **null**,\\\n \"signature_id\": **null**,\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": \"58d6f0c5-6bae-4682-b12b-00c98b9b5fa5\",\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2023-02-15T12:27:03.000000Z\",\\\n \"updated_at\": \"2023-08-30T14:39:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Guilherme Medeiros\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"files\": \\[\\\n {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54\\_[Pro.mp](http://Pro.mp)4\",\\\n \"mime_type\": \"video/mp4\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\",](http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-22T03:31:09.000000Z\",\\\n \"updated_at\": \"2023-08-22T03:31:09.000000Z\"\\\n }\\\n },\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"name\": \"Score Blue - Message from Dr. [Bottoni.mov](http://Bottoni.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"path\": \"partners/[0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov](http://0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov)\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"updated_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\",](http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-29T15:15:26.000000Z\",\\\n \"updated_at\": \"2023-08-29T15:15:26.000000Z\"\\\n }\\\n }\\\n \\],\\\n \"patient\": {\\\n \"id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"first_name\": \"Joseph\",\\\n \"last_name\": \"Alaban\",\\\n \"email\": \"[joealaban65@gmail.com](mailto:joealaban65@gmail.com)\",\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"gender\": 1,\\\n \"phone_number\": \"4086554410\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"6e40f8e5-9238-4886-83cc-ef2f59964d29\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"No Allergies\",\\\n \"current_medications\": \"No Medications\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"c6b73433-b756-4dd9-9770-4509e94a5e07\",\\\n \"environment_id\": \"5698c890-e79b-4d27-9a92-500dfffb1ae6\",\\\n \"clinician_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"metadata\": \"f3e78a40-64fb-11ed-8339-6577e8df5042\",\\\n \"intro_video_file_id\": **null**,\\\n \"created_at\": \"2023-01-12T00:42:48.000000Z\",\\\n \"updated_at\": \"2023-08-25T17:39:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Joseph Alaban\",\\\n \"abbreviated_name\": \"Joseph A.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**\\\n },\\\n \"readings\": \\[\\\n {\\\n \"id\": \"a9b1c2f4-5409-4da6-822d-9ac8ec1dec66\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"created_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"updated_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Unread Message\n\nReads the patient’s message. ### Method: DELETE >>{{baseUrl}}/partner/patients/:patient/messages/:message/unread > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"patient_id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"channel\": \"patient\",\\\n \"text\": **null**,\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"reference_message_id\": **null**,\\\n \"reply_message_id\": \"8dfe4a90-26e1-47b3-9016-fa31301f2bb5\",\\\n \"replied_at\": \"2023-08-30 04:01:30\",\\\n \"dismissed_at\": \"2023-08-29 12:14:10\",\\\n \"dismissed_by_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"dismissed_by_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2023-01-12T03:11:54.000000Z\",\\\n \"updated_at\": \"2023-08-30T04:01:30.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_at\": **null**,\\\n \"reference_message\": **null**,\\\n \"user\": {\\\n \"id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"first_name\": \"Maura\",\\\n \"last_name\": \"Holcomb\",\\\n \"suffix\": \"MD\",\\\n \"email\": \"[mauraholcomb@gmail.com](mailto:mauraholcomb@gmail.com)\",\\\n \"phone_number\": \"6297775752\",\\\n \"phone_type\": \"2\",\\\n \"photo_id\": \"4ba765cd-c5d6-4818-91f5-070ac7794f2f\",\\\n \"active\": **true**,\\\n \"bio_details\": \"Maura J. Holcomb, M.D. is the author of more than 60 papers on clinical interests that include psoriasis, acne, melanoma, tropical dermatology, and photosensitive skin disorders. Her work has been published in the International Journal of Dermatology, Dermatology Online Journal, Journal of Cutaneous Pathology, and other dermatological publications, including numerous Continuing Medical Education articles for [ClinicalAdvisor.com](http://ClinicalAdvisor.com)’s Dermatology Clinic. Dr. Holcomb has also collaborated on several presentations of dermatological research at conferences of the Texas Dermatological Society, American Society of \\\\r\\\\n dermatopathology, and American Academy of Dermatology.\\\\r\\\\n\\\\r\\\\nA native Texan, Dr. Holcomb graduated at the top of her high school class in East Texas before attending Texas A&M University, where she graduated magna cum laude, obtaining degrees in\\\\r\\\\nboth biology and psychology. \\\\r\\\\n\\\\r\\\\nDr. Holcomb received her M.D. from Baylor College of Medicine on a full scholarship. She completed her medical internship at The Methodist Hospital in Houston and her dermatology residency at Baylor. She conducted clinical research at the Department of Dermatology at The University of Texas M.D. Anderson Cancer Center, Houston, and received the Debra Chester Kalter Award for Outstanding Student Research in Dermatology. Graduating in the top 10% of her class, she was elected into the Alpha Omega Alpha Medical Honor Society.\\\\r\\\\n\\\\r\\\\nDuring medical school, Dr. Holcomb spent two months volunteering at a leprosy hospital in Nepal. In her spare time, she enjoys hiking, running, camping, travelling off the beaten path, and scuba diving.\",\\\n \"date_of_birth\": \"1985-07-25\",\\\n \"address_id\": \"5a179d19-d096-4179-8b2a-c80383b53014\",\\\n \"specialty\": \"M.D.\",\\\n \"fax_number\": \"6502540800\",\\\n \"profile_url\": **null**,\\\n \"signature_id\": \"4081ef1e-dbb2-4016-b9ad-d517dbe6e449\",\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": **null**,\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2022-06-25T15:06:23.000000Z\",\\\n \"updated_at\": \"2023-08-02T23:49:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Maura Holcomb\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**,\\\n \"photo\": {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54_Pro.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n },\\\n \"dismissed_by\": {\\\n \"id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"first_name\": \"Guilherme\",\\\n \"last_name\": \"Medeiros\",\\\n \"suffix\": **null**,\\\n \"email\": \"[guilherme+clinician@mdintegrations.com](mailto:guilherme+clinician@mdintegrations.com)\",\\\n \"phone_number\": **null**,\\\n \"phone_type\": **null**,\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"bio_details\": **null**,\\\n \"date_of_birth\": \"1991-12-14\",\\\n \"address_id\": \"4a24e0f4-92d3-4a66-8184-74d8974677ed\",\\\n \"specialty\": **null**,\\\n \"fax_number\": **null**,\\\n \"profile_url\": **null**,\\\n \"signature_id\": **null**,\\\n \"case_assignment_availability\": **true**,\\\n \"timezone_id\": \"c45fe33d-ec45-49b6-9d08-599ad41946e5\",\\\n \"passcode_id\": \"58d6f0c5-6bae-4682-b12b-00c98b9b5fa5\",\\\n \"is_out_of_office\": **false**,\\\n \"out_of_office_message\": **null**,\\\n \"automatic_sync_message\": **null**,\\\n \"managed_by_partner\": **false**,\\\n \"created_at\": \"2023-02-15T12:27:03.000000Z\",\\\n \"updated_at\": \"2023-08-30T14:39:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Guilherme Medeiros\",\\\n \"is_online\": **false**,\\\n \"priority\": **null**\\\n },\\\n \"files\": \\[\\\n {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"name\": \"scorebluefinalWIN_20230104_15_26_54\\_[Pro.mp](http://Pro.mp)4\",\\\n \"mime_type\": \"video/mp4\",\\\n \"path\": \"partners/[R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp](http://R28YbL4PnDKM4pArMo5jdfejUyRyeGpbRxi0RZo6.mp)4\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"updated_at\": \"2023-01-04T14:29:06.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\",](http://localhost:8000/s3/files/e30e5ecb-a543-4877-a483-0a1b065bbc59/file?signature=2680e583bada539d176ed154c3901ce0d18ff90f5652e0ecf419595706ff0a77\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-22T03:31:09.000000Z\",\\\n \"updated_at\": \"2023-08-22T03:31:09.000000Z\"\\\n }\\\n },\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"name\": \"Score Blue - Message from Dr. [Bottoni.mov](http://Bottoni.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"path\": \"partners/[0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov](http://0Wzb1mI0XZsJ5pwyw86M5TcCAja7WeDRjElAnVf6.mov)\",\\\n \"thumbnail_path\": **null**,\\\n \"created_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"updated_at\": \"2023-01-03T01:02:27.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\",](http://localhost:8000/s3/files/3f7b155c-c235-476c-9688-3fa7c1d59ed2/file?signature=438d650b10cdf7186eabc888ed71506d68099b6d7bea520c7809a405a5c29fdb\\\",)\\\n \"thumbnail_url\": **null**,\\\n \"pivot\": {\\\n \"file_id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"created_at\": \"2023-08-29T15:15:26.000000Z\",\\\n \"updated_at\": \"2023-08-29T15:15:26.000000Z\"\\\n }\\\n }\\\n \\],\\\n \"patient\": {\\\n \"id\": \"8e1cb3f5-23ae-465b-9f5d-929b11f97e98\",\\\n \"first_name\": \"Joseph\",\\\n \"last_name\": \"Alaban\",\\\n \"email\": \"[joealaban65@gmail.com](mailto:joealaban65@gmail.com)\",\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"gender\": 1,\\\n \"phone_number\": \"4086554410\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"6e40f8e5-9238-4886-83cc-ef2f59964d29\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"No Allergies\",\\\n \"current_medications\": \"No Medications\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"c6b73433-b756-4dd9-9770-4509e94a5e07\",\\\n \"environment_id\": \"5698c890-e79b-4d27-9a92-500dfffb1ae6\",\\\n \"clinician_id\": \"4c79229f-cfa1-4808-b97b-f270489d8a99\",\\\n \"metadata\": \"f3e78a40-64fb-11ed-8339-6577e8df5042\",\\\n \"intro_video_file_id\": **null**,\\\n \"created_at\": \"2023-01-12T00:42:48.000000Z\",\\\n \"updated_at\": \"2023-08-25T17:39:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"Joseph Alaban\",\\\n \"abbreviated_name\": \"Joseph A.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**\\\n },\\\n \"readings\": \\[\\\n {\\\n \"id\": \"a9b1c2f4-5409-4da6-822d-9ac8ec1dec66\",\\\n \"message_id\": \"0682c481-dd31-4047-a5ae-38c35ff216ea\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Clinician\",\\\n \"user_id\": \"cbd247ab-65e9-433f-a1a3-21558299d973\",\\\n \"created_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"updated_at\": \"2023-08-30T03:45:41.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Preferred Pharmacies undefined\n\n## End-point: Add pharmacy to patient\n\nAdds a pharmacy to a patient’s preferred pharmacies list.\n\nTo check a list of available pharmacies to be added to the patient, check **Partners > Pharmacies**. ### Method: POST >>{{baseUrl}}/partner/patients/:patientId/pharmacies/:pharmacyId > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: 200\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get pharmacies from patient\n\nRetrieves a detailed list of preferred pharmacies in the patient’s record. This API endpoint forwards the request to DoseSpot API in order to retrieve this information. ### Method: GET >>{{baseUrl}}/partner/patients/:patientId/pharmacies?sort=updated_at&order=desc > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nsort\n\nupdated_at\n\norder\n\ndesc\n\n### Response: 200\n\n\\[\\\n {\\\n \"patient_id\": \"3afc17cd-19b9-4074-bada-4b6c1641cb4a\",\\\n \"pharmacy_id\": 13012,\\\n \"name\": \"Curexa\",\\\n \"address1\": \"3007 Ocean Heights Ave.\",\\\n \"address2\": \"\",\\\n \"city\": \"Egg Harbor Township\",\\\n \"state\": \"NJ\",\\\n \"zip_code\": \"08234\",\\\n \"primary_phone\": \"6099270390\",\\\n \"primary_phone_type\": \"5\",\\\n \"primary_fax\": \"8559270392\",\\\n \"enabled\": **true**,\\\n \"id\": 13012,\\\n \"phone_additional_1\": **null**,\\\n \"phone_additional_type_1\": 0,\\\n \"phone_additional_2\": **null**,\\\n \"phone_additional_type_2\": 0,\\\n \"phone_additional_3\": **null**,\\\n \"phone_additional_type_3\": 0,\\\n \"pharmacy_specialties\": \\[\\],\\\n \"service_level\": **null**,\\\n \"latitude\": **null**,\\\n \"longitude\": **null**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Remove pharmacy from patient\n\nRemoves a pharmacy from a patient’s preferred pharmacies list. This API endpoint forwards the request to DoseSpot API in order to remove patient’s pharmacies.\n\nThis does not change any existing medications in that patient’s record even if they are queued up or already sent to that pharmacy. ### Method: DELETE >>{{baseUrl}}/partner/patients/:patientId/pharmacies/:pharmacyId > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: 2FA undefined\n\n## End-point: Send one-time password\n\nIf patient exists with the email informed then we send a verification code to the patient email.\n\n**param**\n\n**type**\n\n**description**\n\nemail\n\nstring\\*\n\nPatient’s email\n\n### Method: POST\n\n{{baseUrl}}/partner/patients/auth/2fa\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"email\": \"[patient@email.com](mailto:patient@email.com)\"\\\n}\n\n### Response: undefined\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Validate verification code\n\nThis endpoint validates the verification code sent to the patient’s email.\n\nIf the code is validated then we return the patient object. ### Method: POST >>{{baseUrl}}/partner/patients/auth/2fa/validate > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"email\": \"[patient@email.com](mailto:patient@email.com)\",\\\n \"verification_code\": \"A5B89JA\"\\\n}\n\n### Response: undefined\n\n{\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"prefix\": \"Sr\",\\\n \"ssn\": \"111-22-3333\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"metadata\": \"patient number 200\",\\\n \"gender\": 1,\\\n \"phone_number\": \"541-754-3010\",\\\n \"phone_type\": 2,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"active\": **true**,\\\n \"weight\": 50,\\\n \"height\": 180,\\\n \"is_live\": **true**,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"patient_id\": \"99f7520d-7c8b-4a81-8957-e0bc139f40c5\",\\\n \"gender_label\": \"Male\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"pregnancy\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"12345\",\\\n \"city_name\": \"Tazlina\",\\\n \"address_id\": \"eabbd96b-5704-4539-8c16-27b35f93fa06\",\\\n \"state\": {\\\n \"name\": \"Alaska\",\\\n \"abbreviation\": \"AK\",\\\n \"state_id\": \"06ed58ad-bf9c-4397-8795-5bd85a692a51\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"is_av_flow\": **false**\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"support_messaging_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"enable_av_flow\": **true**,\\\n \"business_model\": \"regular\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Workflows undefined\n\n## End-point: Get Drivers License Request URL\n\nGet URL for Drivers License Request workflow.\n\nYou may find additional details on embedding and auto-login [here](https://docs.google.com/document/d/1pyhggn24iVtOh-hMUCj0ruifb9BhBHjcuXN9GFf-5Hg/edit#bookmark=id.gsqmc6qvlyo6). ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/drivers-license?fullscreen=true > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nfullscreen\n\ntrue\n\n### Response: 200\n\n{\\\n \"drivers_license_url\": \"[https://patient.mdintegrations.com/av/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\",](https://patient.mdintegrations.com/av/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\\\",)\\\n \"verification_code\": \"R2SZTX\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Messaging App URL\n\nGet Messaging App auth link URL.\n\nYou may find additional details on embedding and auto-login [here](https://docs.google.com/document/d/1pyhggn24iVtOh-hMUCj0ruifb9BhBHjcuXN9GFf-5Hg/edit#bookmark=id.gsqmc6qvlyo6). ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/auth?case_id=8760bc4b-9156-4b9g-a96f-d3eeafb2l827&full=true&fullscreen=true > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\ncase_id\n\n8760bc4b-9156-4b9g-a96f-d3eeafb2l827\n\nfull\n\ntrue\n\nfullscreen\n\ntrue\n\n### Response: 200\n\n{\\\n \"auth_link\": \"[https://message.mdintegrations.com/messages/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?case_id=d1a245ea-595b-40bd-9645-cdfa71ab4fa2&full=true&fullscreen=true\",](https://message.mdintegrations.com/messages/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?case_id=d1a245ea-595b-40bd-9645-cdfa71ab4fa2&full=true&fullscreen=true\\\",)\\\n \"verification_code\": \"R2SZTX\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Intro Video Request URL\n\nGet URL for Intro Video Request workflow.\n\nYou may find additional details on embedding and auto-login [here](https://docs.google.com/document/d/1pyhggn24iVtOh-hMUCj0ruifb9BhBHjcuXN9GFf-5Hg/edit#bookmark=id.gsqmc6qvlyo6). ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/intro-video?fullscreen=true > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nfullscreen\n\ntrue\n\n### Response: 200\n\n{\\\n \"intro_video_url\": \"[https://patient.mdintegrations.com/av/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\",](https://patient.mdintegrations.com/av/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\\\",)\\\n \"verification_code\": \"R2SZTX\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get File Request URL\n\nGet URL for File Request workflow.\n\nYou may find additional details on embedding and auto-login [here](https://docs.google.com/document/d/1pyhggn24iVtOh-hMUCj0ruifb9BhBHjcuXN9GFf-5Hg/edit#bookmark=id.gsqmc6qvlyo6). ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/file-url?fullscreen=true > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nfullscreen\n\ntrue\n\n### Response: 200\n\n{\\\n \"file_url\": \"[https://patient.mdintegrations.com/file/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\",](https://patient.mdintegrations.com/file/eyJwYXRpZW50X2VtYWlsIjoiZGV2K3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwicGFydG5lcl9pZCI6IjMzNzc4ZGIzLTg3MDctNDYyOC04MWFmLTRjNjQ1MWY5ZjBiNiIsInBhdGllbnRfaWQiOiJhNWMxZWI0Yi1mZjA0LTQxOTctYjY2Ni1kYzAxZWJjYTZjMmQifQ==?fullscreen=true\\\",)\\\n \"verification_code\": \"R2SZTX\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Request Patient Data\n\nSends the patient data requested to the patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\npatient_id\n\nuuid\n\nRequired if not use the patient email to request their data.\n\npatient_email\n\nstring\n\nRequired if the patient_id is empty.\n\n### Method: POST\n\n{{baseUrl}}/partner/patients/data\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"patient_id\": \"d12bf2f6-4dad-4723-94c7-1676fd9026c1\",\\\n \"patient_email\": \"[patient@email.com](mailto:patient@email.com)\"\\\n}\n\n### Response: undefined\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Request Patient Data Deletion\n\nPatient data deletion request.\n\nWe send an email to the patient to confirm the deletion request. Once confirmed we deactivate the patient on MD Integrations application. ### Method: DELETE >>{{baseUrl}}/partner/patients/:patient_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Exams undefined\n\n## End-point: Get patient exam\n\nThis endpoint returns the patient’s exam detail. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/exams/:exam_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"id\": \"8cc8e948-1578-409b-9e18-0a771d349355\",\\\n \"patient_id\": \"5c791d01-2ae5-4e44-bf4f-900dfc1ba325\",\\\n \"height\": 155,\\\n \"weight\": **null**,\\\n \"medications\": \"paracetamol\",\\\n \"medical_conditions\": \"a medical condition example\",\\\n \"allergies\": \"polen\",\\\n \"created_at\": \"2023-12-05T14:34:59.000000Z\",\\\n \"updated_at\": \"2023-12-05T14:34:59.000000Z\",\\\n \"deleted_at\": **null**\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get patient exams\n\nThis endpoint returns all exams related to the patient passed on the request. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/exams > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"data\": \\[\\\n {\\\n \"id\": \"5108306f-a44c-484c-8146-19c8eb8e98b6\",\\\n \"patient_id\": \"690b092b-b472-4770-8d69-8392585aa089\",\\\n \"height\": 155,\\\n \"weight\": 90,\\\n \"medications\": \"3 capsules paracetamol\",\\\n \"medical_conditions\": \"a medical condition example\",\\\n \"allergies\": \"polen, nuts\",\\\n \"created_at\": \"2023-12-05T12:50:54.000000Z\",\\\n \"updated_at\": \"2023-12-05T12:50:54.000000Z\",\\\n \"deleted_at\": **null**\\\n },\\\n {\\\n \"id\": \"befc02aa-118b-4e7b-9d1b-0e56400a7e8e\",\\\n \"patient_id\": \"690b092b-b472-4770-8d69-8392585aa089\",\\\n \"height\": 155,\\\n \"weight\": **null**,\\\n \"medications\": \"paracetamol\",\\\n \"medical_conditions\": **null**,\\\n \"allergies\": \"polen\",\\\n \"created_at\": \"2023-12-05T14:34:59.000000Z\",\\\n \"updated_at\": \"2023-12-05T14:34:59.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"[http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\",](http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\\\",)\\\n \"last\": \"[http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\",](http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\\\",)\\\n \"prev\": **null**,\\\n \"next\": **null**\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 1,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\",](http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": **null**,\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"[http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams\",](http://localhost/api/patients/690b092b-b472-4770-8d69-8392585aa089/exams\\\",)\\\n \"per_page\": 15,\\\n \"to\": 2,\\\n \"total\": 2\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Vouchers undefined\n\n## End-point: Get patient vouchers\n\nThis endpoint returns all exams related to the patient passed on the request. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/vouchers > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"data\": \\[\\\n {\\\n \"id\": \"15242cfd-5d6b-47cf-b1db-1d564cadc160\",\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"case_id\": **null**,\\\n \"partner_questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"environment_id\": \"38da4bf4-3843-4cc3-83d1-13130daffdbd\",\\\n \"expires_at\": \"2024-05-18T21:18:24.000000Z\",\\\n \"payload\": {\\\n \"hold_status\": **true**,\\\n \"environment_id\": \"74fa173c-9455-4e79-88e7-b1a668e83274\",\\\n \"questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI2Zjc5YWI3YS1hOTkwLTQ3YzYtOWExNy1kNWE2YjE2MzZlYTIiLCJqdGkiOiJjYTlkMjk5Nzc4YWRjMjQwZGNjODdhYjQ1M2JkMmU0Y2U1ZTAwZDYwYzZhZmNjYmY5Nzc5YzFkODJiNWE4ZWM5OTM3MzA2ZmYzNzAwY2Y2OCIsImlhdCI6MTcxODI4NjUwMi43NTY2MzUsIm5iZiI6MTcxODI4NjUwMi43NTY2MzYsImV4cCI6MTcxODM3MjkwMi43NTMyNjIsInN1YiI6ImFmZTZjYjdlLWYyMWUtNGM5Mi1iZmE2LTM5YThiMjRjMzM3NiIsInNjb3BlcyI6WyIqIl19.KeTDwpIyIhocEzYUkaOd_vbJQamntDebQfD32UElqwDAvelcx81YOWtKfKupgoijPrAKfcRers3RgB0bDwFngZtOPopC7cZmxjp7YERvtCk7HcVtq36K0CYxlnef5pxtruX3UopxD4DCbAOsCNOhoaihcU9JLFuIAwMGI9ER8ejcg_pchNcq2PDqlOQRL2EjIsCxWwGcLnDRhRKgJSUK4n8dgHQiZQyc7RV0-mLkr10sgBQj6yrb9nenOMdKWTyk9wOUPFdroVS5rw2Xebe5groZMI_GWv1FFe5N48aqMtW2AqH8WzXg9J5Zchz2kn1odbSKYxjxmsLyU6VfP5Dk6dIlYh17zLOsLLprqMfrcMhqleDtGqrnOAveULULQn-kOtzsQyE8RX_Q8rvquxrgpCT3qV028AfGbPoMCeYq6tW_CEoQ4G6moWiyUsQgV7d2r7P_S6TLL3dsmE6HvjoJTvg8zkN3fs5zThMbspixyWl90vEHfah8GnQC8jGOUZzraMcoaV_f-Sp51_WbBQGn3rfgka1ziw_8EdUBVyDrDYTPgsBzSqtumtipt_Xq7QPmfJ8f7VEnjmViZXMWyoeLnIlPI_0KEW7Ku2j18AlDMp2-7iTiORsBg8n0pfsn0ob4bifp-OsIlPA7zFhRs2H9LC50hK4nYv4l6U6MhlVVPgQ\",\\\n \"refresh_token\": \"def50200269767d554011f02175ac54711ad2e014ad803a60effc5cfae3d61f2e7b9626cc8797ec3f865f6a984e034dfeb2c8ee1213b7a62681dba981246bc4813a27751e0760a578e599a47ce47f4ac06d118a2c73f8ad95d56a678a9f09294a4880aacdaaff9f0f64eabf75544d44c0fb9039c81c1aabbd24b70420dc743010ff2c18c359162cb7383a6e8c8e3b5fc226fbebcf0e6b4d9a933e85b291c6bf62e6d158cb55269ba33d8cd6be054df6921c0abd13c2c8929a28ea081165bfa50e4126e96f91573de205d746d566aae159ca5f4824606489d0a592fc6a5ed2068dbc93601a8b49135281baa40e5f1bc19ceed1aab574be480525129dffdc1a293b22b42d3542e369051745cc61a69ad8d2a542c9b8800505ef853426e5b82c6baea30a5fc082dec0cd04b87d90730ab21ad682a1bb8a22f42449cf60ff7a443e13097733acff830534827e03be988ce2391e26cef878c56020e97e46142946901e03cd3373ceac63f1721a8175148081275bad37f040fbf266226a148bd826eccdcd3a5a483a0452c41b0eb5ac3cd8bdc46cfb39bace4771b528189a00e447e9d6d5ae3386f48bc3fb8245aa6\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n },\\\n \"demo\": **false**,\\\n \"pharmacy_id\": **null**,\\\n \"pharmacy_name\": **null**,\\\n \"metadata\": \"{\\\\\"shopify-checkouts_create\\\\\":{\\\\\"checkout_token\\\\\":\\\\\"cd7c9518dc029d636f693631239d95ca\\\\\",\\\\\"product_id\\\\\":\\[7004349235318,7004349464694\\]},\\\\\"shopify-orders_create\\\\\":{\\\\\"checkout_token\\\\\":\\\\\"cd7c9518dc029d636f693631239d95ca\\\\\",\\\\\"order_id\\\\\":5284938743926}}\",\\\n \"created_at\": \"2024-04-18T21:18:24.000000Z\",\\\n \"updated_at\": \"2024-04-18T21:20:47.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"partner_voucher_id\": \"15242cfd-5d6b-47cf-b1db-1d564cadc160\",\\\n \"expired\": **true**,\\\n \"is_expired\": **true**,\\\n \"onboarding_url\": \"[http://api.mdintegrations.com:8000?token=15242cfd-5d6b-47cf-b1db-1d564cadc160\",](http://api.mdintegrations.com:8000?token=15242cfd-5d6b-47cf-b1db-1d564cadc160\\\",)\\\n \"patient\": {\\\n \"patient_id\": \"afe6cb7e-f21e-4c92-bfa6-39a8b24c3376\",\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"prefix\": **null**,\\\n \"first_name\": \"Shop\",\\\n \"last_name\": \"test 006\",\\\n \"metadata\": \"{\\\\\"shopify-orders_create\\\\\":{\\\\\"customer_id\\\\\":6472646197366}}\",\\\n \"email\": \"[test+006@example.com](mailto:test+006@example.com)\",\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"date_of_birth\": \"1986-01-01\",\\\n \"gender\": 1,\\\n \"gender_label\": \"Male\",\\\n \"active\": **true**,\\\n \"phone_number\": \"\",\\\n \"phone_type\": \"2\",\\\n \"current_medications\": **null**,\\\n \"medical_conditions\": **null**,\\\n \"allergies\": **null**,\\\n \"pregnancy\": **false**,\\\n \"ssn\": **null**,\\\n \"created_at\": \"2024-04-18T21:20:46.000000Z\",\\\n \"is_live\": **true**,\\\n \"exam_id\": **null**,\\\n \"recent_encounter_id\": **null**,\\\n \"important_offering_case_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dosespot\": {\\\n \"dosespot_id\": **null**,\\\n \"sync_status\": **null**,\\\n \"synced_at\": **null**,\\\n \"metadata\": **null**,\\\n \"eligibilities\": \\[\\]\\\n },\\\n \"partner\": {\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"name\": \"Partner Name\",\\\n \"support_message_capability\": \"integrated\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"partner_notes\": \"Partner Notes\",\\\n \"operations_support_email\": \"[example@mdintegrations.com](mailto:example@mdintegrations.com)\",\\\n \"customer_support_email\": \"support@customer.example\",\\\n \"operation_country\": {\\\n \"country_id\": \"9856b3f5-b4e2-4bb1-bae9-f0f630d6a5fa\",\\\n \"name\": \"Canada\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"can_unlock_phi\": **false**,\\\n \"enable_av_flow\": **false**,\\\n \"enable_icd_bmi\": **false**,\\\n \"enable_auto_reassignment\": **true**,\\\n \"enable_automatic_sync_flow\": **true**,\\\n \"force_hold_status\": **false**,\\\n \"business_model\": \"regular\",\\\n \"customization\": {\\\n \"primary_color\": \"#5899c7\",\\\n \"secondary_color\": \"#5899c7\",\\\n \"background_color\": \"#5899c7\"\\\n },\\\n \"thank_you_note_header\": \"Thank You Note Header\",\\\n \"thank_you_note_footer\": \"Thank You Note Footer\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"vouched_integration_charge\": \"0.10\",\\\n \"text_message_integration_type\": \"automatic\",\\\n \"text_message_integration_charge\": \"0.10\",\\\n \"slack_channel_id\": **null**,\\\n \"shopify_id\": \"65fa0ae1-e219-402b-81a5-ef910ceac82f\",\\\n \"shopify_url\": \"[test.myshopify.com](http://test.myshopify.com)\",\\\n \"is_shopify_active\": **true**,\\\n \"custom_theme\": **null**,\\\n \"custom_style\": **null**\\\n },\\\n \"driver_license\": **null**,\\\n \"address\": {\\\n \"address\": \"Streeterville\",\\\n \"address2\": **null**,\\\n \"address_id\": \"4ebd6f99-67f8-48ac-80fa-36272ae22239\",\\\n \"zip_code\": \"60611\",\\\n \"city_name\": \"Chicago\",\\\n \"state\": {\\\n \"name\": \"Illinois\",\\\n \"abbreviation\": \"IL\",\\\n \"state_id\": \"8f39bf0d-614b-4fb3-90fe-0229e68882bc\",\\\n \"is_sync\": **false**,\\\n \"country\": {\\\n \"country_id\": \"39a4c803-7b39-49d6-8540-041e65f6ddcf\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"is_av_flow\": **false**\\\n }\\\n },\\\n \"intro_video\": **null**,\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI2Zjc5YWI3YS1hOTkwLTQ3YzYtOWExNy1kNWE2YjE2MzZlYTIiLCJqdGkiOiI0NzVlNjc3NWQ5MGRmYTE1MzAxMjNhMTJhMTJmNTdhYTIwNzQ4MzA1NmIxMGYxMmIxNjE5NTQ2NGM5ZjhiZjU3MzQ4YWYyYjU0NGM4NTk0OCIsImlhdCI6MTcxODI4NjUwMy40MTEyMzcsIm5iZiI6MTcxODI4NjUwMy40MTEyMzgsImV4cCI6MTcxODM3MjkwMy40MDc0Niwic3ViIjoiYWZlNmNiN2UtZjIxZS00YzkyLWJmYTYtMzlhOGIyNGMzMzc2Iiwic2NvcGVzIjpbIioiXX0.NBJHUyDtTHX1lAdGT-VX5gYT1ltyCk3QEXzrar6vmStOEEJfm-ILpJNCmzx8sLSxiAKJcIGGK_eVlUDCd-g-uW_dnpanXze2Tcl-g_ldtDMowsBPMnscCzSinFr7pGBWrDbDb1IzDVmstKHDsMBvQbS5dRO8dVfpNT4ONeNis7P0iKBuKj4sppcFcP31IQbjN970gR4vhKP5DaDsEYDpq291qaEKXtObFFvwq38PNliNPPanvvynWUyCX6UTKGsigBac-ij45JblK9NY6GaGVgJBJ2vb4qDcqdBZAPylyF69Tzobzwle7fViirfF5De25I7LXx1bpDDvQECQPwU5B0neh-Wau8Pxpk-IXSjDtGZ0iMwUcKfuGz8qgGKHF5S2n5SX0BxZc2XHOaA6c4zDrcnvLL-z-qgP-HUVgzVV6Z_NKi57UESmoCJlLxDuPBrwQxBF4VbGb2m-MvtkHhIti9dFZPSXaeWMGteWuEeht1cRL3jDW827CSQXy4NR6ZXHgAk5W6MDHhjEUR4m2bKG2XqOjuC_WRr-rI60rU0SWfFZIK_Di8B7yD-2xkojZYKi5v2v1TxQb1XUE0-hUy4G_dHnM1NIXvWylVb28jt2yk7yT5o885G2T5m5C2Yd_G63CjurV4KFjxekpdxOpgBpdrvEAFASwUByyanelgLFQM8\",\\\n \"refresh_token\": \"def5020013bf367bb65b6e2649c648e4afd271fcf2702a64d1625671e04f66a076c432a6d68b93cafa819d8fa6d729829ffa9a7c7eb5a96d9c4a6f9867d940d2f9871103a909c3da7abcbbd02c0edc3d63e9642ee8fdc0187784036efb2ab5263d8525f4bd563188bd75d8777d45f5581bffff0d1a9994cf76444d99cccc22e08981f0be1c07f3d12362d92aeee0473e614654e8a0e2d609997364161d1d1d973963232d71d10618bf90d7d3cd9220985de514855fa7f16eda0cc1b6b50185c6558cb39da7f59c86a90b63e32a7d34bfb4e9ec3f76db9992a339fa366e50f4883860fc29dc501aa3e0b3be726ab45aca2acd78d703c11c2dae11f724f48ec0454c65636301591efa44a1630ebaff50463ee5e7c04c7652c4b04ef6c73244e19a194bb55bb151f6254964c528af564fc2e8fc576e995002ee940d1ec1e36e160fcbf71d051d4780ed4732eb8dedd6511065c7c3a137720e74c69e96c0f49e4b6a89b8594329f3b67e3de3ad10b873ac7bc9522d731ff3d207568072aaeb054949fe8a03197a8529d11b64967075ecff18d372e3946bd38980c7c6507a6088631091d3bf36150cc2b0ca0e68cb\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n }\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"[http://localhost/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\",](http://localhost/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\\\",)\\\n \"last\": \"[http://localhost/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\",](http://localhost/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\\\",)\\\n \"prev\": **null**,\\\n \"next\": **null**\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 1,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.mdintegrations.com/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\",](http://api.mdintegrations.com/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": **null**,\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"[http://api.mdintegrations.com/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers\",](http://api.mdintegrations.com/api/patients/afe6cb7e-f21e-4c92-bfa6-39a8b24c3376/vouchers\\\",)\\\n \"per_page\": 15,\\\n \"to\": 6,\\\n \"total\": 6\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Dosespot undefined\n\n## End-point: Get coverage\n\nThis endpoint returns the insurance coverage based on medication NDC and patient eligibility ID\n\n**P.S**.: *It returns a Dosespot response.* ### Method: GET >>{{url}}/v1/partner/patients/:patient_id/dosespot/formulary?patient_eligibility_id=999876278&ndc=000777761616 > ### Query Params\n\nParam\n\nvalue\n\npatient_eligibility_id\n\n999876278\n\nndc\n\n000777761616\n\n### Response: undefined\n\n{\\\n \"Item\": {\\\n \"FormularyStatus\": **null**,\\\n \"Brand\": **null**,\\\n \"Otc\": **null**,\\\n \"Copays\": **null**,\\\n \"Alternatives\": **null**,\\\n \"TherapeuticAlternatives\": \\[\\\n {\\\n \"Ndc\": \"42806009630\",\\\n \"FormularyStatus\": **null**,\\\n \"Copay\": {\\\n \"IsDrugSpecific\": **false**,\\\n \"PharmacyType\": **null**,\\\n \"FlatCopayAmount\": **null**,\\\n \"PercentCopayAmount\": **null**,\\\n \"FlatCopayAmountFirst\": **null**,\\\n \"MinimumCopayAmount\": **null**,\\\n \"MaximumCopayAmount\": **null**,\\\n \"DaysSupply\": **null**,\\\n \"CopayTier\": **null**,\\\n \"MaximumCopayTier\": **null**,\\\n \"OutOfPocketMinimum\": **null**,\\\n \"OutOfPocketMaximum\": **null**\\\n },\\\n \"DisplayName\": \"Protriptyline HCl Oral Tablet 5 MG\",\\\n \"FormularyInfo\": {\\\n \"ProductId\": 0,\\\n \"Ndc\": **null**,\\\n \"FormularyStatusId\": 0,\\\n \"FormularyAbbreviation\": **null**,\\\n \"FormularyStatusMessage\": **null**,\\\n \"OrderRank\": 0,\\\n \"IsGeneric\": **null**,\\\n \"IsRx\": **null**\\\n },\\\n \"FullDisplayString\": \"Protriptyline HCl Oral Tablet 5 MG\",\\\n \"DisplayStrength\": \"5 MG\",\\\n \"DefaultDispenseUnitID\": 26,\\\n \"DispensableDrugId\": 18478,\\\n \"Schedule\": 0,\\\n \"IsDetox\": **false**,\\\n \"HasGHB\": **false**,\\\n \"RxCUI\": 0\\\n },\\\n {\\\n \"Ndc\": \"42806009730\",\\\n \"FormularyStatus\": **null**,\\\n \"Copay\": {\\\n \"IsDrugSpecific\": **false**,\\\n \"PharmacyType\": **null**,\\\n \"FlatCopayAmount\": **null**,\\\n \"PercentCopayAmount\": **null**,\\\n \"FlatCopayAmountFirst\": **null**,\\\n \"MinimumCopayAmount\": **null**,\\\n \"MaximumCopayAmount\": **null**,\\\n \"DaysSupply\": **null**,\\\n \"CopayTier\": **null**,\\\n \"MaximumCopayTier\": **null**,\\\n \"OutOfPocketMinimum\": **null**,\\\n \"OutOfPocketMaximum\": **null**\\\n },\\\n \"DisplayName\": \"Protriptyline HCl Oral Tablet 10 MG\",\\\n \"FormularyInfo\": {\\\n \"ProductId\": 0,\\\n \"Ndc\": **null**,\\\n \"FormularyStatusId\": 0,\\\n \"FormularyAbbreviation\": **null**,\\\n \"FormularyStatusMessage\": **null**,\\\n \"OrderRank\": 0,\\\n \"IsGeneric\": **null**,\\\n \"IsRx\": **null**\\\n },\\\n \"FullDisplayString\": \"Protriptyline HCl Oral Tablet 10 MG\",\\\n \"DisplayStrength\": \"10 MG\",\\\n \"DefaultDispenseUnitID\": 26,\\\n \"DispensableDrugId\": 18479,\\\n \"Schedule\": 0,\\\n \"IsDetox\": **false**,\\\n \"HasGHB\": **false**,\\\n \"RxCUI\": 0\\\n }\\\n \\],\\\n \"Restrictions\": **null**,\\\n \"RealTimeFormularyRequestStatus\": 1001\\\n },\\\n \"Result\": {\\\n \"ResultCode\": \"ERROR\",\\\n \"ResultDescription\": \"No active eligibility exists.\"\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Medications History\n\nIt gets the Dosespot medications history and caches it to the given patient. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/dosespot/medications/history > ### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{access_token}}\n\nstring\n\n### Response: undefined\n\n\\[\\\n {\\\n \"patient_medication_history_id\": 261246,\\\n \"pharmacy_notes\": **null**,\\\n \"no_substitutions\": **false**,\\\n \"effective_date\": **null**,\\\n \"last_fill_date\": \"2024-08-11T00:00:00\",\\\n \"payer\": \"PROINFORMA PBM\",\\\n \"days_supply\": 6,\\\n \"directions\": **null**,\\\n \"dispense_unit_description\": \"Tablets\",\\\n \"dispense_unit_id\": 26,\\\n \"quantity\": \"12.00\",\\\n \"refills\": **null**,\\\n \"written_date\": **null**,\\\n \"diagnosis_code\": **null**,\\\n \"diagnosis_qualifier\": **null**,\\\n \"dose_form\": \"Tablet Extended Release 12 Hour\",\\\n \"route\": \"Oral\",\\\n \"strength\": \"5-120 MG\",\\\n \"generic_drug_name\": \"Cetirizine-Pseudoephedrine ER Oral Tablet Extended Release 12 Hour 5-120 MG\",\\\n \"dispensable_drug_id\": 7741,\\\n \"brand\": **true**,\\\n \"rx_cui\": **null**,\\\n \"otc\": **true**,\\\n \"ndc\": \"00113014753\",\\\n \"schedule\": \"0\",\\\n \"display_name\": **null**,\\\n \"drug_classification\": \"\\*Decongestant & Antihistamine\\*\\*\\*\",\\\n \"expiration_date\": **null**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Tags undefined\n\n## End-point: Attach tag\n\nAttach a tag to patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nnotes\n\nstring\n\nAllow to add a note when attaching tags\n\n### Method: POST\n\n{{baseUrl}}/partner/patients/:patient_id/tags/:tag_id\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"notes\": \"Notes to add to tag\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Detach tag\n\nDetach a tag from patient. ### Method: DELETE >>{{baseUrl}}/partner/patients/:patient_id/tags/:tag_id > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update tag note\n\nAllow to update the tag note related to patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nnotes\n\nstring\\*\n\nAllow to add a note when attaching tags\n\n### Method: PATCH\n\n{{baseUrl}}/partner/patients/:patient_id/tags/:tag_id\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"notes\": \"Notes to add to tag\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create patient\n\nCreates a new patient record both on MD Integrations and DoseSpot.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nprefix\n\nstring(10)\n\nPrefix\n\nfirst_name\n\nstring(35)\\*\n\nFirst name\n\nlast_name\n\nstring(35)\\*\n\nLast name\n\nssn\n\nstring(11)\n\nSecurity Social Number. **Format**: AAAGGSSSS\n\nemail\n\nstring(80)\\*\n\nE-mail\n\ndate_of_birth\n\ndate\\*\n\nDate of birth, as YYYY-MM-DD\n\ndriver_license_id\n\nuuid\n\nPatient’s Driver License, needs to reference an existing **File**. Created through **Files > Create file**.\n\ngender\n\ninteger\\*\n\nGender (ISO 5218 format)\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the patient. (e.g., an ID that will be used to identify this patient in another database)\n\nphone_number\n\nstring(25)\\*\n\nPhone number - *US format*\n\nphone_type\n\ninteger\\*\n\nPhone type. Available options: 2 (cell) or 4 (home)\n\naddress.address\n\nstring(35)\\*\n\nAddress\n\naddress.address2\n\nstring(35)\n\nAdditional address - Allows null value\n\n[address.zip](http://address.zip)\\_code\n\nstring(9)\\*\n\nUS zip code - *5 or 9 digit format OR* CA zip code - 6 alphanumeric characters\n\n[address.city](http://address.city)\\_name\n\nstring(35)\\*\n\nCity name.\n\naddress.state_name\n\nstring\\*\n\nState name or State USPS abbreviation.\n\nweight\n\nfloat (from 0 to 999)\n\nWeight in KG \\* *required if patient is underage*\n\nheight\n\ninteger (from 0 to 300)\n\nHeight in CM \\* *required if patient is underage*\n\nallergies\n\ntext\n\nKnown patient’s allergies\n\npregnancy\n\nboolean\n\nDefine the patient with a pregnancy\n\ncurrent_medications\n\ntext\n\nMedications that the patient is currently taking\n\nmedical_conditions\n\ntext\n\nMedical conditions related to the patient\n\nspecial_necessities\n\ntext\n\nSpecial necessities related to the patient\n\nintro_video_id\n\nuuid\n\nPatient’s Intro Video, needs to reference an existing **File**. Created through **Files > Create file**.\n\nmetafields\n\narray\n\nPatient custom properties\n\nmetafields.\\*.key\n\nstring\\*\n\nField key\n\nmetafields.\\*.title\n\nstring\n\nField title (label)\n\nmetafields.\\*.value\n\nstring\\*\n\nField value\n\nmetafields.\\*.type\n\nstring\\*\n\nField type\n\n### Method: POST\n\n{{baseUrl}}/partner/patients\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"prefix\": \"Sr\",\\\n \"ssn\": \"111223333\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"gender\": 1,\\\n \"date_of_birth\": \"1983-10-17\",\\\n \"phone_number\": \"(816) 679-2211\",\\\n \"phone_type\": 2,\\\n \"metadata\": \"patient number 200\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"address\": {\\\n \"address\": \"9071 E. Mississippi Ave\",\\\n \"address2\": \"Apt 6C\",\\\n \"zip_code\": \"80247\",\\\n \"city_name\": \"Tazlima\",\\\n \"state_name\": \"Ohio\"\\\n },\\\n \"pregnancy\": **false**,\\\n \"blood_pressure\": \"120-129\",\\\n \"special_necessities\": \"Example of a text\",\\\n \"intro_video_id\": \"9d8df900-5b97-4d12-86e7-488fcb891b22\",\\\n \"metafields\": \\[\\\n {\\\n \"key\": \"smoke\",\\\n \"title\": \"Does the patient smoke??\",\\\n \"value\": \"false\",\\\n \"type\": \"boolean\"\\\n },\\\n {\\\n \"key\": \"internal_id\",\\\n \"title\": \"Patient internal ID\",\\\n \"value\": \"id-522\",\\\n \"type\": \"string\"\\\n }\\\n \\]\\\n}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"prefix\": \"Sr\",\\\n \"ssn\": \"111-22-3333\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"metadata\": \"patient number 200\",\\\n \"gender\": 1,\\\n \"phone_number\": \"541-754-3010\",\\\n \"phone_type\": 2,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"active\": **true**,\\\n \"weight\": 50,\\\n \"height\": 180,\\\n \"is_live\": **true**,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"patient_id\": \"99f7520d-7c8b-4a81-8957-e0bc139f40c5\",\\\n \"gender_label\": \"Male\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"special_necessities\": \"Special necessities example\",\\\n \"pregnancy\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"12345\",\\\n \"city_name\": \"Tazlina\",\\\n \"address_id\": \"eabbd96b-5704-4539-8c16-27b35f93fa06\",\\\n \"state\": {\\\n \"name\": \"Alaska\",\\\n \"abbreviation\": \"AK\",\\\n \"state_id\": \"06ed58ad-bf9c-4397-8795-5bd85a692a51\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"is_av_flow\": **false**\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"support_messaging_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"enable_av_flow\": **true**,\\\n \"enable_icd_bmi\": **false**,\\\n \"is_auto_dl_flow\": **true**,\\\n \"business_model\": \"regular\",\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"metafields\": \\[\\\n {\\\n \"id\": \"065ea604-837e-473e-b9f2-bf63d3d1acb7\",\\\n \"model_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"model_id\": \"851d40b0-9889-4483-9ada-27c8e1f42471\",\\\n \"key\": \"smoke\",\\\n \"value\": \"false\",\\\n \"scope\": \"patient_custom_properties\",\\\n \"type\": \"boolean\",\\\n \"title\": \"Does the patient smoke?\",\\\n \"metadata\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"updated_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"deleted_at\": **null**\\\n },\\\n {\\\n \"id\": \"cb4b56e8-026c-4c3d-a957-f5a3e8f790af\",\\\n \"model_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"model_id\": \"851d40b0-9889-4483-9ada-27c8e1f42471\",\\\n \"key\": \"internal_id\",\\\n \"value\": \"id-522\",\\\n \"scope\": \"patient_custom_properties\",\\\n \"type\": \"Patient internal ID\",\\\n \"title\": \"string\",\\\n \"metadata\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"updated_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Search patients\n\nThis route returns a list of Patients based on the \"search\" string parameter passed.\n\n## Payload\n\nfield\n\ntype\n\ndescription\n\nsearch\n\nstring\\*\n\nShould be either the patient’s full name, phone number, last name or e-mail.\n\n### Method: POST\n\n{{url}}/v1/partner/patients/search\n\n### Body (**raw**)\n\n{\\\n \"search\": \"Marc\",\\\n \"is_sandbox\": **false**\\\n}\n\n### Response: undefined\n\n\\[\\\n {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"ssn\": \"111223333\",\\\n \"email\": \"[green92@example.org](mailto:green92@example.org)\",\\\n \"date_of_birth\": \"1975-01-03\",\\\n \"gender\": 1,\\\n \"gender_label\": \"Male\",\\\n \"patient_id\": \"410af41d-e02b-4b54-a707-725141937ec8\",\\\n \"special_necessities\": \"Special necessities example\",\\\n \"is_live\": **true**,\\\n \"address\": {\\\n \"state\": {\\\n \"name\": \"Texas\",\\\n \"abbreviation\": \"TX\",\\\n \"state_id\": \"7ff4d81b-18b3-4dc8-a243-6da992b962d2\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"support_message_capability\": \"integrated\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n }\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get patient\n\nGet patient details. ### Method: GET >>{{url}}/v1/partner/patients/:patient_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n{\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"prefix\": \"Sr\",\\\n \"ssn\": \"111223333\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"gender\": 1,\\\n \"phone_number\": \"541-754-3010\",\\\n \"metadata\": \"patient number 200\",\\\n \"phone_type\": 2,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"active\": **true**,\\\n \"weight\": 50,\\\n \"height\": 180,\\\n \"blood_pressure\": \"120-129\",\\\n \"special_necessities\": \"Special necessities example\",\\\n \"dosespot\": {\\\n \"dosespot_id\": 123456,\\\n \"synced_at\": \"2024-04-03 13:59:33\",\\\n \"sync_status\": \"success\",\\\n \"metadata\": \"Metatada example\",\\\n \"eligibilities\": \\[\\\n {\\\n \"patient_eligibility_id\": \"098111235\"\\\n }\\\n \\]\\\n },\\\n \"patient_id\": \"99f7520d-7c8b-4a81-8957-e0bc139f40c5\",\\\n \"gender_label\": \"Male\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"pregnancy\": **true**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"12345\",\\\n \"city_name\": \"Tazlina\",\\\n \"address_id\": \"eabbd96b-5704-4539-8c16-27b35f93fa06\",\\\n \"state\": {\\\n \"name\": \"Alaska\",\\\n \"abbreviation\": \"AK\",\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"06ed58ad-bf9c-4397-8795-5bd85a692a51\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"support_message_capability\": \"integrated\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"enable_icd_bmi\": **false**,\\\n \"is_auto_dl_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"auth_link\": \"[https://message.mdintegrations.com/messages/eyJwYXRpZW50X2VtYWlsIjoicmVuYXRvK3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwidmVyaWZpY2F0aW9uX2NvZGUiOiJCNUJGQ0EiLCJwYXJ0bmVyX2lkIjpudWxsfQ==\"](https://message.mdintegrations.com/messages/eyJwYXRpZW50X2VtYWlsIjoicmVuYXRvK3Rlc3RAbWRpbnRlZ3JhdGlvbnMuY29tIiwidmVyaWZpY2F0aW9uX2NvZGUiOiJCNUJGQ0EiLCJwYXJ0bmVyX2lkIjpudWxsfQ==\\\")\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get patient events\n\nGet the patient’s events. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/events > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n\\[\\\n {\\\n \"event_id\": \"cccf72d0-e93e-4cf6-aaf2-50aaecd00b2f\",\\\n \"date_time\": \"2022-08-26T18:23:21.000000Z\",\\\n \"model\": \"patient\",\\\n \"type\": \"created\",\\\n \"by_model\": \"partner\",\\\n \"by\": \"USA Partner\",\\\n \"title\": \"Patient created\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Update patient\n\nUpdate a patient record both on MD Integrations and DoseSpot.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nprefix\n\nstring(10)\n\nPrefix\n\nfirst_name\n\nstring(35)\n\nFirst name\n\nlast_name\n\nstring(35)\n\nLast name\n\nssn\n\nstring(11)\n\nSecurity Social Number. **Format**: AAAGGSSSS\n\nemail\n\nstring(80)\n\nE-mail\n\ndate_of_birth\n\ndate\n\nDate of birth, as YYYY-MM-DD\n\ndriver_license_id\n\nuuid\n\nPatient’s Driver License, needs to reference an existing **File**. Created through **Files > Create file**.\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the patient. (e.g., an ID that will be used to identify this patient in another database)\n\ngender\n\ninteger\n\nGender (ISO 5218 format)\n\nphone_number\n\nstring(25)\n\nPhone number - *US format*\n\nphone_type\n\ninteger\n\nPhone type. Available options: 2 (cell) or 4 (home)\n\naddress.address\n\nstring(35)\n\nAddress\n\naddress.address2\n\nstring(35)\n\nAdditional address - Allows null value\n\n[address.zip](http://address.zip)\\_code\n\nstring(9)\n\nUS zip code - *5 or 9 digit format OR* CA zip code - 6 alphanumeric characters\n\n[address.city](http://address.city)\\_id\n\nuuid\n\nCity ID. Check **Metadata > States > Cities> Get cities from a given state** to get city ID. If you use this parameter you don’t need to use **city_name** parameter.\n\n[address.city](http://address.city)\\_name\n\nstring(35)\n\nCity name. If you use this parameter you don’t need use **city_id** parameter.\n\naddress.state_name\n\nstring\n\nState name or State USPS abbreviation. If you use this parameter you don’t need to use **city_id** parameter.\n\nweight\n\nfloat (from 0 to 999)\n\nWeight in KG \\* *required if patient is underage*\n\nheight\n\ninteger (from 0 to 300)\n\nHeight in CM \\* *required if patient is underage*\n\nallergies\n\ntext\n\nKnown patient’s allergies\n\npregnancy\n\nboolean\n\nDefine the patient with a pregnancy\n\ncurrent_medications\n\ntext\n\nMedications that the patient is currently taking\n\nmedical_conditions\n\ntext\n\nA medical condition information.\n\nspecial_necessities\n\ntext\n\nA special necessities related to patient\n\nintro_video_id\n\nuuid\n\nPatient’s Intro Video, needs to reference an existing **File**. Created through **Files > Create file**.\n\n### Method: PATCH\n\n{{baseUrl}}/partner/patients/:patient_id\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"gender\": 1,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"active\": **false**,\\\n \"weight\": 200,\\\n \"height\": 180,\\\n \"metadata\": \"patient number 200\",\\\n \"special_necessities\": \"Special necessities example\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"phone_number\": \"(415) 555-2671\",\\\n \"phone_type\": 4,\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"80247\",\\\n \"city_id\": \"9f3c4995-8416-4d19-a1e0-3d469afa3a7b\",\\\n \"city_name\": \"Tazlima\",\\\n \"state_name\": \"Ohio\"\\\n },\\\n \"current_medications\": \"paracetamol\",\\\n \"medical_conditions\": \"a medical condition example\",\\\n \"allergies\": \"polen\",\\\n \"pregnancy\": **true**,\\\n \"blood_pressure\": \"120-129\",\\\n \"intro_video_id\": \"1082599c-d08d-4cdb-b8e6-043cb86cfe0a\",\\\n \"metafields\": \\[\\\n {\\\n \"key\": \"smoke\",\\\n \"title\": \"Does the patient smoke??\",\\\n \"value\": \"false\",\\\n \"type\": \"boolean\"\\\n },\\\n {\\\n \"key\": \"internal_id\",\\\n \"title\": \"Patient internal ID\",\\\n \"value\": \"id-522\",\\\n \"type\": \"string\"\\\n }\\\n \\]\\\n}\n\n### Response: 200\n\n{\\\n \"partner_id\": \"90ee8161-0bb8-4f60-9e66-cdc305ea54cb\",\\\n \"prefix\": \"Sr\",\\\n \"ssn\": \"111223333\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": \"Harry\",\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"gender\": 1,\\\n \"phone_number\": \"541-754-3010\",\\\n \"metadata\": \"patient number 200\",\\\n \"phone_type\": 2,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"active\": **true**,\\\n \"weight\": 50,\\\n \"height\": 180,\\\n \"blood_pressure\": \"120-129\",\\\n \"special_necessities\": \"Special necessities example\",\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"patient_id\": \"99f7520d-7c8b-4a81-8957-e0bc139f40c5\",\\\n \"gender_label\": \"Male\",\\\n \"current_medications\": \"paracetamol and ibuprofen\",\\\n \"allergies\": \"peanuts and penicillin\",\\\n \"medical_conditions\": \"medical conditions example\",\\\n \"pregnancy\": **true**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"12345\",\\\n \"city_name\": \"Tazlina\",\\\n \"address_id\": \"eabbd96b-5704-4539-8c16-27b35f93fa06\",\\\n \"state\": {\\\n \"name\": \"Alaska\",\\\n \"abbreviation\": \"AK\",\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"06ed58ad-bf9c-4397-8795-5bd85a692a51\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"support_message_capability\": \"integrated\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"enable_icd_bmi\": **false**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"metafields\": \\[\\\n {\\\n \"id\": \"065ea604-837e-473e-b9f2-bf63d3d1acb7\",\\\n \"model_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"model_id\": \"851d40b0-9889-4483-9ada-27c8e1f42471\",\\\n \"key\": \"smoke\",\\\n \"value\": \"false\",\\\n \"scope\": \"patient_custom_properties\",\\\n \"type\": \"boolean\",\\\n \"title\": \"Does the patient smoke?\",\\\n \"metadata\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"updated_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"deleted_at\": **null**\\\n },\\\n {\\\n \"id\": \"cb4b56e8-026c-4c3d-a957-f5a3e8f790af\",\\\n \"model_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"model_id\": \"851d40b0-9889-4483-9ada-27c8e1f42471\",\\\n \"key\": \"internal_id\",\\\n \"value\": \"id-522\",\\\n \"scope\": \"patient_custom_properties\",\\\n \"type\": \"Patient internal ID\",\\\n \"title\": \"string\",\\\n \"metadata\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"updated_at\": \"2024-12-06T12:22:17.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get patient cases\n\nThis endpoint returns all cases related to the patient passed on the request. ### Method: GET >>{{baseUrl}}/partner/patients/:patient_id/cases > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"current_page\": 1,\\\n \"data\": \\[\\\n {\\\n \"case_assignment\": {\\\n \"case_assignment_id\": \"a8f5d2b4-a6b1-481d-aa67-83c94e659f7c\",\\\n \"clinician\": {\\\n \"clinician_id\": \"8e548127-8979-4f53-a4dd-a049743c6f7b\",\\\n \"first_name\": \"Mara\",\\\n \"full_name\": \"Mara Windler\",\\\n \"suffix\": \"M.D\",\\\n \"profile_url\": \"[http://profileurlexample.com\",](http://profileurlexample.com\\\",)\\\n \"last_name\": \"Windler\",\\\n \"is_online\": **true**,\\\n \"licenses\": \\[\\\n {\\\n \"license_id\": \"f60e55d5-15b2-4367-9557-4dcd2afdd981\",\\\n \"type\": \"npi\",\\\n \"value\": \"29b67df9-dd72-3270-9f75-6fc94f88bd74\"\\\n }\\\n \\],\\\n \"photo\": {\\\n \"file_id\": \"adfaa0b2-c6d9-47fe-a881-9b3d110564a3\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"name\": \"Dr. Garrett Lockman\",\\\n \"path\": \"[https://lorempixel.com/640/480/?13747\",](https://lorempixel.com/640/480/?13747\\\",)\\\n \"url\": \"[http://some-signed-url.test\",](http://some-signed-url.test\\\",)\\\n \"url_thumbnail\": **null**\\\n },\\\n \"specialty\": \"General Practice\",\\\n \"bio_details\": \"Here is a bio detail example.\"\\\n },\\\n \"created_at\": \"2022-04-13T17:31:02.000000Z\",\\\n \"reason\": \"Dolorum natus voluptates dolorem placeat voluptate. Molestiae nemo laboriosam nemo quis. Velit consequuntur ea vitae fugiat. Non perferendis fugit non et. Eaque nobis ut et atque.\"\\\n },\\\n \"case_files\": \\[\\\n {\\\n \"file_id\": \"3205c0d4-daf3-4149-8d5e-df9b12c252d6\",\\\n \"mime_type\": \"application/vnd.sun.xml.impress.template\",\\\n \"name\": \"Prof. Cory Monahan\",\\\n \"url\": \"[http://some-signed-url.test\",](http://some-signed-url.test\\\",)\\\n \"url_thumbnail\": **null**\\\n }\\\n \\],\\\n \"case_id\": \"32b356d1-7561-4701-a154-10a5559599f8\",\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_notes\": \\[\\\n {\\\n \"clinician\": {\\\n \"clinician_id\": \"8e548127-8979-4f53-a4dd-a049743c6f7b\",\\\n \"first_name\": \"Mara\",\\\n \"full_name\": \"Mara Windler\",\\\n \"last_name\": \"Windler\",\\\n \"licenses\": \\[\\\n {\\\n \"license_id\": \"f60e55d5-15b2-4367-9557-4dcd2afdd981\",\\\n \"type\": \"npi\",\\\n \"value\": \"29b67df9-dd72-3270-9f75-6fc94f88bd74\"\\\n }\\\n \\]\\\n },\\\n \"created_at\": \"2022-04-13T17:31:02.000000Z\",\\\n \"text\": \"Et a deserunt soluta fugiat natus temporibus nostrum et. Eaque consequatur in ullam voluptates. Assumenda similique atque repellat eum.\"\\\n }\\\n \\],\\\n \"case_offerings\": \\[\\\n {\\\n \"id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"case_offering_id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"title\": \"supply example\",\\\n \"name\": \"supply example\",\\\n \"directions\": \"directions\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"19e21647-e5bf-4996-b9b4-154aab1963ad\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"ndc\": **null**,\\\n \"otc\": **null**,\\\n \"upc\": **null**,\\\n \"name\": \"supply example\",\\\n \"title\": \"supply example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"directions\",\\\n \"updated_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"days_supply\": **null**,\\\n \"is_obsolete\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"dosespot_supply_id\": 21\\\n },\\\n \"product_id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotSupply\"\\\n },\\\n {\\\n \"id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"case_offering_id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"title\": \"compound example\",\\\n \"name\": \"compound example\",\\\n \"directions\": \"abc\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"5ff1eae1-1566-4dd5-ad1a-457b105d59ac\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"name\": \"compound example\",\\\n \"title\": \"compound example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"abc\",\\\n \"updated_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"days_supply\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"allow_substitutions\": **true**\\\n },\\\n \"product_id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotCompound\"\\\n }\\\n \\],\\\n \"case_questions\": \\[\\\n {\\\n \"answer\": \"1\",\\\n \"case_question_id\": \"cb6958df-4f0d-4663-ac7d-30497e4ddf01\",\\\n \"display_in_pdf\": **false**,\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"question\": \"Rerum est excepturi quas iure eveniet accusantium. Tempora alias deleniti quia impedit voluptatem voluptatibus non. Molestiae natus amet eius tempora nesciunt corporis.\",\\\n \"type\": \"boolean\"\\\n }\\\n \\],\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\",\\\n \"icd\": \"A000\",\\\n \"description\": \"Cholera due to Vibrio cholerae 01, biovar cholerae\"\\\n }\\\n \\],\\\n \"case_status\": {\\\n \"created_at\": \"2022-04-13T17:31:02.000000Z\",\\\n \"name\": \"completed\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2022-04-13T17:31:02.000000Z\"\\\n },\\\n \"case_type\": \"follow-up\",\\\n \"created_at\": \"2022-04-13T17:31:02.000000Z\",\\\n \"is_chargeable\": **true**,\\\n \"is_sync\": **false**,\\\n \"metadata\": **null**\\\n }\\\n \\],\\\n \"first_page_url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=1\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=1\\\",)\\\n \"from\": 1,\\\n \"last_page\": 2,\\\n \"last_page_url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\\\",)\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=1\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\\\",)\\\n \"label\": \"2\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\\\",)\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"next_page_url\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases?page=2\\\",)\\\n \"path\": \"[http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases\",](http://api.localhost:8000/v1/partner/patients/410af41d-e02b-4b54-a707-725141937ec8/cases\\\",)\\\n \"per_page\": 50,\\\n \"prev_page_url\": **null**,\\\n \"to\": 50,\\\n \"total\": 62\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Notification\n\nGet the following logged partner information:\n\n- Profile\n\n- Address\n\n### Method: GET\n\n{{baseUrl}}/partner/messages/notifications/:notification_id\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": \"3ef730ac-6484-47d0-a50c-6d2746035552\",\\\n \"partner_id\": \"cac7c958-7a95-4ffc-845f-f6d3c352c0b7\",\\\n \"event\": \"patient_message_created\",\\\n \"title\": \"New message from John Doe\",\\\n \"preview\": \"Hi doctor I'm sending you a message\",\\\n \"source_model_type\": \"App\\\\\\\\Models\\\\\\\\Message\",\\\n \"source_model_id\": \"2d5b9e86-cb86-496b-92d1-2babaf06d544\",\\\n \"notifier_model_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"notifier_model_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"notified_model_type\": \"App\\\\\\\\Models\\\\\\\\InternalSupportStaff\",\\\n \"notified_model_id\": **null**,\\\n \"suggested_notified_model_type\": **null**,\\\n \"suggested_notified_model_id\": **null**,\\\n \"dismissed_at\": \"2025-01-31 10:40:42\",\\\n \"dismissed_by_model_type\": **null**,\\\n \"dismissed_by_model_id\": **null**,\\\n \"expires_at\": **null**,\\\n \"notify_at\": **null**,\\\n \"metadata\": {\\\n \"patient_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"primary_clinician_id\": **null**,\\\n \"recent_encounter_id\": **null**,\\\n \"channel\": \"patient\"\\\n },\\\n \"created_at\": \"2025-01-31T10:38:20.000000Z\",\\\n \"updated_at\": \"2025-01-31T10:40:42.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"source\": {\\\n \"id\": \"2d5b9e86-cb86-496b-92d1-2babaf06d544\",\\\n \"patient_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"channel\": \"patient\",\\\n \"text\": \"Hi doctor I wanna see suggested from local env\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"user_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"user_name\": \"John Doe\",\\\n \"reference_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"reply_message_id\": **null**,\\\n \"dismissed_at\": **null**,\\\n \"dismissed_by_user_type\": **null**,\\\n \"dismissed_by_user_id\": **null**,\\\n \"dismissed_by_user_name\": **null**,\\\n \"on_behalf_user_type\": **null**,\\\n \"on_behalf_user_id\": **null**,\\\n \"on_behalf_user_name\": **null**,\\\n \"emailed_at\": **null**,\\\n \"created_at\": \"2025-01-31T10:38:19.000000Z\",\\\n \"updated_at\": \"2025-01-31T10:38:19.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"read_message_info\": **null**,\\\n \"partner_id\": \"cac7c958-7a95-4ffc-845f-f6d3c352c0b7\",\\\n \"recent_encounter_id\": **null**,\\\n \"patient\": {\\\n \"id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"first_name\": \"Renato\",\\\n \"middle_name\": **null**,\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@mdintegrations.com](mailto:john@mdintegrations.com)\",\\\n \"ssn\": **null**,\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": 72,\\\n \"height\": 180,\\\n \"blood_pressure\": **null**,\\\n \"date_of_birth\": \"1990-01-01\",\\\n \"gender\": 1,\\\n \"gender_label\": \"Male\",\\\n \"phone_number\": \"(401) 712-2640\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"106240fc-eba9-414f-a11f-977dbd195b81\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"None\",\\\n \"current_medications\": **null**,\\\n \"medical_conditions\": \"None\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"cac7c958-7a95-4ffc-845f-f6d3c352c0b7\",\\\n \"environment_id\": \"4ec4da44-4b57-4787-b8b8-ab5765b026dc\",\\\n \"clinician_id\": **null**,\\\n \"metadata\": **null**,\\\n \"intro_video_file_id\": **null**,\\\n \"recent_encounter_id\": **null**,\\\n \"important_offering_case_id\": **null**,\\\n \"created_at\": \"2024-12-13T16:27:57.000000Z\",\\\n \"updated_at\": \"2025-01-31T10:09:18.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"patient_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"full_name\": \"John Doe\",\\\n \"abbreviated_name\": \"John D.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**,\\\n \"exam_id\": \"43135be2-bf60-4b89-a3d0-5e05b53c2159\",\\\n \"dosespot\": {\\\n \"dosespot_id\": **null**,\\\n \"sync_status\": **null**,\\\n \"synced_at\": **null**,\\\n \"metadata\": **null**,\\\n \"eligibilities\": \\[\\]\\\n },\\\n \"metafields\": \\[\\],\\\n \"environment\": {\\\n \"id\": \"4ec4da44-4b57-4787-b8b8-ab5765b026dc\",\\\n \"identifier\": \"live\",\\\n \"created_at\": \"2024-11-13T13:41:02.000000Z\",\\\n \"updated_at\": \"2024-11-13T13:41:02.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n },\\\n \"readings\": \\[\\]\\\n },\\\n \"notifier\": {\\\n \"id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"first_name\": \"John\",\\\n \"middle_name\": **null**,\\\n \"last_name\": \"Doe\",\\\n \"email\": \"[john@mdintegrations.com](mailto:john@mdintegrations.com)\",\\\n \"ssn\": **null**,\\\n \"active\": **true**,\\\n \"prefix\": **null**,\\\n \"weight\": 72,\\\n \"height\": 180,\\\n \"blood_pressure\": **null**,\\\n \"date_of_birth\": \"1990-01-01\",\\\n \"gender\": 1,\\\n \"gender_label\": \"Male\",\\\n \"phone_number\": \"(401) 712-2640\",\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"106240fc-eba9-414f-a11f-977dbd195b81\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": \"None\",\\\n \"current_medications\": **null**,\\\n \"medical_conditions\": \"None\",\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"cac7c958-7a95-4ffc-845f-f6d3c352c0b7\",\\\n \"environment_id\": \"4ec4da44-4b57-4787-b8b8-ab5765b026dc\",\\\n \"clinician_id\": **null**,\\\n \"metadata\": **null**,\\\n \"intro_video_file_id\": **null**,\\\n \"recent_encounter_id\": **null**,\\\n \"important_offering_case_id\": **null**,\\\n \"created_at\": \"2024-12-13T16:27:57.000000Z\",\\\n \"updated_at\": \"2025-01-31T10:09:18.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"patient_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"full_name\": \"John Doe\",\\\n \"abbreviated_name\": \"John D.\",\\\n \"is_live\": **true**,\\\n \"intro_video_id\": **null**,\\\n \"exam_id\": \"43135be2-bf60-4b89-a3d0-5e05b53c2159\",\\\n \"dosespot\": {\\\n \"dosespot_id\": **null**,\\\n \"sync_status\": **null**,\\\n \"synced_at\": **null**,\\\n \"metadata\": **null**,\\\n \"eligibilities\": \\[\\]\\\n },\\\n \"metafields\": \\[\\],\\\n \"environment\": {\\\n \"id\": \"4ec4da44-4b57-4787-b8b8-ab5765b026dc\",\\\n \"identifier\": \"live\",\\\n \"created_at\": \"2024-11-13T13:41:02.000000Z\",\\\n \"updated_at\": \"2024-11-13T13:41:02.000000Z\",\\\n \"deleted_at\": **null**\\\n }\\\n },\\\n \"notified\": **null**\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get file\n\nGet information from a given file ID.\n\n### Method: GET\n\n{{baseUrl}}/partner/files/:file_id\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: 200\n\n{\\\n \"file_id\": \"1fff9ac9-c896-4145-9ea3-cdc152e82f2f\",\\\n \"path\": \"partners/PeLGM0MiFDW5zIfLOTvYwyGeGVvLvflNOnQMOZo9.png\",\\\n \"name\": \"face - left side\",\\\n \"mime_type\": \"image/png\",\\\n \"type\": \"other\",\\\n \"url\": \"[http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f\",](http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f&thumbnail=1\",](http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f&thumbnail=1\\\",)\\\n \"created_at\": \"2022-12-15T18:08:08.000000Z\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Delete file\n\nDelete a given file ID. ### Method: DELETE >>{{baseUrl}}/partner/files/:file_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n\\[\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create file\n\nUpload a single file to MD Integrations using **multipart/form-data**.\n\n**Type**\n\n**Maximum Size**\n\nImages files\n\n25mb\n\nVideo files\n\n140mb\n\nOther types\n\n16mb\n\nAccepted types:\n\n- document\n\n- review\n\n- other\n\n- insurance-policy\n\n- contract\n\n- driver-license\n\n- lab-result\n\n- photo\n\n- av-video\n\n- full-body-photo\n\n- back-photo\n\n- face-photo\n\n- avatar-photo\n\n- ipledge-document\n\n- auth-form ### Method: POST >>{{baseUrl}}/partner/files > ### Headers\n\nContent-Type\n\nValue\n\nContent\n\nmultipart/form-data;\n\n### Body formdata\n\nParam\n\nvalue\n\nType\n\nname\n\nface - left side\n\ntext\n\nfile\n\nTFYBa4A-A/800px-Sunflower_from_Silesia2.jpg\n\nfile\n\ntype\n\nlab-result\n\ntext\n\n### Response: 200\n\n{\\\n \"file_id\": \"1fff9ac9-c896-4145-9ea3-cdc152e82f2f\",\\\n \"path\": \"partners/PeLGM0MiFDW5zIfLOTvYwyGeGVvLvflNOnQMOZo9.png\",\\\n \"name\": \"face - left side\",\\\n \"mime_type\": \"image/png\",\\\n \"url\": \"[http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f\",](http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f&thumbnail=1\",](http://api.mdintegrations.com/s3/files/a464c447-58d2-45b6-bccb-8b6f7860f121/file?signature=569bef84c4a7569d8ee08f973ef3d27aacc691288a081715f83208b3ea7d926f&thumbnail=1\\\",)\\\n \"created_at\": \"2022-12-15T18:08:08.000000Z\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get pharmacies\n\nSearch DoseSpot pharmacies according to a given query parameter. At least **one** query parameter is required. If no query parameter is provided, an error will be thrown.\n\nThis API endpoint forwards the request to DoseSpot in order to search for pharmacies. ### Method: GET >>{{url}}/v1/partner/pharmacies?name=Curexa > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\ncity\n\nCleveland\n\nstate\n\nOH\n\nzip\n\n12345\n\naddress\n\n5th avenue\n\nphoneOrFax\n\n6099270390\n\nspecialty\\[0\\]\n\nRetail\n\nspecialty\\[1\\]\n\n16\n\nncpdpID\n\n123456\n\nname\n\nCurexa\n\n### Response: 200\n\n\\[\\\n {\\\n \"id\": 232,\\\n \"name\": \"BASHAS' UNITED DRUG 161\",\\\n \"store_name\": \"BASHAS' UNITED DRUG 161\",\\\n \"address1\": \"4940 S. GILBERT RD\",\\\n \"address2\": \"\",\\\n \"city\": \"CHANDLER\",\\\n \"state\": \"AZ\",\\\n \"zip_code\": \"85249\",\\\n \"primary_phone\": \"4808832241\",\\\n \"primary_phone_type\": 5,\\\n \"primary_fax\": \"4808832243\",\\\n \"phone_additional_1\": **null**,\\\n \"phone_additional_type_1\": 0,\\\n \"phone_additional_2\": **null**,\\\n \"phone_additional_type_2\": 0,\\\n \"phone_additional_3\": **null**,\\\n \"phone_additional_type_3\": 0,\\\n \"pharmacy_specialties\": \\[\\\n \"Retail\",\\\n \"EPCS\"\\\n \\],\\\n \"service_level\": 3,\\\n \"latitude\": 33.23492,\\\n \"longitude\": -111.79107\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get pharmacy\n\nGet DoseSpot pharmacy details from a given pharmacy ID.\n\nThis API endpoint forwards the request to DoseSpot in order to retrieve the pharmacy details. ### Method: GET >>{{url}}/v1/partner/pharmacies/:pharmacy_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{partner_access_token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"id\": 4812,\\\n \"name\": \"CVS Pharmacy # 6167\",\\\n \"store_name\": \"CVS Pharmacy # 6167\",\\\n \"address1\": \"418 EAST MAIN STREET\",\\\n \"address2\": \"\",\\\n \"city\": \"ASHLAND\",\\\n \"state\": \"OH\",\\\n \"zip_code\": \"44805\",\\\n \"primary_phone\": \"4192810053\",\\\n \"primary_phone_type\": 5,\\\n \"primary_fax\": \"4192818653\",\\\n \"phone_additional_1\": **null**,\\\n \"phone_additional_type_1\": 0,\\\n \"phone_additional_2\": **null**,\\\n \"phone_additional_type_2\": 0,\\\n \"phone_additional_3\": **null**,\\\n \"phone_additional_type_3\": 0,\\\n \"pharmacy_specialties\": **null**,\\\n \"service_level\": 3,\\\n \"latitude\": 40.868019,\\\n \"longitude\": -82.307227\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get dispense units\n\nGet DoseSpot dispense units. You can search for dispenses units using the name query parameter.\n\nThis API endpoint forwards the request to DoseSpot in order to retrieve dispense units. ### Method: GET >>{{baseUrl}}/partner/dispense-units > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nname\n\nbox\n\n### Response: 200\n\n\\[\\\n {\\\n \"dispense_unit_id\": 1,\\\n \"name\": \"Capsule\",\\\n \"abbreviation\": \"AV\",\\\n \"singular\": \"Capsule\",\\\n \"plural\": \"Capsules\",\\\n \"singular_or_plural\": \"Capsule(s)\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"dispense_unit_id\": 1,\\\n \"name\": \"Capsule\",\\\n \"abbreviation\": \"AV\",\\\n \"singular\": \"Capsule\",\\\n \"plural\": \"Capsules\",\\\n \"singular_or_plural\": \"Capsule(s)\",\\\n \"active\": **true**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get vouchers\n\nThis endpoint returns all vouchers related to the filters passed on the request. ### Method: GET >>{{baseUrl}}/partner/vouchers/?expired=0 > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nexpired\n\n0\n\n### Response: undefined\n\n{\\\n \"data\": \\[\\\n {\\\n \"id\": \"91c7bd33-6161-4112-96a3-f46c297689dc\",\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"case_id\": **null**,\\\n \"partner_questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"environment_id\": \"38da4bf4-3843-4cc3-83d1-13130daffdbd\",\\\n \"expires_at\": \"2024-12-12T18:00:00.000000Z\",\\\n \"payload\": {\\\n \"diseases\": \\[\\],\\\n \"patient_id\": \"afe6cb7e-f21e-4c92-bfa6-39a8b24c3376\",\\\n \"hold_status\": **true**,\\\n \"offerings\": \\[\\\n {\\\n \"offering_id\": \"f7850441-c200-4673-aca9-4ee52e9fb6bf\",\\\n \"pharmacy_id\": 14,\\\n \"force_pharmacy\": **true**\\\n },\\\n {\\\n \"offering_id\": \"e09b0f66-d0db-4c0f-850c-2ba7e31d9fe7\",\\\n \"pharmacy_id\": 22,\\\n \"force_pharmacy\": **true**\\\n },\\\n {\\\n \"offering_id\": \"796ca3bb-19bc-477c-ba58-4016fe7943d5\"\\\n }\\\n \\],\\\n \"environment_id\": \"74fa173c-9455-4e79-88e7-b1a668e83274\",\\\n \"questionnaire_id\": \"d8bc8352-057e-495b-b5df-cdba45679860\",\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI2Zjc5YWI3YS1hOTkwLTQ3YzYtOWExNy1kNWE2YjE2MzZlYTIiLCJqdGkiOiJmZTY5ZGRkYjgzNzExOGI1NDM3YWExMjk4MzEzNTg0MjBiMWE5NmEyOTYyZmFmZDY5YjI0YjdlM2NhZDc3NWM2ZjI3M2M4ODAxNmFhNDc0YyIsImlhdCI6MTcxODM3MjY4NS42NjMwNDMsIm5iZiI6MTcxODM3MjY4NS42NjMwNDQsImV4cCI6MTcxODQ1OTA4NS42NTIwNjQsInN1YiI6ImFmZTZjYjdlLWYyMWUtNGM5Mi1iZmE2LTM5YThiMjRjMzM3NiIsInNjb3BlcyI6WyIqIl19.HQn6VQkmjlDch3cpsnbD3BqCOF1cz_GilBTROwf2sKLnwF3VNvRTIwDb5xuHT_v7TgcHE5X5Ql\\_-k2VEo8udlz-MhwdypTziNDeyPPXJKi3bLo-TPJ-xbPsxNMNqb1hDtB6F4hu-ISGhO9ZAXnhl796STcdYtyzOZIx1ZnkDy8sxNtlxHO_Ba2YUC47dA5F0sXlnhjVviMhHyzCZEbOIPizw0cFgELNA74UsBo87IzMCQeMhrTthwwFAquW34ZpT0Xh9TrZloUzRc-dSJZXW5GtGY65E6iZhdoGfSKFJsppb-aTTZYrfEs-hnzpYSWrSsEVlesQxOJM3olEjXewoJAIo-huaNxwhe30eWYDZsYhcVik_yZUE1bBHI6vzaBmyQekLyKWxchq3S9agdtiVF3-wSg8OYbhA5yTTNvjvQsOFkju82Xh_YyeX2ENJ0hu_ht02Y-CwT1wcMWK7jHmnICizzQXzSRfdvvsjZ-5fbfoRue68mVQE6Puvto19elLvQ79jm6-EBKtW6VmdU08j3gDFBAXzHFonUQkObWNiwgWLfXiuxezOadgtM1326IMYqEQjHkO2LJO0cJlt_laYsPsBFOB9d1AEAvRxvtPkxFHWn8enqW6rCY9-AP7Ng798sGsKKiPNFNO_YyG9HOW551Nsy3LZTZSK-3DCni5Le0E\",\\\n \"refresh_token\": \"def5020071a0fd175489e8f54a3147822478d3b5124b0a2776b95a6166e2b5e0f31fcd7d232a9070f729e5aa3d06ea0a3638f04f712564cc30da7450a8851b9013bcadb3ccb8bdf95574504d5a82561c34505f35ce5d5cd85894b27399e235b01befe784e87ada858c8d1a3155c34e7dda3166d085051d1e4e37e4dd7cff6073ec0946f8c500c21095390a298a7c9b58b8f5ca1f851fcc48511d285be83ae9b592bcbf30b410c8a388af9e5026c704e54dbe6908ec8064beb5b0eae99879692837b741a0b68bb7e91cad5497612494ee8fe0dc817f5465a5bf20adb5c0426ee2135586ac311c59466858cf2147364814ae2a31c2e94c48dd3fa296974d320a6ecbd0951f329c42703e43b8e65ca29e0558f71cf23cf373215fa8b805cfa1b8403c79b1ed0c59f0edc8a09e9cbd9e567b222266861eef010adb7912b7b5c11b30d4d42eaca945fa14cea5331fbeb6d7a5339b7bfb2af730f86d62449ba182a82333b06b262f8b8da0fc82b452574ee3050891e85ebcc4ea63ba42b4e12b4d826a19535642eb685187a60957171f70de2a6ef7e60562fb28f097b40e0100ee8603f0dd9e60ccb0252086e97baa\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n },\\\n \"demo\": **true**,\\\n \"pharmacy_id\": **null**,\\\n \"pharmacy_name\": **null**,\\\n \"metadata\": **null**,\\\n \"created_at\": \"2024-06-14T13:43:09.000000Z\",\\\n \"updated_at\": \"2024-06-14T13:43:09.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"partner_voucher_id\": \"91c7bd33-6161-4112-96a3-f46c297689dc\",\\\n \"expired\": **false**,\\\n \"is_expired\": **false**,\\\n \"onboarding_url\": \"[https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\",](https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\\\",)\\\n \"patient\": {\\\n \"patient_id\": \"afe6cb7e-f21e-4c92-bfa6-39a8b24c3376\",\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"prefix\": **null**,\\\n \"first_name\": \"Shop\",\\\n \"last_name\": \"test 006\",\\\n \"metadata\": \"{\\\\\"shopify-orders_create\\\\\":{\\\\\"customer_id\\\\\":64726461973}}\",\\\n \"email\": \"[shop+test+006@example.com](mailto:shop+test+006@example.com)\",\\\n \"weight\": **null**,\\\n \"height\": **null**,\\\n \"date_of_birth\": \"1986-01-01\",\\\n \"gender\": 1,\\\n \"gender_label\": \"Male\",\\\n \"active\": **true**,\\\n \"phone_number\": \"\",\\\n \"phone_type\": \"2\",\\\n \"current_medications\": **null**,\\\n \"medical_conditions\": **null**,\\\n \"allergies\": **null**,\\\n \"pregnancy\": **false**,\\\n \"ssn\": **null**,\\\n \"created_at\": \"2024-04-18T21:20:46.000000Z\",\\\n \"is_live\": **true**,\\\n \"exam_id\": **null**,\\\n \"recent_encounter_id\": **null**,\\\n \"important_offering_case_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dosespot\": {\\\n \"dosespot_id\": **null**,\\\n \"sync_status\": **null**,\\\n \"synced_at\": **null**,\\\n \"metadata\": **null**,\\\n \"eligibilities\": \\[\\]\\\n },\\\n \"partner\": {\\\n \"partner_id\": \"34e883bd-df4d-4bf5-8252-d9e75ecc51f0\",\\\n \"name\": \"Partner Name\",\\\n \"support_message_capability\": \"integrated\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"partner_notes\": \"Partner Notes\",\\\n \"operations_support_email\": \"[example@example.com](mailto:example@example.com)\",\\\n \"customer_support_email\": \"support@customer.example\",\\\n \"operation_country\": {\\\n \"country_id\": \"9856b3f5-b4e2-4bb1-bae9-f0f630d6a5fa\",\\\n \"name\": \"Canada\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"can_unlock_phi\": **false**,\\\n \"enable_av_flow\": **false**,\\\n \"enable_icd_bmi\": **false**,\\\n \"enable_auto_reassignment\": **true**,\\\n \"enable_automatic_sync_flow\": **true**,\\\n \"force_hold_status\": **false**,\\\n \"business_model\": \"regular\",\\\n \"customization\": {\\\n \"primary_color\": \"#5899c7\",\\\n \"secondary_color\": \"#5899c7\",\\\n \"background_color\": \"#5899c7\"\\\n },\\\n \"thank_you_note_header\": \"Thank You Note Header\",\\\n \"thank_you_note_footer\": \"Thank You Note Footer\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"vouched_integration_charge\": \"0.10\",\\\n \"text_message_integration_type\": \"automatic\",\\\n \"text_message_integration_charge\": \"0.10\",\\\n \"slack_channel_id\": **null**,\\\n \"shopify_id\": \"65fa0ae1-e219-402b-81a5-ef910cea2f\",\\\n \"shopify_url\": \"[test.myshopify.com](http://test.myshopify.com)\",\\\n \"is_shopify_active\": **true**,\\\n \"custom_theme\": **null**,\\\n \"custom_style\": **null**\\\n },\\\n \"driver_license\": **null**,\\\n \"address\": {\\\n \"address\": \"Streeterville\",\\\n \"address2\": **null**,\\\n \"address_id\": \"4ebd6f99-67f8-48ac-80fa-36272ae22239\",\\\n \"zip_code\": \"60611\",\\\n \"city_name\": \"Chicago\",\\\n \"state\": {\\\n \"name\": \"Illinois\",\\\n \"abbreviation\": \"IL\",\\\n \"state_id\": \"8f39bf0d-614b-4fb3-90fe-0229e68882bc\",\\\n \"is_sync\": **false**,\\\n \"country\": {\\\n \"country_id\": \"39a4c803-7b39-49d6-8540-041e65f6ddcf\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"is_av_flow\": **false**\\\n }\\\n },\\\n \"intro_video\": **null**,\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI2Zjc5YWI3YS1hOTkwLTQ3YzYtOWExNy1kNWE2YjE2MzZlYTIiLCJqdGkiOiIwNjdiZTU3YjA4YmJjM2MwMzA1MTAwZDQ0OWNiZTI3ZWRiYjFmZmQ0YjE0NzFhZDE5ZGEzMzExNDNmZGFiOTE1MmU4MmI3NjE4NjhmYjhhMiIsImlhdCI6MTcxODM3MjY4Ny4wMTI4NzgsIm5iZiI6MTcxODM3MjY4Ny4wMTI4NzksImV4cCI6MTcxODQ1OTA4Ny4wMTExNDgsInN1YiI6ImFmZTZjYjdlLWYyMWUtNGM5Mi1iZmE2LTM5YThiMjRjMzM3NiIsInNjb3BlcyI6WyIqIl19.bUuUgkoq9sdFCyXKR0AM9--2NOYNnm8AK5v8iJHC4WeOkR4ufsoZPF_QnMjF7NDPn_ny7TBc-I9ifuif_ewsRmzkIB5-tr0Aig-wW5wepqfTSrNCKDXuNjWYaiFUjQHFMBOYstj6gDIU1XSTA0YwoRsGDkr8Dk8p35bHFVHyjtQxU31CIaPOS96pia7tov_3NPCdroCrZUTAi6-l-EzSq7XCnuXcDGJ2ngZJAeSKXraqNShtOsfKoGGvv8pLzQfoi3SgdudRh4jBVDENAdmppAqkP74h3zp4cW9Jh1gIGQU0o72MmjDSem2aWyqpwtxoQejt39-rKR3_EtXsuoDh7m1V_ezAqimaN__TMAgvQGCG_RF9g7yoHhPtIoqfrTxcHTtSld6YspItIpLfeBv1SwBAmR3V32iWdCFmlZ5JmeLWqA0IwuVb-w4E-4fagFSMoIcJzhzw4RL7HM9iMd0c3vbDkY-uXTrJPI4P_XhBDgq1JsywX3Doxpt19j0s-Lv9CWtrtOcSOPeTPFHRKYZUtVdvKIklQDk-7GrA4rdKTaf4qBUGtp6XMbuwCUAvyw-uAbmeHKyu5z5k0w5UWjeWPPrMiUYUzPK9l1md0SQbTC-lrAkGEki30crlZdP1_4tidw1hoYhYE8qL5FTAF9WwQ0qiM9OGx4bQ7jugPpMRfpw\",\\\n \"refresh_token\": \"def50200d225a45d19f07c5b1ed519b57c603f4d550dae9c45c040a6e4deb52a90d26a10056bcd27dd2339c46bd628c74efa9a5edc60c0e5ceab6f3a05d718df499e73b051814bd49dd4a9ff5dc9621c5774ffedb032ece92676b80d22dcc6b24b6d4df839162ba5d3ad293180da49558f05f213ba8e7ea0d9b0b5d8ec254b61c3d7687c3e1fbedb4223f9e2608395f8c48f64686ca6a95b6af5100ef322aa447ab7c1d0af81a9174f8e2cbd89315f9db2e8b7555b49b09f0c3a2868fc05f54cccf3d89caeec5864d991b5e0248252f83dea124df0d8bdf119ab64ad16351112e22ef9ccd85043f6d12cbccb9f0d8f309fb0ccb70658e4ebc706f972e0e777b5427cfaecd84790ea895a6025b5faeaf123fb43b2c711052a3cb155d733c458703ffaf5200ea4dae45cafc5b2767ce84788ade148506cd9840b304aa70bf3acfa78ffa8935bb4ea309fa2ee1d5fa5a357e61804e7732e6ed4f52f6d06d236b48a44bfe8888f721eb5c784af48ca6637f5aa0563b74dfd8e3c81f72b6ed0a51ec7053c4e0694605681f165872e80232a99c5e9c17575a99bdc2ee9adf0a173e72708716c2d521811b454b29761\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n }\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=1\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=1\\\",)\\\n \"last\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\\\",)\\\n \"prev\": **null**,\\\n \"next\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\"](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\\\")\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 2,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=1\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=1\\\",)\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\\\",)\\\n \"label\": \"2\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers?page=2\\\",)\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"[http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers\",](http://api.mdintegrations.com/api/partners/34e883bd-df4d-4bf5-8252-d9e75ecc51f0/vouchers\\\",)\\\n \"per_page\": 15,\\\n \"to\": 15,\\\n \"total\": 26\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get voucher\n\nReturn voucher data for a voucher ID.\n\nYou may find additional details on embedding at [this](https://galactic-shadow-134413.postman.co/workspace/MD-Integrations~0bf566d7-bf01-4290-ab8e-1f3cf71a8da6/request/14212272-98004812-41bd-4771-915e-180ec888d420?action=share&source=copy-link&creator=14212272&ctx=documentation) documentation. ### Method: GET >>{{baseUrl}}/partner/vouchers/:voucher_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"partner_voucher_id\": \"a4d58fd0-2e64-4c9a-955a-a5fcc01584c1\",\\\n \"onboarding_url\": \"[https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\",](https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\\\",)\\\n \"expires_at\": \"2022-08-16 15:57:09\",\\\n \"expired\": **false**,\\\n \"case_id\": **null**,\\\n \"partner_questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"environment_id\": \"38da4bf4-3843-4cc3-83d1-13130daffdbd\",\\\n \"metadata\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"pharmacy_name\": **null**,\\\n \"partner\": {\\\n \"partner_id\": \"33778db3-8707-4628-81af-4c6451f9f0b6\",\\\n \"name\": \"Partner Name\",\\\n \"customer_support_email\": \"[customersupportexample@partnermail.com](mailto:customersupportexample@partnermail.com)\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"country_id\": \"1c62d5bd-83f0-4f80-b478-0c9471190248\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"image\": {\\\n \"path\": \"partners/3153a221-71a4-47d1-bcaa-bd1c932ede96.jpeg\",\\\n \"name\": \"Flag-United-States-of-America.jpeg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect\",](http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect?thumbnail=1\",](http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect?thumbnail=1\\\",)\\\n \"file_id\": \"784595d0-3aec-4ea0-bb80-d5ab3a722f71\"\\\n },\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\",\\\n \"decoration_image\": {\\\n \"path\": \"partners/818f5ff4-4d75-4735-993b-cc75571e5612.jpeg\",\\\n \"name\": \"IMG_1039_Original.JPG\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect\",](http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect?thumbnail=1\",](http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect?thumbnail=1\\\",)\\\n \"file_id\": \"8ac37c45-daa5-4189-a975-9872f56c5436\"\\\n }\\\n }\\\n },\\\n \"payload\": {\\\n \"hold_status\": **true**,\\\n \"patient_id\": \"cddc3d5f-2d86-4e0e-965c-967a20573bde\",\\\n \"offerings\": \\[\\\n {\\\n \"offering_id\": \"f7850441-c200-4673-aca9-4ee52e9fb6bf\",\\\n \"product\": {\\\n \"pharmacy_id\": 14,\\\n \"force_pharmacy\": **true**\\\n }\\\n },\\\n {\\\n \"offering_id\": \"e09b0f66-d0db-4c0f-850c-2ba7e31d9fe7\",\\\n \"product\": {\\\n \"pharmacy_id\": 22,\\\n \"force_pharmacy\": **true**\\\n }\\\n },\\\n {\\\n \"offering_id\": \"796ca3bb-19bc-477c-ba58-4016fe7943d5\"\\\n }\\\n \\],\\\n \"questionnaire_id\": \"cddc3d5f-2d86-4e0e-965c-373201ba0fd2\",\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\"\\\n }\\\n \\],\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI3NmUwMWM0My1lNWNlLTRlNzktYjE1Zi1iZjM5Yzc3ZjNhNzciLCJqdGkiOiIzNTM5YWRjNDU4NDhjNWY1NzI3Y2FhZjNlYjhlNjc0YzRhNzUxNDAzMWZlMTNlYmI2NjIzNjIxM2Y4YjRkNTE5YjVhOTY2MDIyYmRkMWZkMCIsImlhdCI6MTY3ODMxMDEzMi4xNjgzMDYsIm5iZiI6MTY3ODMxMDEzMi4xNjgzMSwiZXhwIjoxNjc4Mzk2NTMyLjE2NTE5NCwic3ViIjoiZmQ3ZDQwM2YtZTg1Zi00YWM3LTk1ODYtNWYyMjliNzk4NzVhIiwic2NvcGVzIjpbIioiXX0.xp_aeSBqMKBWmSJUuRQZp_Tk6Swh507y6RhZVs0a2fiV8uFnnP2ZJ-e5Ftcz0bTaKCXPSzRt2mjkrdd19_g200DZiP19B1MS1P25VXVYWpi_nsPgRJRgNc3-pW8PPYB0QShCrErnI-xGCj99AEnu-ZM6pEdoSYHtmMKQFecDpz075k721oMiq6sZYJsHF8XcTFKo8swwO89hRnUc8NZ1Iy_Iclew1EG2eH1QReIEsm7vtU2zSWo75uWKLoTC45_JxfjT4bEcMernuTBvyNIIH_fTb4-xwaAQzmX2BzfQOsolFKFJsevVJx1YX9PhZHsUjRsahSNRwhfRQKp6uHN_c7ThZVHNspk5T0tqMPA0UDhlPFayOktFdlED8cD1jn_DzicOye9t14pZJXHa4uQQFPANXSpd_w1ovxvzDVQI\\_-zGkIhnW0AUio_XmGGGx09kNoFGvVheFXGTtSFEeFsesfgA8cv4xfD98wsYa3NhBVov7VZHnmUKDmJ_Mns0NCf4LWfxBHrmHq_XdQ5-CJ5K-U68i-C-wASEafeA5ZX14TNbLghyB1DsXoISDKsUln20cf0o45grXbWQNiHdTHvl-n0Wrk2aNAbLvEFvh2ptuZa4Kco3fJbjoTb-HtIPkhHKIYpi0nEjFgCMXvHTP6tZ6s8R70hsSsxaT9IQ-xi-5UM\",\\\n \"refresh_token\": \"def5020022a29e6c2b059e8b0ce19de28915d00f1a27fe82fec414406935044166611e2240eb8c31f988efd4c960826bb1968511cb9aa5c2cd02b10ee7ec7bd87639083f24e591450d05bfb4668575016c53f8264fdece9471c1f9483ff7f4ca0d4ea3377afe25766958deb5e82e34961593a92ba68d85b84a1f3e0db2da813b1079875eb5c407c5cd898177b8ab79ab1c7bd45f5eaafc2fda2a92da4df26b5cf7a09983b18fccde4dcab8e075648562792a936c143de35177960ca99d26d77b81f3f363c8630d38d72b1a1cbf390999b7e22ff5816a4c81e4e8af33719b75439d9e25640b8bb33252971f57ffb353195c54dd3f51c35f34908a7831567ed849e46a88c5b86cdf7db760c42c1119726c12707660af82c4799b596462683c8b93aaf028e1879a40577efc9ef22ec8b06ed3e19fb30bc83a47cfc0a6071571f0357bd8265cb1cab9ad3a5caf23b88e6db1a2f2f91ba35b313f52702f0530be2c9ca0233f16255e3123bb1089eb185a6eb42308b6205df8ce471bb81122bc87e0fcf5788d68a5fb0feeccfd985ab6142cdad081a0975a4de4e180248fc38ebe68ce7e14d7d748bb76b648f3ad49\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create voucher\n\nCreates a new voucher.\n\n## Payload\n\n**Important**: when creating a voucher you can specify the medications, compounds and services to be used.\n\nfield\n\ntype\n\ndescription\n\n**questionnaire_id**\n\n**uuid**\\*\n\nPartner Questionnaire ID. It can be found on your company’s dashboard or using **Patient App > Questionnaires > List questionnaires**\n\npatient_id\n\nuuid\n\nPatient ID.\n\nhold_status\n\nboolean\n\nFlag to hold the status to not enter into the MDI flow. It will be **false** by default.\n\ndemo\n\nboolean\n\nDemo vouchers will not create any patient or cases and will not expire. Default false\n\nexpires_at\n\ndatetime\n\nIf not passed then the default will be a month ahead.\n\nofferings\n\narray\n\nIt can be empty\n\nofferings.**\\***.id\n\nuuid\\*\n\nThe offering ID. Check **Partners > Offerings** to get an offering_id for a given offering. Required if is present.\n\nofferings.\\*.product\n\nobject\n\nContains fields that are specific to each offering type, such as pharmacy_id or force_pharmacy.\n\nofferings.\\*.[product.pharmacy](http://product.pharmacy)\\_id\n\ninteger\\*\n\nThe pharmacy id you would like to use for the specific offering. Only applies to Dosespot offerings.\n\nofferings.\\*.product.force_pharmacy\n\nboolean\\*\n\nDetermines whether we should apply the selected pharmacy_id (from payload or offering) regardless if user selects a different pharmacy on the intake form. Only applies to Dosespot offerings.\n\ndiseases\n\narray\n\nit can be empty or null.\n\ndiseases.\\*.disease_id\n\nuuid\n\nDisease ID. It can be found on your company’s dashboard or through the diseases endpoint. Nullable.\n\nmetadata\n\nstring (255)\n\nMetadata value. It can be empty or null.\n\npharmacy_id\n\ninteger\n\nhe Dosespot Pharmacy ID. Check **Partners** > **Pharmacies** > **Get pharmacies** to get a list of all pharmacies available.\n\nYou may find additional details on embedding [here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#9170cf8f-851d-466d-9202-0139a532c18f). ### Method: POST >>{{baseUrl}}/partner/vouchers > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"demo\": **true**,\\\n \"hold_status\": **true**,\\\n \"expires_at\": \"2024-12-12 18:00\",\\\n \"patient_id\": \"492c6b42-9f31-45fa-83c1-f9b83c6fd87b\",\\\n \"offerings\": \\[\\\n {\\\n \"id\": \"e09b0f66-d0db-4c0f-850c-2ba7e31d9fe7\",\\\n \"product\": {\\\n \"pharmacy_id\": 123,\\\n \"force_pharmacy\": **false**\\\n }\\\n }\\\n \\],\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\"\\\n }\\\n \\],\\\n \"pharmacy_id\": **null**\\\n}\n\n### Response: undefined\n\n{\\\n \"partner_voucher_id\": \"a4d58fd0-2e64-4c9a-955a-a5fcc01584c1\",\\\n \"onboarding_url\": \"[https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\",](https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\\\",)\\\n \"expires_at\": \"2022-08-16 15:57:09\",\\\n \"expired\": **false**,\\\n \"demo\": **true**,\\\n \"case_id\": **null**,\\\n \"partner_questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"environment_id\": \"38da4bf4-3843-4cc3-83d1-13130daffdbd\",\\\n \"metadata\": **null**,\\\n \"partner\": {\\\n \"partner_id\": \"33778db3-8707-4628-81af-4c6451f9f0b6\",\\\n \"name\": \"Partner Name\",\\\n \"customer_support_email\": \"[customersupportexample@partnermail.com](mailto:customersupportexample@partnermail.com)\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"operation_country\": {\\\n \"country_id\": \"1c62d5bd-83f0-4f80-b478-0c9471190248\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n },\\\n \"image\": {\\\n \"path\": \"partners/3153a221-71a4-47d1-bcaa-bd1c932ede96.jpeg\",\\\n \"name\": \"Flag-United-States-of-America.jpeg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect\",](http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect?thumbnail=1\",](http://api.mdintegrations.com/v1/files/784595d0-3aec-4ea0-bb80-d5ab3a722f71/redirect?thumbnail=1\\\",)\\\n \"file_id\": \"784595d0-3aec-4ea0-bb80-d5ab3a722f71\"\\\n },\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\",\\\n \"decoration_image\": {\\\n \"path\": \"partners/818f5ff4-4d75-4735-993b-cc75571e5612.jpeg\",\\\n \"name\": \"IMG_1039_Original.JPG\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect\",](http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect\\\",)\\\n \"url_thumbnail\": \"[http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect?thumbnail=1\",](http://api.mdintegrations.com/v1/files/8ac37c45-daa5-4189-a975-9872f56c5436/redirect?thumbnail=1\\\",)\\\n \"file_id\": \"8ac37c45-daa5-4189-a975-9872f56c5436\"\\\n }\\\n }\\\n },\\\n \"payload\": {\\\n \"hold_status\": **true**,\\\n \"patient_id\": \"cddc3d5f-2d86-4e0e-965c-373201ba0fd2\",\\\n \"questionnaire_id\": \"cddc3d5f-2d86-4e0e-965c-373201ba0fd2\",\\\n \"environment_id\": \"314b0cbe-0e35-4049-b27d-8eee486e03b4\",\\\n \"offerings\": \\[\\\n {\\\n \"offering_id\": \"f7850441-c200-4673-aca9-4ee52e9fb6bf\",\\\n \"product\": {\\\n \"pharmacy_id\": 14,\\\n \"force_pharmacy\": **true**\\\n }\\\n },\\\n {\\\n \"offering_id\": \"e09b0f66-d0db-4c0f-850c-2ba7e31d9fe7\",\\\n \"product\": {\\\n \"pharmacy_id\": 22,\\\n \"force_pharmacy\": **true**\\\n }\\\n },\\\n {\\\n \"offering_id\": \"796ca3bb-19bc-477c-ba58-4016fe7943d5\"\\\n }\\\n \\],\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"32f62f6e-32b7-4145-a375-15a2bd8b8dfa\"\\\n }\\\n \\],\\\n \"patient_auth\": {\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI3NmUwMWM0My1lNWNlLTRlNzktYjE1Zi1iZjM5Yzc3ZjNhNzciLCJqdGkiOiIzNTM5YWRjNDU4NDhjNWY1NzI3Y2FhZjNlYjhlNjc0YzRhNzUxNDAzMWZlMTNlYmI2NjIzNjIxM2Y4YjRkNTE5YjVhOTY2MDIyYmRkMWZkMCIsImlhdCI6MTY3ODMxMDEzMi4xNjgzMDYsIm5iZiI6MTY3ODMxMDEzMi4xNjgzMSwiZXhwIjoxNjc4Mzk2NTMyLjE2NTE5NCwic3ViIjoiZmQ3ZDQwM2YtZTg1Zi00YWM3LTk1ODYtNWYyMjliNzk4NzVhIiwic2NvcGVzIjpbIioiXX0.xp_aeSBqMKBWmSJUuRQZp_Tk6Swh507y6RhZVs0a2fiV8uFnnP2ZJ-e5Ftcz0bTaKCXPSzRt2mjkrdd19_g200DZiP19B1MS1P25VXVYWpi_nsPgRJRgNc3-pW8PPYB0QShCrErnI-xGCj99AEnu-ZM6pEdoSYHtmMKQFecDpz075k721oMiq6sZYJsHF8XcTFKo8swwO89hRnUc8NZ1Iy_Iclew1EG2eH1QReIEsm7vtU2zSWo75uWKLoTC45_JxfjT4bEcMernuTBvyNIIH_fTb4-xwaAQzmX2BzfQOsolFKFJsevVJx1YX9PhZHsUjRsahSNRwhfRQKp6uHN_c7ThZVHNspk5T0tqMPA0UDhlPFayOktFdlED8cD1jn_DzicOye9t14pZJXHa4uQQFPANXSpd_w1ovxvzDVQI\\_-zGkIhnW0AUio_XmGGGx09kNoFGvVheFXGTtSFEeFsesfgA8cv4xfD98wsYa3NhBVov7VZHnmUKDmJ_Mns0NCf4LWfxBHrmHq_XdQ5-CJ5K-U68i-C-wASEafeA5ZX14TNbLghyB1DsXoISDKsUln20cf0o45grXbWQNiHdTHvl-n0Wrk2aNAbLvEFvh2ptuZa4Kco3fJbjoTb-HtIPkhHKIYpi0nEjFgCMXvHTP6tZ6s8R70hsSsxaT9IQ-xi-5UM\",\\\n \"refresh_token\": \"def5020022a29e6c2b059e8b0ce19de28915d00f1a27fe82fec414406935044166611e2240eb8c31f988efd4c960826bb1968511cb9aa5c2cd02b10ee7ec7bd87639083f24e591450d05bfb4668575016c53f8264fdece9471c1f9483ff7f4ca0d4ea3377afe25766958deb5e82e34961593a92ba68d85b84a1f3e0db2da813b1079875eb5c407c5cd898177b8ab79ab1c7bd45f5eaafc2fda2a92da4df26b5cf7a09983b18fccde4dcab8e075648562792a936c143de35177960ca99d26d77b81f3f363c8630d38d72b1a1cbf390999b7e22ff5816a4c81e4e8af33719b75439d9e25640b8bb33252971f57ffb353195c54dd3f51c35f34908a7831567ed849e46a88c5b86cdf7db760c42c1119726c12707660af82c4799b596462683c8b93aaf028e1879a40577efc9ef22ec8b06ed3e19fb30bc83a47cfc0a6071571f0357bd8265cb1cab9ad3a5caf23b88e6db1a2f2f91ba35b313f52702f0530be2c9ca0233f16255e3123bb1089eb185a6eb42308b6205df8ce471bb81122bc87e0fcf5788d68a5fb0feeccfd985ab6142cdad081a0975a4de4e180248fc38ebe68ce7e14d7d748bb76b648f3ad49\",\\\n \"expires_in\": 86400,\\\n \"token_type\": \"Bearer\"\\\n }\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Expire Voucher\n\nExpires the partner’s voucher. ### Method: POST >>{{baseUrl}}/partner/vouchers/:voucher_id/expire > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: undefined\n\n{\\\n \"id\": \"cb8f4ec2-837d-4375-ba1b-917a1a21a506\",\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"case_id\": **null**,\\\n \"partner_questionnaire_id\": \"fa6d01b6-57ce-41cb-bf4f-3388a5fb1dac\",\\\n \"environment_id\": \"38da4bf4-3843-4cc3-83d1-13130daffdbd\",\\\n \"expires_at\": \"2023-11-28T22:41:13.000000Z\",\\\n \"payload\": {\\\n \"hold_status\": **false**,\\\n \"environment_id\": \"da4083f5-436b-491e-9bc1-73507061cd01\",\\\n \"questionnaire_id\": \"7424a442-6287-4637-a26b-f1d0e850ad0b\"\\\n },\\\n \"demo\": **false**,\\\n \"created_at\": \"2023-11-28T17:45:36.000000Z\",\\\n \"updated_at\": \"2023-11-28T22:41:13.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"is_expired\": **true**,\\\n \"onboarding_url\": \"[https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\"](https://patient.mdintegrations.dev/?token=91c7bd33-6161-4112-96a3-f46c297689dc\\\")\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Delete Voucher\n\nDeletes the partner’s voucher. ### Method: DELETE >>{{baseUrl}}/partner/vouchers/:voucher_id > ### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### Response: undefined\n\n**null**\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Boothwyn undefined\n\n## End-point: Search Offerings\n\nSearch Boothwyn offering using a given name. ### Method: GET >>{{url}}/v1/partner/boothwyn/search?name=Semaglutide > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\nname\n\nSemaglutide\n\nfalse\n\n### Response: 200\n\n\\[\\\n {\\\n \"dispensable_drug_id\": **null**,\\\n \"routed_dose_form_drug_id\": **null**,\\\n \"ndc\": \"70710102308\",\\\n \"rx_cui\": **null**,\\\n \"name_with_route_dose_form\": \"ISOtretinoin Oral Capsule\",\\\n \"strength\": \"20 MG\",\\\n \"is_obsolete\": **false**,\\\n \"name\": \"ISOtretinoin Oral Capsule 20 MG\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Dosespot undefined\n\n## End-point: Search Dosespot Supplies\n\nSearch DoseSpot supplies based on name and/or NDC.\n\nThis API endpoint forwards the request to DoseSpot API in order to retrieve the supplies. ### Method: GET >>{{url}}/v1/partner/supplies/search?name=Masks > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Query Params\n\nParam\n\nvalue\n\nname\n\nMasks\n\nndc\n\n1234567890\n\n### Response: 200\n\n\\[\\\n {\\\n \"dosespot_supply_id\": 14710,\\\n \"supply_id\": 14710,\\\n \"ndc\": **null**,\\\n \"upc\": \"Supply\",\\\n \"name\": \"Masks Miscellaneous\",\\\n \"otc\": **true**,\\\n \"is_obsolete\": **false**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Search Dosespot Medications\n\nSearch DoseSpot medications using a given name.\n\nThis API endpoint forwards the request to DoseSpot API in order to retrieve the medications.\n\nThe returned results can be used to get details for a given medication (check **“Partner > Medications > Get Details For a Specific Medication”**). ### Method: GET >>{{url}}/v1/partner/medications/search?name=Isotretinoin > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Doe\",\\\n \"gender\": 1,\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"phone_number\": \"(415) 555-2671\",\\\n \"phone_type\": 2,\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York, NY 10029\",\\\n \"city_id\": \"992cf0e7-1d94-4c56-8b19-6f85634aa33a\",\\\n \"zip_code\": \"12345\"\\\n },\\\n \"weight\": 50,\\\n \"height\": 180,\\\n \"current_medications\": \"paracetamol\",\\\n \"allergies\": \"polen\"\\\n}\n\n### Query Params\n\nParam\n\nvalue\n\nname\n\nIsotretinoin\n\nfalse\n\n### Response: 200\n\n\\[\\\n {\\\n \"dispensable_drug_id\": **null**,\\\n \"routed_dose_form_drug_id\": **null**,\\\n \"ndc\": \"70710102308\",\\\n \"rx_cui\": **null**,\\\n \"name_with_route_dose_form\": \"ISOtretinoin Oral Capsule\",\\\n \"strength\": \"20 MG\",\\\n \"is_obsolete\": **false**,\\\n \"name\": \"ISOtretinoin Oral Capsule 20 MG\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Details For a Specific Medication\n\nGet DoseSpot medication details according given **name** and **strength**.\n\nThis API endpoint forwards the request to Dosespot in order to retrieve the medication details. ### Method: GET >>{{url}}/v1/partner/medications/select?dispensable_drug_id=1234567&ndc=098765431&rxcui=654311 > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Query Params\n\nParam\n\nvalue\n\ndispensable_drug_id\n\n1234567\n\nndc\n\n098765431\n\nrxcui\n\n654311\n\n### Response: 200\n\n{\\\n \"ndc\": \"00245057001\",\\\n \"rx_cui\": \"197843\",\\\n \"display_name\": \"ISOtretinoin (Eqv-Absorica) 10 mg capsule\",\\\n \"route\": \"oral\",\\\n \"dose_form\": \"capsule\",\\\n \"strength\": \"10 mg\",\\\n \"dispense_unit_id\": 4,\\\n \"brand\": **false**,\\\n \"otc\": **false**,\\\n \"drug_classification\": \"antineoplastics\",\\\n \"schedule\": \"0\",\\\n \"state_schedules\": \\[\\],\\\n \"lexi_gen_product_id\": 2062,\\\n \"lexi_drug_syn_id\": 347217,\\\n \"lexi_synonym_type_id\": 60,\\\n \"lexi_gen_drug_id\": \"d01245\",\\\n \"generic_product_name\": \"ISOtretinoin 10 mg oral capsule\",\\\n \"compound_ingredients\": **null**\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get all offerings\n\nGet all registered offerings. ### Method: GET >>{{baseUrl}}/partner/offerings > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n### Response: 200\n\n\\[\\\n {\\\n \"dosespot_rxcui\": 1747294,\\\n \"active\": **true**,\\\n \"is_additional_approval_needed\": **true**,\\\n \"ndc\": \"39822103001\",\\\n \"days_supply\": 1,\\\n \"refills\": 1,\\\n \"name\": \"Ibuprofen (intravenous - solution)\",\\\n \"pharmacy_notes\": \"This an example\",\\\n \"directions\": \"take once a day\",\\\n \"quantity\": \"1\",\\\n \"dispense_unit\": \"Bottle\",\\\n \"strength\": \"10 mg/mL\",\\\n \"dispense_unit_id\": 2,\\\n \"pharmacy_id\": 13012,\\\n \"pharmacy_name\": \"Curexa\",\\\n \"order\": 1,\\\n \"metadata\": \"metadata example\",\\\n \"thank_you_note\": \"thank you note example\",\\\n \"clinical_note\": \"clinical note example\",\\\n \"partner_medication_id\": \"ded742a4-2dc9-4fc6-9bd3-fa96924b1823\",\\\n \"title\": \"Ibuprofen\",\\\n \"allow_substitutions\": **true**\\\n },\\\n {\\\n \"dosespot_rxcui\": 1747294,\\\n \"active\": **true**,\\\n \"ndc\": \"39822103001\",\\\n \"days_supply\": 1,\\\n \"refills\": 1,\\\n \"name\": \"Ibuprofen (intravenous - solution)\",\\\n \"pharmacy_notes\": \"This an example\",\\\n \"directions\": \"take once a day\",\\\n \"quantity\": \"1\",\\\n \"dispense_unit\": \"Bottle\",\\\n \"strength\": \"10 mg/mL\",\\\n \"dispense_unit_id\": 2,\\\n \"pharmacy_id\": 13012,\\\n \"pharmacy_name\": \"Curexa\",\\\n \"order\": 2,\\\n \"metadata\": \"metadata example\",\\\n \"thank_you_note\": \"thank you note example\",\\\n \"clinical_note\": \"clinical note example\",\\\n \"partner_medication_id\": \"ded742a4-2dc9-4fc6-9bd3-fa96924b1823\",\\\n \"title\": \"Ibuprofen\",\\\n \"allow_substitutions\": **true**,\\\n \"effective_date\": \"60\"\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Questions undefined\n\n## End-point: List questions\n\nReturn all questions given a questionnaire ID. ### Method: GET >>{{baseUrl}}/partner/questionnaires/:questionnaire_id/questions > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n\\[\\\n {\\\n \"partner_questionnaire_question_id\": \"e13c9b2b-d6b1-4a94-802e-8b6746fcc595\",\\\n \"title\": \"Multiple option Question title example\",\\\n \"description\": \"Question description example\",\\\n \"label\": \"Label text example\",\\\n \"placeholder\": \"Placeholder example\",\\\n \"is_important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **true**,\\\n \"is_visible\": **false**,\\\n \"order\": 1,\\\n \"type\": \"multiple_option\",\\\n \"default_value\": **null**,\\\n \"options\": \\[\\\n {\\\n \"option\": \"First option\",\\\n \"is_important\": **false**,\\\n \"is_show_additional_field\": **false**\\\n },\\\n {\\\n \"option\": \"Second option\",\\\n \"is_important\": **false**,\\\n \"is_show_additional_field\": **false**\\\n },\\\n {\\\n \"option\": \"Third option\",\\\n \"is_important\": **true**,\\\n \"is_show_additional_field\": **false**\\\n }\\\n \\],\\\n \"feed_ads\": **false**\\\n },\\\n {\\\n \"partner_questionnaire_question_id\": \"e13c9b2b-d6b1-4a94-802e-8b6746fcc595\",\\\n \"title\": \"String Question title example\",\\\n \"description\": \"Question description example\",\\\n \"label\": \"Label text example\",\\\n \"placeholder\": \"Placeholder example\",\\\n \"is_important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **true**,\\\n \"is_visible\": **false**,\\\n \"order\": 2,\\\n \"type\": \"string\",\\\n \"default_value\": **null**,\\\n \"options\": **null**,\\\n \"feed_ads\": **false**\\\n }\\\n\\]\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: List questionnaires\n\nReturn all enabled partner questionnaires based on the logged in partner. ### Method: GET >>{{baseUrl}}/partner/questionnaires > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n\\[\\\n {\\\n \"partner_questionnaire_id\": \"54b98d56-4ef9-4512-9918-01ec6860edef\",\\\n \"active\": **true**,\\\n \"name\": \"intake to test\",\\\n \"intro_title\": \"intake to test\",\\\n \"intro_description\": \"intake to test\",\\\n \"outro_title\": \"intake to test\",\\\n \"outro_description\": \"intake to test\",\\\n \"redirect_url\": **null**,\\\n \"redirect_title\": **null**,\\\n \"has_pharmacy\": **false**,\\\n \"terms_of_service\": **null**,\\\n \"metadata\": **null**,\\\n \"is_weight_asked\": **false**,\\\n \"is_height_asked\": **false**,\\\n \"questions\": \\[\\\n {\\\n \"partner_questionnaire_question_id\": \"2d3aa5aa-4b0e-48a1-8cb1-4301a493330f\",\\\n \"title\": \"test\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 1,\\\n \"type\": \"boolean\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\]\\\n },\\\n {\\\n \"partner_questionnaire_question_id\": \"2e65a086-3dff-4012-995e-fdfd9b804eac\",\\\n \"title\": \"options with offering\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 2,\\\n \"type\": \"text\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\]\\\n },\\\n {\\\n \"partner_questionnaire_question_id\": \"f7c3746e-edbd-415b-82ad-f7ce28a8e5c6\",\\\n \"title\": \"options with offerings\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 3,\\\n \"type\": \"multiple_option\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\\n {\\\n \"partner_questionnaire_question_option_id\": \"fbc24c1f-cd21-4995-990a-c7c47bba23a5\",\\\n \"title\": \"with medication\",\\\n \"option\": \"with medication\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 1\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"b561c164-a6b8-4641-a300-b934119af5f4\",\\\n \"title\": \"with compounds\",\\\n \"option\": \"with compounds\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 2\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"6f4a2f55-c7dd-4f82-bad6-60fd658dab39\",\\\n \"title\": \"with supply\",\\\n \"option\": \"with supply\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 3\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"143a022a-ef3f-4ccf-a6d1-b8a609ff75d7\",\\\n \"title\": \"with services\",\\\n \"option\": \"with services\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 4\\\n }\\\n \\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\\n {\\\n \"id\": \"b9fe55c9-d194-4f72-b240-68c84a187ff6\",\\\n \"title\": \"Rule - options with offerings\",\\\n \"type\": \"and\",\\\n \"requirements\": \\[\\\n {\\\n \"based_on\": \"age\",\\\n \"required_question_id\": **null**,\\\n \"required_question_title\": **null**,\\\n \"conditional_answer\": \"=\",\\\n \"required_answer\": \"20\"\\\n }\\\n \\]\\\n }\\\n \\]\\\n }\\\n \\],\\\n \"offerings\": { \\\n \"offering_id\": \"1a03114c-c1b0-413b-8a36-4b8957d9925e\",\\\n \"title\": \"supply to delete\",\\\n \"pharmacy_id\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"rule_type\": \"and\",\\\n \"rules\": \\[\\\n {\\\n \"id\": \"ebe846b0-6b21-418a-85a2-0005cada5abf\",\\\n \"title\": \"Rule - medication to delete\",\\\n \"type\": \"or\",\\\n \"requirements\": \\[\\\n {\\\n \"based_on\": \"gender\",\\\n \"required_question_id\": **null**,\\\n \"required_question_title\": **null**,\\\n \"conditional_answer\": **null**,\\\n \"required_answer\": \"1\"\\\n }\\\n \\]\\\n }\\\n \\]\\\n }\\\n**\\]**\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get questionnaire\n\nReturn the specific enabled partner questionnaire given a questionnaire ID. ### Method: GET >>{{baseUrl}}/partner/questionnaires/:questionnaire_id > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Response: undefined\n\n{\\\n \"partner_questionnaire_id\": \"54b98d56-4ef9-4512-9918-01ec6860edef\",\\\n \"active\": **true**,\\\n \"name\": \"intake to test\",\\\n \"intro_title\": \"intake to test\",\\\n \"intro_description\": \"intake to test\",\\\n \"outro_title\": \"intake to test\",\\\n \"outro_description\": \"intake to test\",\\\n \"redirect_url\": **null**,\\\n \"redirect_title\": **null**,\\\n \"has_pharmacy\": **false**,\\\n \"terms_of_service\": **null**,\\\n \"metadata\": **null**,\\\n \"is_weight_asked\": **false**,\\\n \"is_height_asked\": **false**,\\\n \"is_show_welcome\": **true**,\\\n \"is_show_thanks\": **true**,\\\n \"questions\": \\[\\\n {\\\n \"partner_questionnaire_question_id\": \"2d3aa5aa-4b0e-48a1-8cb1-4301a493330f\",\\\n \"title\": \"test\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 1,\\\n \"type\": \"boolean\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\]\\\n },\\\n {\\\n \"partner_questionnaire_question_id\": \"2e65a086-3dff-4012-995e-fdfd9b804eac\",\\\n \"title\": \"options with offering\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 2,\\\n \"type\": \"text\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\]\\\n },\\\n {\\\n \"partner_questionnaire_question_id\": \"f7c3746e-edbd-415b-82ad-f7ce28a8e5c6\",\\\n \"title\": \"options with offerings\",\\\n \"description\": **null**,\\\n \"label\": **null**,\\\n \"placeholder\": **null**,\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"display_in_pdf\": **false**,\\\n \"is_optional\": **false**,\\\n \"is_visible\": **true**,\\\n \"has_next_button\": **true**,\\\n \"has_back_button\": **true**,\\\n \"order\": 3,\\\n \"type\": \"multiple_option\",\\\n \"default_value\": **null**,\\\n \"feed_ads\": **null**,\\\n \"rule_type\": \"and\",\\\n \"options\": \\[\\\n {\\\n \"partner_questionnaire_question_option_id\": \"fbc24c1f-cd21-4995-990a-c7c47bba23a5\",\\\n \"title\": \"with medication\",\\\n \"option\": \"with medication\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 1\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"b561c164-a6b8-4641-a300-b934119af5f4\",\\\n \"title\": \"with compounds\",\\\n \"option\": \"with compounds\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 2\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"6f4a2f55-c7dd-4f82-bad6-60fd658dab39\",\\\n \"title\": \"with supply\",\\\n \"option\": \"with supply\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 3\\\n },\\\n {\\\n \"partner_questionnaire_question_option_id\": \"143a022a-ef3f-4ccf-a6d1-b8a609ff75d7\",\\\n \"title\": \"with services\",\\\n \"option\": \"with services\",\\\n \"is_important\": **false**,\\\n \"is_critical\": **false**,\\\n \"is_show_additional_field\": **false**,\\\n \"order\": 4\\\n }\\\n \\],\\\n \"attachments\": \\[\\],\\\n \"rules\": \\[\\\n {\\\n \"id\": \"b9fe55c9-d194-4f72-b240-68c84a187ff6\",\\\n \"title\": \"Rule - options with offerings\",\\\n \"type\": \"and\",\\\n \"requirements\": \\[\\\n {\\\n \"based_on\": \"age\",\\\n \"required_question_id\": **null**,\\\n \"required_question_title\": **null**,\\\n \"conditional_answer\": \"=\",\\\n \"required_answer\": \"20\"\\\n }\\\n \\]\\\n }\\\n \\]\\\n }\\\n \\],\\\n \"offerings\": { \\\n \"offering_id\": \"1a03114c-c1b0-413b-8a36-4b8957d9925e\",\\\n \"title\": \"supply to delete\",\\\n \"pharmacy_id\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"rule_type\": \"and\",\\\n \"rules\": \\[\\\n {\\\n \"id\": \"ebe846b0-6b21-418a-85a2-0005cada5abf\",\\\n \"title\": \"Rule - medication to delete\",\\\n \"type\": \"or\",\\\n \"requirements\": \\[\\\n {\\\n \"based_on\": \"gender\",\\\n \"required_question_id\": **null**,\\\n \"required_question_title\": **null**,\\\n \"conditional_answer\": **null**,\\\n \"required_answer\": \"1\"\\\n }\\\n \\]\\\n }\\\n \\]\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get clinician information\n\nGet clinician information based on the passed clinician_id. ### Method: GET >>{{baseUrl}}/partner/clinicians/:clinician_id > ### Response: undefined\n\n{\\\n \"clinician_id\": \"30be583a-38ae-48a6-bee9-5babb9df6d7e\",\\\n \"is_online\": **true**,\\\n \"specialty\": \"General Practice\",\\\n \"full_name\": \"John Doe\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Doe\",\\\n \"date_of_birth\": \"1990-05-11\",\\\n \"suffix\": \"M.D\",\\\n \"email\": \"[john@doe.com](mailto:john@doe.com)\",\\\n \"phone_number\": \"541-754-3010\",\\\n \"phone_type\": \"2\",\\\n \"fax_number\": \"(541) 111-5555\",\\\n \"profile_url\": \"[http://profileurlexample.com\",](http://profileurlexample.com\\\",)\\\n \"photo\": {\\\n \"file_id\": \"80d2b683-4c3b-401b-a188-ffc875aabc68\",\\\n \"path\": \"partners/1696944117\\_[05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp](http://05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp)4\",\\\n \"name\": \"[05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp](http://05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp)4\",\\\n \"mime_type\": \"video/mp4\",\\\n \"url\": \"[https://localhost:8002/s3/files/80d2b683-4c3b-401b-a188-ffc875aabc68/file?signature=91c790a02ff38532912c63ca8afad8e8d902c30e79cb142c623ec6669291b9bf\",](https://localhost:8002/s3/files/80d2b683-4c3b-401b-a188-ffc875aabc68/file?signature=91c790a02ff38532912c63ca8afad8e8d902c30e79cb142c623ec6669291b9bf\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-10-10T13:22:02.000000Z\"\\\n },\\\n \"licenses\": \\[\\\n {\\\n \"license_id\": \"897e23f0-ecee-410a-a37c-af633e221e0b\",\\\n \"type\": \"npi\",\\\n \"value\": \"1124790829\"\\\n }\\\n \\],\\\n \"practice_areas\": \\[\\\n {\\\n \"clinician_practice_area_id\": \"0508e3ff-cba2-4516-ba5b-6bfd7cbc6533\",\\\n \"is_expired\": **false**,\\\n \"expires_at\": \"2023-09-10T00:00:00.000000Z\",\\\n \"license_number\": \"123NPI321EXAMPLE\",\\\n \"state\": {\\\n \"name\": \"Tasmania\",\\\n \"abbreviation\": \"TAS\",\\\n \"state_id\": \"8620acdb-2129-423f-9703-c9ad89c6e02c\",\\\n \"country\": {\\\n \"country_id\": \"ecb311fb-045a-4643-9d61-ef49cce0c2b6\",\\\n \"name\": \"Australia\",\\\n \"abbreviation\": \"AU\"\\\n },\\\n \"is_av_flow\": **false**\\\n }\\\n }\\\n \\],\\\n \"bio_details\": \"Here is a bio detail example.\",\\\n \"automatic_sync_message\": **null**,\\\n \"is_message_availability\": **false**,\\\n \"case_assignment_availability\": **false**,\\\n \"active\": **true**,\\\n \"is_out_of_office\": **true**,\\\n \"out_of_office_message\": \"Out of office message\",\\\n \"managed_by_partner\": **true**,\\\n \"automatic_sync_video_file\": {\\\n \"file_id\": \"80d2b683-4c3b-401b-a188-ffc875aabc68\",\\\n \"path\": \"partners/1696944117\\_[05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp](http://05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp)4\",\\\n \"name\": \"[05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp](http://05e0af4f-aa7a-4096-b915-ba48d246c9ea.mp)4\",\\\n \"mime_type\": \"video/mp4\",\\\n \"url\": \"[https://localhost:8002/s3/files/80d2b683-4c3b-401b-a188-ffc875aabc68/file?signature=91c790a02ff38532912c63ca8afad8e8d902c30e79cb142c623ec6669291b9bf\",](https://localhost:8002/s3/files/80d2b683-4c3b-401b-a188-ffc875aabc68/file?signature=91c790a02ff38532912c63ca8afad8e8d902c30e79cb142c623ec6669291b9bf\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-10-10T13:22:02.000000Z\"\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get support staff information\n\nIt gets the internal support staff details. ### Method: GET >>{{baseUrl}}/partner/support-staffs/:support_staff_id > ### Response: undefined\n\n{\\\n \"id\": \"df8d41d2-06bc-47fc-80c7-1de06c9ed618\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Support\",\\\n \"email\": \"[john+support@mdintegrations.com](mailto:john+support@mdintegrations.com)\",\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"timezone_id\": \"c8e296d5-17fe-469e-9a9c-333211bf12d9\",\\\n \"created_at\": \"2024-11-29T19:52:11.000000Z\",\\\n \"updated_at\": \"2025-01-16T19:39:35.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"John Support\",\\\n \"is_online\": **false**,\\\n \"can_unlock_phi\": **null**,\\\n \"photo\": **null**,\\\n \"roles\": \\[\\\n {\\\n \"id\": \"92f0d82a-22d3-4ea9-95c6-ec37b8d15a75\",\\\n \"name\": \"support\",\\\n \"created_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"updated_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"pivot\": {\\\n \"role_id\": \"92f0d82a-22d3-4ea9-95c6-ec37b8d15a75\",\\\n \"model_id\": \"df8d41d2-06bc-47fc-80c7-1de06c9ed618\",\\\n \"model_type\": **null**,\\\n \"created_at\": **null**,\\\n \"updated_at\": **null**\\\n }\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get internal support staff information\n\nIt gets the internal support staff details (MDI Support users). ### Method: GET >>{{baseUrl}}/partner/internal-support-staffs/:internal_support_staff_id > ### Response: undefined\n\n{\\\n \"id\": \"df8d41d2-06bc-47fc-80c7-1de06c9ed618\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Internal Support\",\\\n \"email\": \"[john+internal+support@mdintegrations.com](mailto:john+internal+support@mdintegrations.com)\",\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"timezone_id\": \"c8e296d5-17fe-469e-9a9c-333211bf12d9\",\\\n \"created_at\": \"2024-11-29T19:52:11.000000Z\",\\\n \"updated_at\": \"2025-01-16T19:39:35.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"John Internal Support\",\\\n \"is_online\": **false**,\\\n \"can_unlock_phi\": **null**,\\\n \"photo\": **null**,\\\n \"roles\": \\[\\\n {\\\n \"id\": \"92f0d82a-22d3-4ea9-95c6-ec37b8d15a75\",\\\n \"name\": \"internal-support\",\\\n \"created_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"updated_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"pivot\": {\\\n \"role_id\": \"92f0d82a-22d3-4ea9-95c6-ec37b8d15a75\",\\\n \"model_id\": \"df8d41d2-06bc-47fc-80c7-1de06c9ed618\",\\\n \"model_type\": **null**,\\\n \"created_at\": **null**,\\\n \"updated_at\": **null**\\\n }\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get medical assistant information\n\nIt gets the internal support staff details (MDI Support users). ### Method: GET >>{{baseUrl}}/partner/medical-assistants/:medical_assistant_id > ### Response: undefined\n\n{\\\n \"id\": \"cd13558f-9ed3-4f6d-af6f-3a39a3c630d6\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Medical Assistant\",\\\n \"email\": \"[john+assistant@mdintegrations.com](mailto:john+assistant@mdintegrations.com)\",\\\n \"photo_id\": **null**,\\\n \"active\": **true**,\\\n \"timezone_id\": \"9f71bbb6-f989-46e3-a0d7-ad0740257a5a\",\\\n \"created_at\": \"2025-02-11T19:50:29.000000Z\",\\\n \"updated_at\": \"2025-02-11T19:50:29.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"full_name\": \"John Medical Assistant\",\\\n \"is_online\": **false**,\\\n \"photo\": **null**,\\\n \"roles\": \\[\\\n {\\\n \"id\": \"a73dbe99-7474-4a9a-ad03-ecc2a09fe2b9\",\\\n \"name\": \"assistant\",\\\n \"created_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"updated_at\": \"2024-11-13T15:26:48.000000Z\",\\\n \"pivot\": {\\\n \"role_id\": \"a73dbe99-7474-4a9a-ad03-ecc2a09fe2b9\",\\\n \"model_id\": \"cd13558f-9ed3-4f6d-af6f-3a39a3c630d6\",\\\n \"model_type\": **null**,\\\n \"created_at\": **null**,\\\n \"updated_at\": **null**\\\n }\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Partner Notifications\n\nList all notifications for current logged in Partner ### Method: GET >>{{baseUrl}}/partner/notifications > ### Response: 200\n\n{\\\n \"data\": \\[\\\n {\\\n \"id\": \"a41fae41-2e8a-4567-9387-8e4712c6d80e\",\\\n \"notes\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce lacinia justo non nunc dictum, quis gravida lorem pharetra. Donec lorem nisi, luctus ac dui ac, laoreet pulvinar metus. Cras sodales lorem et nisl fermentum, feugiat consectetur ante iaculis. Proin in purus congue, finibus mauris vitae, faucibus est. Cras pretium diam quis nisl aliquet, viverra tempus lacus luctus. Praesent pellentesque orci eu odio luctus efficitur. Curabitur scelerisque id nibh quis congue. Quisque suscipit felis nec magna fermentum, id sollicitudin nisl ornare. Phasellus vestibulum tortor augue, in commodo elit efficitur ut. Nunc iaculis est nec tortor pharetra, ut venenatis eros condimentum. Nunc pretium bibendum egestas. Praesent condimentum pharetra dapibus. Aliquam non ligula non magna finibus congue ut sed libero. Mauris tempus leo ligula, eu rhoncus nibh tempus nec.\",\\\n \"created_at\": \"2023-06-30T11:14:02Z\",\\\n \"notify\": 1,\\\n \"needs_ack\": **false**,\\\n \"partner_id\": \"f9978333-ece0-455b-b8f3-4829953e256a\",\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"support_messaging_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n }\\\n }\\\n \\],\\\n \"links\": {\\\n \"first\": \"{{baseUrl}}/v1/partner/notifications?page=1\",\\\n \"last\": \"{{baseUrl}}/v1/partner/notifications?page=1\",\\\n \"prev\": **null**,\\\n \"next\": **null**\\\n },\\\n \"meta\": {\\\n \"current_page\": 1,\\\n \"from\": 1,\\\n \"last_page\": 1,\\\n \"links\": \\[\\\n {\\\n \"url\": **null**,\\\n \"label\": \"« Previous\",\\\n \"active\": **false**\\\n },\\\n {\\\n \"url\": \"{{baseUrl}}/v1/partner/notifications?page=1\",\\\n \"label\": \"1\",\\\n \"active\": **true**\\\n },\\\n {\\\n \"url\": **null**,\\\n \"label\": \"Next »\",\\\n \"active\": **false**\\\n }\\\n \\],\\\n \"path\": \"{{baseUrl}}/v1/partner/notifications\",\\\n \"per_page\": 15,\\\n \"to\": 1,\\\n \"total\": 1\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get Partner Notification\n\nView a Partner Notification base off his UUID ### Method: GET >>{{baseUrl}}/partner/notifications/:partner_notification_id > ### Response: 200\n\n{\\\n \"id\": \"acd23499-d259-4336-8e57-3c972b448a73\",\\\n \"notes\": \"Lorem Ipsum\",\\\n \"created_at\": \"2023-06-30T11:08:40.000000Z\",\\\n \"notify\": 1,\\\n \"needs_ack\": **false**,\\\n \"partner_id\": \"f9978333-ece0-455b-b8f3-4829953e256a\",\\\n \"partner\": {\\\n \"name\": \"Jacobi and Sons\",\\\n \"support_messaging_capability\": \"integrated\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"partner_id\": \"a63e2ae6-3f98-4fd4-8391-031b0031776f\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Encounters undefined\n\n## End-point: Create Encounter\n\nCreate a new encounter for a given patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\npatient_id\n\nuuid\\*\n\nPatient ID. Check **Partners > Cases > Patients** to create new patients\n\nreference_case_id\n\nuuid\n\nThe referenced case UUID\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the case. (e.g., an ID that will be used to identify this case in another database)\n\nclinician_id\n\nuuid\\*\n\nClinician to assign the case to, in case there is a preference for a specific clinician in a specific case. If the field is not sent, a clinician will be assigned according to MDIntegrations algorithm.\n\ncase_prescriptions\n\narray(Prescription)\n\nList of prescriptions to be reviewed by a clinician\n\ncase_services\n\narray(Service)\n\nList of services to be reviewed by a clinician\n\ncase_files\n\narray(uuid)\n\nFiles ID to be attached to the case. The files must be uploaded before creating a case. To upload files check **Partners > Files**\n\ncase_questions\n\narray(Question)\n\nQuestions and answers list\n\nis_chargeable\n\nboolean\n\nWhether or not the case should be charged\n\ntags\n\narray(object(uuid))\n\nTags ID to be attached to the case.\n\n## Prescription Properties\n\n**Important**: a prescription object must always contain **exactly one** drug type ID from the following:\n\n\\[partner_medication_id, partner_compound_id, partner_supply_id, dosespot_supply_ndc\\]\n\n**Note**: We strongly advise asking our medical team to add medications to your company’s dashboard so it’s easier to manage prescriptions details from there. Should you need to add a one-time-only medication, you can use the dosespot_medication_id to reference a Dosespot medication directly.\n\nfield\n\ntype\n\ndescription\n\npartner_compound_id\n\nuuid\n\nPartner compound ID. Check **Partners > Compounds** to get a partner_compound_id for a given compound. **Required if** dosespot_medication_id and partner_supply_id and dosespot_supply_ndc are null\n\npartner_medication_id\n\nuuid\n\nPartner medication ID. It can be found on your company’s dashboard. **Required if** dosespot_medication_id and partner_medication_id and partner_supply_id and dosespot_supply_ndc are null\n\npartner_supply_id\n\nuuid\n\nPartner supply ID. It can be found on your company’s dashboard. **Required if** dosespot_medication_id and partner_compound_id and partner_medication_id and dosespot_supply_ndc are null\n\ndosespot_supply_ndc\n\nstring\n\nDosespot Supply NDC code. **Required if** dosespot_medication_id and partner_compound_id and partner_medication_id and partner_supply_id are null\n\nrefills\n\ninteger (from 0 to 99)\n\nTotal of refills for the given medication \\* **Required if** dosespot_medication_id or dosespot_supply_ndc is present\n\nquantity\n\nstring\n\nMedication quantity string representing a float number (from 0 to 9999999999) **Required if** dosespot_medication_id or dosespot_supply_ndc is present\n\ndays_supply\n\ninteger (from 0 to 365)\n\nNumber of days of supply of the medication provided - Allows null value\n\ndirections\n\nstring(140)\n\nInstructions about how the medication is administered **Required if** dosespot_medication_id or dosespot_supply_ndc is present\n\npharmacy_notes\n\nstring(210)\n\nAdditional information about the prescription\n\nno_substitutions\n\nboolean\n\nWhether or not a medication or compound can be changed\n\ndispense_unit_id\n\ninteger\n\n\\- **Medication** (prescription with a dosespot_medication_id included): each medication has one associated dispense unit ID. To get the dispense unit ID associated with a given medication check **Partners > Medications > Get details for a specific medication**; - **Compound** (prescription with partner_compound_id included): compounds can be associated with any available dispense unit ID. For a list of all available dispense units check **Partners > Dispense Units**. \\* **Required if** dosespot_medication_id or dosespot_supply_ndc is present\n\npharmacy_id\n\ninteger\n\nPharmacy where the prescription must be sent to. Check **Partners > Pharmacies > Get pharmacies** to get a list of all pharmacies available. **Important note**: Dosespot works with **different IDs** for pharmacies according to the environment. Example: - Curexa pharmacy ID in **staging** environment: 133012 - Curexa pharmacy ID in **production** environment: 29992\n\neffective_date\n\nstring\n\nDate from which prescription is effective (time will always be 00:00:00). Format: Y-m-d\n\n### Prescription Status Flow\n\npending: When prescription is created on MDI side and not synced with Dosespot yet;\\\nprocessing: When MDI receives the Dosespot ID and send through the Dosespot the prescription to Pharmacy;\\\ncompleted: When Dosespot responds to the MDI that this prescription has been verified by the pharmacy;\\\ncancelled: When a doctor cancel the prescription (*when it was synced with Dosespot we try to cancel it there too*)\n\n# Question Properties\n\nFor more information about questions and how they affect prescriptions, contact us via Slack or send an email to:\\\n[mserota@mdintegrations.com](mailto:mserota@mdintegrations.com) and [jeff@mdintegrations.com](mailto:jeff@mdintegrations.com)\n\nWe are also available through Slack (partner’s channel).\n\nfield\n\ntype\n\ndescription\n\nquestion\n\nstring(255)\\*\n\nQuestion\n\nanswer\n\ntext\\*\n\nAnswer\n\ntype\n\nstring\\*\n\nQuestion type. Available options: boolean, number or string\n\nimportant\n\nboolean\n\nFlag to set a question as important. **Important Note**: This flag is used to identify which questions could affect the final prescription. You could also implement custom logic to set this flag only when specific answers are selected.\n\ndisplay_in_pdf\n\nboolean\n\nFlag to set if this question will be displayed in the case PDF file\n\ndescription\n\ntext\n\nA description for your question\n\nlabel\n\nstring(50)\n\nThe question label\n\nmetadata\n\ntext\n\nA metadata field\n\ndisplayed_options\n\narray\n\nAn array of options that were displayed to the patient\n\n## Service Properties\n\n**Important**: a service object can include a **partner_service_id** in order to use predefined information from a partner service.\n\n**Note**: Partner services can be found under your company’s offerings from the Partners Website. Once you know a partner’s service id, you can also retrieve its information through the api using the **Get Service** route.\n\n**field**\n\n**type**\n\ntitle\n\nstring (**required if partner_service_id is NOT included)**\n\ndescription\n\nstring (**required if partner_service_id is NOT included)**\n\nservice_type\n\nstring (**required if partner_service_id is NOT included)**\n\nadditional_note\n\nstring\n\npartner_service_id\n\nuuid\n\nclinical_notes\n\nstring\n\nthank_you_note\n\nstring\n\npharmacy_fax_number\n\nstring\n\ninclude_drivers_license\n\nboolean\n\nsend_pdf_file_automatically\n\nboolean\n\n### Method: POST\n\n{{baseUrl}}/partner/tests/encounters\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"patient_id\": \"5b803d51-b6e4-4ae5-b7d2-ee3e1dba7d2d\",\\\n \"clinician_id\": \"00115b3a-cda1-475d-b1c9-0315bb8b906f\",\\\n \"metadata\": \"case number 15\",\\\n \"is_chargeable\": **true**,\\\n \"case_files\": \\[\\],\\\n \"case_services\": \\[\\\n {\\\n \"description\": \"Device that...\",\\\n \"service_type\": \"device\",\\\n \"title\": \"Device 14\",\\\n \"additional_note\": \"Service additional note\",\\\n \"clinical_notes\": \"Some clinical note\",\\\n \"thank_you_note\": \"Some thank you note\",\\\n \"pharmacy_fax_number\": \"+587965462316\",\\\n \"include_drivers_license\": **true**,\\\n \"send_pdf_file_automatically\": **false**\\\n },\\\n {\\\n \"partner_service_id\": \"a1f8fc44-b939-4b46-a646-7c3245d6ee62\"\\\n }\\\n \\],\\\n \"case_prescriptions\": \\[\\\n {\\\n \"dosespot_medication_id\": 310964,\\\n \"refills\": 2,\\\n \"quantity\": 1.5,\\\n \"days_supply\": 30,\\\n \"directions\": \"Take one at the morning and another before bed\",\\\n \"dispense_unit_id\": 99,\\\n \"pharmacy_id\": 13012,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"effective_date\": \"2023-05-10\"\\\n }\\\n \\],\\\n \"case_questions\": \\[\\\n {\\\n \"question\": \"Are you pregnant?\",\\\n \"answer\": \"false\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **true**,\\\n \"description\": \"Here is the question description\",\\\n \"label\": \"Question Label Example\",\\\n \"metadata\": \"example of metatada #123 for question\",\\\n \"displayed_options\": \\[\\\n \"true\",\\\n \"false\"\\\n \\]\\\n }\\\n \\],\\\n \"tags\": \\[\\\n {\\\n \"tag_id\": \"d99ac893-9bd6-49ae-befe-4cf625e97d7c\"\\\n }\\\n \\]\\\n}\n\n### Response: 200\n\n{\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"prioritized\": **false**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"metadata\": \"case number 15\",\\\n \"created_at\": \"2021-06-10T16:34:40.000000Z\",\\\n \"is_sync\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"case_type\": \"follow-up\",\\\n \"case_id\": \"e02ebf38-147a-419b-bfc8-87e88d29f161\",\\\n \"reference_case_id\": \"9b0c4571-f980-4fd4-bf9d-87e88d0c4571\",\\\n \"case_status\": {\\\n \"name\": \"created\",\\\n \"reason\": **null**,\\\n \"updated_at\": \"2021-06-17T17:14:59.000000Z\"\\\n },\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"John\",\\\n \"last_name\": \"Snow\",\\\n \"email\": \"[johnsnow@doe.com](mailto:johnsnow@doe.com)\",\\\n \"date_of_birth\": \"2000-12-31\",\\\n \"gender\": 1,\\\n \"phone_number\": \"(415) 555-2671\",\\\n \"phone_type\": \"2\",\\\n \"active\": **true**,\\\n \"metadata\": \"patient number 200\",\\\n \"weight\": \"50.000\",\\\n \"height\": 180,\\\n \"dosespot\": {\\\n \"patient_dosespot_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"sync_status\": \"success\"\\\n },\\\n \"current_medications\": \"paracetamol\",\\\n \"allergies\": \"polen\",\\\n \"patient_id\": \"9b0c4571-f980-4fd4-bf9d-6de1ac52dc9d\",\\\n \"gender_label\": \"Male\",\\\n \"pregnancy\": **false**,\\\n \"is_live\": **true**,\\\n \"driver_license\": {\\\n \"path\": \"logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",\\\n \"name\": \"Wallpaper_1080p.png\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\",](http://api.localhost:8000/v1/file/logos/8fa624fd-682f-4fda-b8fa-779084759a4b.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"862a8e4c-d65a-4d52-8568-49c0d53fa51e\"\\\n },\\\n \"address\": {\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"address2\": \"NY 10029\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"state\": {\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"is_av_flow\": **false**,\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"intro_video\": {\\\n \"file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"path\": \"[6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov](http://6v8Ndd8Tpg1uCCik19G8ErJ4jxNiF5kgv1l1DqqE.mov)\",\\\n \"name\": \"intro\\_[video.mov](http://video.mov)\",\\\n \"mime_type\": \"video/quicktime\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/intro_video.mov\",](http://api.localhost:8000/v1/file/intro_video.mov\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"created_at\": \"2023-07-04T22:35:11.000000Z\"\\\n }\\\n },\\\n \"partner\": {\\\n \"name\": \"Langworth, Heaney and Mills\",\\\n \"partner_id\": \"b9c80740-cf71-4a34-8523-987edf221f75\",\\\n \"support_message_capability\": \"integrated\",\\\n \"partner_notes\": \"Partner has...\",\\\n \"operations_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"customer_support_email\": \"[testing@email.com](mailto:testing@email.com)\",\\\n \"patient_message_capability\": \"integrated\",\\\n \"provides_medications\": **true**,\\\n \"thank_you_note_header\": \"Header Thank you note example\",\\\n \"thank_you_note_footer\": \"Footer Thank you note example\",\\\n \"vouched_integration_type\": \"disabled\",\\\n \"business_model\": \"regular\",\\\n \"enable_av_flow\": **true**,\\\n \"slack_channel_id\": \"C05QP6YD8K0\",\\\n \"customization\": {\\\n \"primary_color\": \"#000000\",\\\n \"secondary_color\": \"#000000\",\\\n \"background_color\": \"#000000\"\\\n },\\\n \"address\": {\\\n \"address_id\": \"31817530-d047-4565-8aa7-e16275b1715d\",\\\n \"address\": \"1901 1st Avenue, New York\",\\\n \"zip_code\": \"65506-4433\",\\\n \"city_name\": \"Pearl River\",\\\n \"state\": {\\\n \"state_id\": \"59bd3d22-8955-44e1-83c0-8556dd16bde4\",\\\n \"name\": \"New York\",\\\n \"abbreviation\": \"NY\",\\\n \"is_av_flow\": **false**,\\\n \"country\": {\\\n \"country_id\": \"aff4f7d5-4ce9-4696-9ae8-8fe97d011fbe\",\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\"\\\n }\\\n }\\\n },\\\n \"operation_country\": {\\\n \"name\": \"United States of America\",\\\n \"abbreviation\": \"US\",\\\n \"country_id\": \"535fd3fd-f206-4724-89a9-55289474db8b\"\\\n }\\\n },\\\n \"case_assignment\": {\\\n \"reason\": \"Repellat quisquam sed distinctio sit id et. Unde et doloremque quas ducimus harum perferendis. Officia sapiente velit necessitatibus deleniti. Velit error inventore ut ipsam officia id dolorem.\",\\\n \"created_at\": \"2021-02-03T19:30:18.000000Z\",\\\n \"case_assignment_id\": \"227ed29c-044a-41d7-bb68-caa2e6c5ee63\",\\\n \"clinician\": {\\\n \"first_name\": \"Parisian\",\\\n \"last_name\": \"Schultz\",\\\n \"suffix\": \"M.D\",\\\n \"is_online\": **true**,\\\n \"npi\": \"1598738916\",\\\n \"clinician_id\": \"65e4f8da-e5f7-44b3-a3d4-c9dc74981f4f\",\\\n \"full_name\": \"Seamus Parisian\",\\\n \"specialty\": \"General Practice\",\\\n \"dea\": \"RM1234567\",\\\n \"photo\": {\\\n \"path\": \"clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",\\\n \"name\": \"under_construction.jpg\",\\\n \"mime_type\": \"image/jpeg\",\\\n \"url\": \"[http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\",](http://api.localhost:8000/v1/file/clinicians_photos/ba193841-9a21-4bdf-a778-2a1f33e1ea2c.jpeg\\\",)\\\n \"url_thumbnail\": **null**,\\\n \"file_id\": \"22a03259-b2de-4255-9d2e-48a9dc368633\"\\\n }\\\n }\\\n },\\\n \"tags\": \\[\\\n {\\\n \"id\": \"7af7618a-5711-4485-8b35-63b65b3f56cc\",\\\n \"type\": \"partner\",\\\n \"name\": \"My own tag two\",\\\n \"key\": \"my-own-tag-two\",\\\n \"color\": \"#fff\",\\\n \"description\": \"My tag description\",\\\n \"notes\": \"Ola esse é um teste editador\",\\\n \"removable_role\": **null**,\\\n \"auto_detach_status\": \\[\\\n \"assigned\",\\\n \"processing\"\\\n \\]\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Post Encounter Status\n\nCreate a new encounter for a given patient.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nstatus\n\nstring\\*\n\nThe new status (assigned, processing, waiting, support, cancelled, resubmit, completed)\n\nreason\n\nstring\n\nThe reason. Necessary if the status is cancelled or waiting.\n\nclinician_id\n\nuuid\\*\n\nClinician to simulate the action.\n\n### Method: POST\n\n{{baseUrl}}/partner/tests/encounters/:encounter_id/status\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"status\": \"waiting\",\\\n \"reason\": \"test\",\\\n \"clinician_id\": \"ecee9fc0-8ae8-4ba3-920d-a57bf6a22806\"\\\n}\n\n### Response: undefined\n\n{\\\n \"id\": \"7cf7d672-46a9-4a6f-9520-f6d47ba90c3c\",\\\n \"patient_id\": \"ab9778f2-3150-4e1b-b7bd-a7f95ef5edee\",\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"reference_case_id\": **null**,\\\n \"is_sync\": **false**,\\\n \"case_type\": \"follow-up\",\\\n \"case_assignment_id\": \"d9452aee-2c55-4119-a0a8-997c3387708d\",\\\n \"case_status_id\": \"e0db5601-a486-4137-bb4a-278a11e5e12a\",\\\n \"prioritized_at\": **null**,\\\n \"prioritized_reason\": **null**,\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"service_pdf_exported\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"partner_amount_charged\": **null**,\\\n \"metadata\": \"case number 2345\",\\\n \"created_at\": \"2023-11-06T11:59:40.000000Z\",\\\n \"updated_at\": \"2023-11-06T12:11:38.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"prioritized\": **false**,\\\n \"case_status\": {\\\n \"id\": \"e0db5601-a486-4137-bb4a-278a11e5e12a\",\\\n \"name\": \"assigned\",\\\n \"reason\": \"Reassigned by admin.\",\\\n \"updated_at\": \"2023-11-06T12:11:38.000000Z\",\\\n \"created_at\": \"2023-11-06T12:11:38.000000Z\"\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create Encounter Prescription\n\nCreate a encounter prescription.\n\n# Payload\n\nReceives an object of **Prescription**.\n\n## Prescription Properties\n\n**Important**: a prescription object must always contain **exactly one** drug type ID from the following:\n\n\\[partner_medication_id, partner_compound_id, partner_supply_id, dosespot_supply_ndc\\]\n\n**Note**: We strongly advise asking our medical team to add medications to your company’s dashboard so it’s easier to manage prescriptions details from there. Should you need to add a one-time-only medication, you can use the dosespot_medication_id to reference a Dosespot medication directly.\n\nfield\n\ntype\n\ndescription\n\nclinician_id\n\nuuid\\*\n\nClinician to simulate the action\n\npartner_compound_id\n\nuuid\n\nPartner compound ID. Check **Partners > Compounds** to get a partner_compound_id for a given compound. **Required if** dosespot_medication_id and partner_supply_id and dosespot_supply_ndc are null\n\npartner_medication_id\n\nuuid\n\nPartner medication ID. It can be found under your company’s offerings from the Partners Website. **Required if** dosespot_medication_id and partner_medication_id and partner_supply_id and dosespot_supply_ndc are null\n\npartner_supply_id\n\nuuid\n\nPartner supply ID. It can be found under your company’s offerings from the Partners Website. **Required if** dosespot_medication_id and partner_compound_id and partner_medication_id and dosespot_supply_ndc are null\n\ndosespot_supply_ndc\n\nstring\n\nDosespot Supply NDC code. **Required if** dosespot_medication_id and partner_compound_id and partner_medication_id and partner_supply_id are null\n\nrefills\n\ninteger (from 0 to 99)\n\nTotal of refills for the given medication \\* Required if dosespot_medication_id is present\n\nquantity\n\nstring\n\nMedication quantity string representing a float number (from 0 to 9999999999) **Required if** dosespot_medication_id is present\n\ndays_supply\n\ninteger (from 0 to 365)\n\nNumber of days of supply of the medication provided - Allows null value\n\ndirections\n\nstring(140)\n\nInstructions about how the medication is administered **Required if** dosespot_medication_id is present\n\npharmacy_notes\n\nstring(210)\n\nAdditional information about the prescription\n\nno_substitutions\n\nboolean\n\nWhether or not a medication or compound can be changed\n\ndispense_unit_id\n\ninteger\n\n\\- **Medication** (prescription with a dosespot_medication_id included): each medication has one associated dispense unit ID. To get the dispense unit ID associated with a given medication check **Partners > Medications > Get details for a specific medication**; - **Compound** (prescription with partner_compound_id included): compounds can be associated with any available dispense unit ID. For a list of all available dispense units check **Partners > Dispense Units**. \\* Required if dosespot_medication_id is present\n\npharmacy_id\n\ninteger\\*\n\nPharmacy where the prescription must be sent to. Check **Partners > Pharmacies > Get pharmacies** to get a list of all pharmacies available\n\neffective_date\n\nstring\n\nDate from which prescription is effective (time will always be 00:00:00). Format: Y-m-d\n\n### Prescription Status Flow\n\npending: When prescription is created on MDI side and not synced with Dosespot yet;\\\nprocessing: When MDI receives the Dosespot ID and send through the Dosespot the prescription to Pharmacy;\\\ncompleted: When Dosespot responds to the MDI that this prescription has been verified by the pharmacy;\\\ncancelled: When a doctor cancel the prescription (*when it was synced with Dosespot we try to cancel it there too*)\n\n \\### Method: POST >>{{baseUrl}}/partner/tests/encounters/:encounter_id/prescriptions > ### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"clinician_id\": \"afebefe5-f357-42af-97a0-8ec66538c24b\",\\\n \"dosespot_medication_id\": 310964,\\\n \"refills\": 50,\\\n \"quantity\": \"1779333.590\",\\\n \"days_supply\": 47,\\\n \"directions\": \"Voluptas corporis id maiores blanditiis. Minus iste nostrum vitae voluptas enim consequuntur aliquid. Maiores adipisci qui cum eum et. Accusamus id pariatur quo quibusdam.\",\\\n \"partner_compound_id\": **null**,\\\n \"dispense_unit_id\": 62,\\\n \"pharmacy_id\": 79,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"effective_date\": \"2023-05-10\",\\\n \"title\": \"Prescription title example\"\\\n}\n\n### Response: undefined\n\n{\\\n \"id\": \"3bdb6201-5292-47b0-98d2-a5125dad3f5c\",\\\n \"patient_id\": \"ab9778f2-3150-4e1b-b7bd-a7f95ef5edee\",\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"reference_case_id\": **null**,\\\n \"is_sync\": **false**,\\\n \"case_type\": \"follow-up\",\\\n \"case_assignment_id\": \"ad2eab89-3dd7-45e6-84f6-0d6e2d5e3b14\",\\\n \"case_status_id\": \"b2baadec-c218-439a-bcde-72e101573d3b\",\\\n \"prioritized_at\": \"2023-10-16T15:03:16.000000Z\",\\\n \"prioritized_reason\": \"Prioritized due the reassignment algorithm.\",\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"service_pdf_exported\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"partner_amount_charged\": **null**,\\\n \"metadata\": \"case number 2345\",\\\n \"created_at\": \"2023-10-06T13:45:36.000000Z\",\\\n \"updated_at\": \"2023-10-16T15:06:27.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"prioritized\": **true**,\\\n \"patient\": {\\\n \"id\": \"ab9778f2-3150-4e1b-b7bd-a7f95ef5edee\",\\\n \"first_name\": \"FirstName\",\\\n \"last_name\": \"LastName\",\\\n \"email\": \"[name+sandbox@test.com](mailto:name+sandbox@test.com)\",\\\n \"active\": **true**,\\\n \"prefix\": \"Sr\",\\\n \"weight\": 80,\\\n \"height\": **null**,\\\n \"gender\": 2,\\\n \"phone_number\": **null**,\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"aa2166cf-8266-4e0f-837c-1b84e042e10d\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": **null**,\\\n \"current_medications\": **null**,\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"environment_id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"clinician_id\": \"ecee9fc0-8ae8-4ba3-920d-a57bf6a22806\",\\\n \"metadata\": **null**,\\\n \"intro_video_file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"recent_encounter_id\": \"2a88178f-4360-4ff5-aafd-37af28cc506d\",\\\n \"created_at\": \"2023-10-06T13:32:50.000000Z\",\\\n \"updated_at\": \"2023-10-24T13:41:00.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"patient_id\": \"ab9778f2-3150-4e1b-b7bd-a7f95ef5edee\",\\\n \"full_name\": \"FirstName LastName\",\\\n \"abbreviated_name\": \"FirstName L.\",\\\n \"is_live\": **false**,\\\n \"intro_video_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"environment\": {\\\n \"id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"identifier\": \"sandbox\",\\\n \"created_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"updated_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"webhook_url\": **null**,\\\n \"webhook_secret\": **null**,\\\n \"webhook_authorization\": **null**\\\n }\\\n },\\\n \"partner\": {\\\n \"id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"name\": \"MDI USA Partner\",\\\n \"active\": **true**,\\\n \"logo_file_id\": \"eb2caa1e-6622-4117-9c21-892b44bc23fb\",\\\n \"operation_country_id\": \"bf511938-8c04-47cf-ac41-6a9aeea376ad\",\\\n \"about\": \"createdMon Aug 21 2023 14:33:28 GMT+0000\",\\\n \"address_id\": \"68a03cb3-9b0c-46aa-8e67-98551eedca01\",\\\n \"website_url\": \"[https://mdintegrations.com.test/\",](https://mdintegrations.com.test/\\\",)\\\n \"status\": \"live\",\\\n \"is_expedited\": **false**,\\\n \"customer_support_email\": \"[name+partner+customer@test.com](mailto:name+partner+customer@test.com)\",\\\n \"operations_support_email\": \"[namre+partner+operation@test.com](mailto:namre+partner+operation@test.com)\",\\\n \"patient_message_capability\": \"notification_email\",\\\n \"support_message_capability\": \"notification_email\",\\\n \"support_hours\": \"8 hours a day\",\\\n \"support_location\": \"international\",\\\n \"enable_av_flow\": **true**,\\\n \"business_model\": \"regular\",\\\n \"use_intake_form\": **false**,\\\n \"use_messaging\": **true**,\\\n \"messaging_app_primary_color\": \"#295c92\",\\\n \"messaging_app_secondary_color\": \"#60375a\",\\\n \"messaging_app_background_color\": \"#50bbb6\",\\\n \"partner_notes\": \"<div><strong>MDI USA Partner</strong> is the world's leading pharmaceutical company. The company, which has its global headquarters in New York City, acts in the global market since 1924.<br>For more information about <strong>MDI USA Partner</strong>, visit our <a href=\\\\\"[https://mdintegrations.com/\\\\\">website</a>: </div>\",](https://mdintegrations.com/\\\\\">website: \\\",)\\\n \"parent_company\": **null**,\\\n \"thank_you_note_header\": \"Hi \\[patient_name\\] from \\[patient_state\\],\\\\r\\\\nThanks for coming to \\[partner_name\\] and allowing us to care for you. I have reviewed your answers to the medical intake form, and you are a good candidate for the treatment. I have sent a prescription to the pharmacy, and you should be receiving your package in a few days at the address on your account. Relief is on the way!\",\\\n \"thank_you_note_footer\": \"Thanks & Regards,\\\\r\\\\n\\\\r\\\\n\\[clinician_name\\],\\\\r\\\\n\\[clinician_email\\].\",\\\n \"charge_sync_new_case\": \"25.00\",\\\n \"charge_async_new_case\": \"10.15\",\\\n \"charge_sync_follow_up_case\": \"25.00\",\\\n \"charge_async_follow_up_case\": \"10.15\",\\\n \"vouched_integration_type\": \"manually\",\\\n \"vouched_integration_charge\": \"0.00\",\\\n \"text_message_integration_type\": \"automatic\",\\\n \"text_message_integration_charge\": \"1.00\",\\\n \"accepted_at\": \"2021-06-04T16:16:00.000000Z\",\\\n \"slack_channel_id\": \"C05T1G31F0T\",\\\n \"created_at\": \"2021-06-04T16:16:00.000000Z\",\\\n \"updated_at\": \"2023-09-19T21:48:00.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\"\\\n },\\\n \"case_prescriptions\": \\[\\\n {\\\n \"id\": \"4d159d2d-7b64-4595-81fc-f1325efa2afc\",\\\n \"refills\": 50,\\\n \"quantity\": 1779333.59,\\\n \"days_supply\": 47,\\\n \"directions\": \"Voluptas corporis id maiores blanditiis. Minus iste nostrum vitae voluptas enim consequuntur aliquid.\",\\\n \"dispense_unit_id\": 62,\\\n \"pharmacy_id\": 79,\\\n \"thank_you_note\": **null**,\\\n \"clinical_note\": **null**,\\\n \"dosespot_prescription_id\": **null**,\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with...\",\\\n \"no_substitutions\": **true**,\\\n \"dosespot_display_name\": **null**,\\\n \"medication\": {\\\n \"dosespot_medication_id\": \"310964\",\\\n \"dispense_unit_id\": 4,\\\n \"dose_form\": \"capsule\",\\\n \"route\": \"oral\",\\\n \"strength\": \"200 mg\",\\\n \"generic_product_name\": \"ibuprofen 200 mg oral capsule\",\\\n \"lexi_gen_product_id\": 6680,\\\n \"lexi_drug_syn_id\": 18915,\\\n \"lexi_synonym_type_id\": 59,\\\n \"lexi_gen_drug_id\": \"d00015\",\\\n \"rx_cui\": \"310964\",\\\n \"otc\": **true**,\\\n \"ndc\": \"00113029858\",\\\n \"schedule\": \"0\",\\\n \"display_name\": \"Ibuprofen 200 mg capsule\",\\\n \"monograph_path\": **null**,\\\n \"drug_classification\": \"central nervous system agents\",\\\n \"state_schedules\": \\[\\],\\\n \"metadata\": **null**,\\\n \"partner_medication_id\": **null**\\\n },\\\n \"updated_at\": \"2023-10-06T14:10:14.000000Z\",\\\n \"created_at\": \"2023-10-06T14:10:14.000000Z\"\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Reassign clinician to encounter\n\nReassign a given clinician to a given encounter.\n\n# Payload\n\nfield\n\ntype\n\ndescription\n\nclinician_id\n\nuuid\\*\n\nClinician UUID\n\nreason\n\nstring\n\nA reason for the assignment.\n\n### Method: POST\n\n{{baseUrl}}/partner/tests/encounters/:encounter_id/reassign\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"clinician_id\": \"2657524c-b4b8-4727-a414-3f8750020766\",\\\n \"reason\": \"Here an example of a reason.\"\\\n}\n\n### Response: undefined\n\n{\\\n \"id\": \"3bdb6201-5292-47b0-98d2-a5125dad3f5c\",\\\n \"patient_id\": \"ab9778f2-3150-4e1b-b7bd-a7f95ef5edee\",\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"reference_case_id\": **null**,\\\n \"is_sync\": **false**,\\\n \"case_type\": \"follow-up\",\\\n \"case_assignment_id\": \"e1ac6b2b-a596-4b08-916e-5ec345b0cfed\",\\\n \"case_status_id\": \"b2baadec-c218-439a-bcde-72e101573d3b\",\\\n \"prioritized_at\": \"2023-10-16T15:03:16.000000Z\",\\\n \"prioritized_reason\": \"Prioritized due the reassignment algorithm.\",\\\n \"locked_at\": **null**,\\\n \"is_locked\": **false**,\\\n \"service_pdf_exported\": **false**,\\\n \"is_chargeable\": **true**,\\\n \"partner_amount_charged\": **null**,\\\n \"metadata\": \"case number 2345\",\\\n \"created_at\": \"2023-10-06T13:45:36.000000Z\",\\\n \"updated_at\": \"2023-11-06T12:13:46.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"prioritized\": **true**,\\\n \"case_assignment\": {\\\n \"id\": \"e1ac6b2b-a596-4b08-916e-5ec345b0cfed\",\\\n \"case_id\": \"3bdb6201-5292-47b0-98d2-a5125dad3f5c\",\\\n \"clinician_id\": \"bcda6915-69bf-4b8d-bda9-145d47c52df5\",\\\n \"reason\": \"test\",\\\n \"created_at\": \"2023-11-06T12:13:46.000000Z\",\\\n \"updated_at\": \"2023-11-06T12:13:46.000000Z\"\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Create Patient and Encounter\n\nCreate a new patient and encounter.\n\n# Case Payload\n\nfield\n\ntype\n\ndescription\n\npreferred_pharmacy_id\n\ninteger\n\nDosespot Pharmacy ID\n\nquestionnaire_id\n\nuuid\\*\n\nQuestionnaire ID\n\ncompletion_time\n\nstring\\*\n\nTime in the format “hh:mm:ss”\n\n# Patient Payload\n\nfield\n\ntype\n\ndescription\n\nprefix\n\nstring(10)\\*\n\nPrefix\n\nfirst_name\n\nstring(35)\\*\n\nFirst name\n\nlast_name\n\nstring(35)\\*\n\nLast name\n\nssn\n\nstring(11)\n\nSecurity Social Number. **Format**: AAAGGSSSS\n\nemail\n\nstring(80)\\*\n\nE-mail\n\ndate_of_birth\n\ndate\\*\n\nDate of birth, as YYYY-MM-DD\n\ndriver_license_id\n\nuuid\n\nPatient’s Driver License, needs to reference an existing **File**. Created through **Files > Create file**.\n\ngender\n\ninteger\\*\n\nGender (ISO 5218 format)\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the patient. (e.g., an ID that will be used to identify this patient in another database)\n\nphone_number\n\nstring(25)\\*\n\nPhone number - *US format*\n\nphone_type\n\ninteger\\*\n\nPhone type. Available options: 2 (cell) or 4 (home)\n\naddress.address\n\nstring(35)\\*\n\nAddress\n\naddress.address2\n\nstring(35)\n\nAdditional address - Allows null value\n\n[address.zip](http://address.zip)\\_code\n\nstring(9)\\*\n\nUS zip code - *5 or 9 digit format*\\*OR\\*CA zip code - 6 alphanumeric characters\n\n[address.city](http://address.city)\\_name\n\nstring(35)\\*\n\nCity name.\n\naddress.state_name\n\nstring\\*\n\nState name or State USPS abbreviation.\n\nweight\n\nfloat (from 0 to 999)\n\nWeight in KG \\* *required if patient is underage*\n\nheight\n\ninteger (from 0 to 300)\n\nHeight in CM \\* *required if patient is underage*\n\nbody_temperature\n\nfloat (from 0.0 to 100.0)\n\nBody temperature in Celsius\n\noxygen_saturation\n\ninteger (from 0 to 100)\n\nOxygen Saturation in percentage\n\nspecial_necessities\n\ntext\n\nSpecial necessities to be informed about in this case\n\nallergies\n\ntext\n\nKnown patient’s allergies\n\npregnancy\n\nboolean\n\nDefine the patient with a pregnancy\n\ncurrent_medications\n\ntext\n\nMedications that the patient is currently taking\n\nintro_video_id\n\nuuid\n\nPatient’s Intro Video, needs to reference an existing **File**. Created through **Files > Create file**.\n\n# Case Payload\n\nfield\n\ntype\n\ndescription\n\nmetadata\n\nstring(255)\n\nField meant to store any information that helps identifying the case. (e.g., an ID that will be used to identify this case in another database)\n\nclinician_id\n\nuuid\n\nClinician to assign the case to, in case there is a preference for a specific clinician in a specific case. If the field is not sent, a clinician will be assigned according to MDIntegrations algorithm.\n\ncase_prescriptions\n\narray(Prescription)\n\nList of prescriptions to be reviewed by a clinician\n\ncase_files\n\narray(uuid)\n\nFiles ID to be attached to the case. The files must be uploaded before creating a case. To upload files check **Partners > Files**\n\ncase_questions\n\narray(Question)\n\nQuestions and answers list\n\ncase_services\n\narray(Services)\n\nList of services to be reviewed by a clinician\n\ntags\n\narray(uuid)\n\nTags ID to be attached to the case.\n\n## Prescription Properties\n\n**Important**: a prescription object must always contain **exactly one** drug type ID from the following:\n\n\\[partner_medication_id, partner_compound_id, partner_supply_id\\]\n\n**Note**: We strongly advise asking our medical team to add medications to your company’s dashboard so it’s easier to manage prescriptions details from there. Should you need to add a one-time-only medication, you can use the dosespot_medication_id to reference a Dosespot medication directly.\n\nfield\n\ntype\n\ndescription\n\npartner_compound_id\n\nuuid\n\nPartner compound ID. Check **Partners > Compounds** to get a partner_compound_id for a given compound. **Required if** dosespot_medication_id and partner_medication_id are null\n\npartner_medication_id\n\nuuid\n\nPartner medication ID. It can be found under your company’s offerings from the Partners Website. **Required if** dosespot_medication_id and partner_compound_id are null\n\npartner_supply_id\n\nuuid\n\nPartner supply ID. It can be found under your company’s offerings from the Partners Website. **Required if** dosespot_medication_id and partner_compound_id and partner_supply_id are null\n\nrefills\n\ninteger (from 0 to 99)\n\nTotal of refills for the given medication \\* Required if dosespot_medication_id is present\n\nquantity\n\nstring\n\nMedication quantity string representing a float number (from 0 to 9999999999) **Required if** dosespot_medication_id is present\n\ndays_supply\n\ninteger (from 0 to 365)\n\nNumber of days of supply of the medication provided - Allows null value\n\ndirections\n\nstring(140)\n\nInstructions about how the medication is administered **Required if** dosespot_medication_id is present\n\npharmacy_notes\n\nstring(210)\n\nAdditional information about the prescription\n\nno_substitutions\n\nboolean\n\nWhether or not a medication or compound can be changed\n\ndispense_unit_id\n\ninteger\n\n\\- **Medication** (prescription with a dosespot_medication_id included): each medication has one associated dispense unit ID. To get the dispense unit ID associated with a given medication check **Partners > Medications > Get details for a specific medication**; - **Compound** (prescription with partner_compound_id included): compounds can be associated with any available dispense unit ID. For a list of all available dispense units check **Partners > Dispense Units**. \\* Required if dosespot_medication_id is present\n\npharmacy_id\n\ninteger\\*\n\nPharmacy where the prescription must be sent to. Check **Partners > Pharmacies > Get pharmacies** to get a list of all pharmacies available. **Required if**: dosespot_medication_id is present. **Required if**: partner_medication_id or partner_medication_id does not have a registered default pharmacy. **Important note**: Dosespot works with **different IDs** for pharmacies according to the environment. Example: - Curexa pharmacy ID in **staging** environment: 133012 - Curexa pharmacy ID in **production** environment: 29992\n\neffective_date\n\nstring\n\nDate from which prescription is effective (time will always be 00:00:00). Format: Y-m-d\n\n# Question Properties\n\nFor more information about questions and how they affect prescriptions, contact us via Slack or send an email to:\\\n[mserota@mdintegrations.com](mailto:mserota@mdintegrations.com) and [jeff@mdintegrations.com](mailto:jeff@mdintegrations.com)\n\nWe are also available through Slack (partner’s channel).\n\nfield\n\ntype\n\ndescription\n\nquestion\n\nstring(255)\\*\n\nQuestion\n\nanswer\n\ntext\\*\n\nAnswer\n\ntype\n\nstring\\*\n\nQuestion type. Available options: boolean, number or string\n\nimportant\n\nboolean\n\nFlag to set a question as important. **Important Note**: This flag is used to identify which questions could affect the final prescription. You could also implement custom logic to set this flag only when specific answers are selected.\n\ndisplay_in_pdf\n\nboolean\n\nFlag to set if this question will be displayed in the case PDF file\n\n# Diseases\n\n**Important**: Every disease object will add the disease with the ICD (International Classification of Disease) to the case.\n\n**Note**: Diseses can be found on the diseases page on the Admin panel. Once you know a disease id, you can also retrieve its information through the API using the Get Disease route.\n\nfield\n\ntype\n\ndescription\n\ndisease_id\n\nUUID\n\nDisease ID. It can be found through the diseases endpoints.\n\n## Service Properties\n\n**Important**: a service object can include a **partner_service_id** in order to use predefined information from a partner service.\n\n**Note**: Partner services can be found under your company’s offerings from the Partners Website. Once you know a partner’s service id, you can also retrieve its information through the api using the **Get Service** route.\n\n**field**\n\n**type**\n\ntitle\n\nstring (**required if partner_service_id is NOT included)**\n\ndescription\n\nstring (**required if partner_service_id is NOT included)**\n\nservice_type\n\nstring (**required if partner_service_id is NOT included)**\n\nadditional_note\n\nstring\n\npartner_service_id\n\nuuid\n\nclinical_notes\n\nstring\n\nthank_you_note\n\nstring\n\npharmacy_fax_number\n\nstring\n\ninclude_drivers_license\n\nboolean\n\nsend_pdf_file_automatically\n\nboolean\n\n### Method: POST\n\n{{baseUrl}}/partner/tests/vouchers/:voucher_id\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"preferred_pharmacy_id\": 13012,\\\n \"questionnaire_id\": \"368f95e5-cbd9-4a2f-8275-6f9258bbdf46\",\\\n \"completion_time\": \"00:12:53\",\\\n \"patient\": {\\\n \"prefix\": \"Sr\",\\\n \"first_name\": \"Oberyn\",\\\n \"last_name\": \"Martell\",\\\n \"ssn\": \"111-22-3333\",\\\n \"gender\": 2,\\\n \"weight\": 80,\\\n \"body_temperature\": 36.9,\\\n \"oxygen_saturation\": 99,\\\n \"special_necessities\": \"special necessities example\",\\\n \"date_of_birth\": \"1990-11-11\",\\\n \"phone_number\": \"\",\\\n \"phone_type\": 2,\\\n \"email\": \"[oberyn@mdintegrations.com](mailto:oberyn@mdintegrations.com)\",\\\n \"address\": {\\\n \"address\": \"10001, new test mall\",\\\n \"zip_code\": \"12345\",\\\n \"city_name\": \"New York\",\\\n \"state_name\": \"NY\"\\\n },\\\n \"intro_video_id\": \"9d8df900-5b97-4d12-86e7-488fcb891b22\"\\\n },\\\n \"case\": {\\\n \"clinician_id\": \"20b0e825-041d-4ea9-97b1-cec9d237ff3a\",\\\n \"metadata\": \"example of metadata\",\\\n \"case_files\": \\[\\],\\\n \"case_services\": \\[\\\n {\\\n \"description\": \"Device that...\",\\\n \"service_type\": \"device\",\\\n \"title\": \"Device 14\",\\\n \"additional_note\": \"Service additional note\",\\\n \"clinical_notes\": \"Some clinical note\",\\\n \"thank_you_note\": \"Some thank you note\",\\\n \"pharmacy_fax_number\": \"+587965462919\",\\\n \"include_drivers_license\": **true**,\\\n \"send_pdf_file_automatically\": **false**\\\n }\\\n \\],\\\n \"case_prescriptions\": \\[\\\n {\\\n \"dosespot_medication_id\": 310964,\\\n \"refills\": 2,\\\n \"quantity\": 1.5,\\\n \"days_supply\": 30,\\\n \"directions\": \"Take one at the morning and another before bed\",\\\n \"dispense_unit_id\": 2,\\\n \"pharmacy_id\": 13012,\\\n \"no_substitutions\": **true**,\\\n \"pharmacy_notes\": \"This medication might not be suitable for people with... \",\\\n \"effective_date\": \"2023-05-10\"\\\n }\\\n \\],\\\n \"case_questions\": \\[\\\n {\\\n \"question\": \"Are you pregnant?\",\\\n \"answer\": \"false\",\\\n \"type\": \"boolean\",\\\n \"important\": **true**,\\\n \"is_critical\": **true**,\\\n \"display_in_pdf\": **true**\\\n }\\\n \\],\\\n \"diseases\": \\[\\\n {\\\n \"disease_id\": \"000d2152-7838-4fc7-8a13-ae8a1748a9eb\"\\\n }\\\n \\],\\\n \"tags\": \\[\\\n {\\\n \"tag_id\": \"d99ac893-9bd6-49ae-befe-4cf625e97d7c\"\\\n }\\\n \\]\\\n }\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Patients undefined\n\n## End-point: Create Message\n\nCreates a patient’s message, and attaches its files.\n\n# Payload\n\n**field**\n\n**type**\n\nchannel\\*\n\nstring\n\nclinician_id\n\nuuid\n\nsupport_staff_id\n\nuuid\n\ntext\n\nstring\n\nreference_message_id\n\nuuid\n\nfiles\n\narray\n\n# Payload (files)\n\n**field**\n\n**type**\n\nid\\*\n\nuuid\n\n### Method: POST\n\n{{baseUrl}}/partner/tests/patients/:patient_id/messages\n\n### Headers\n\nContent-Type\n\nValue\n\nVersion\n\n{{version}}\n\n### Body (**raw**)\n\n{\\\n \"channel\": \"patient\",\\\n \"clinician_id\": \"bcda6915-69bf-4b8d-bda9-145d47c52df5\",\\\n \"support_staff_id\": \"afebefe5-f357-42af-97a0-8ec66538c24b\",\\\n \"text\": \"Message text.\",\\\n \"reference_message_id\": \"ce36bba7-3932-4197-9d92-4565a890edf8\",\\\n \"files\": \\[\\\n {\\\n \"id\": \"e30e5ecb-a543-4877-a483-0a1b065bbc59\"\\\n },\\\n {\\\n \"id\": \"3f7b155c-c235-476c-9688-3fa7c1d59ed2\"\\\n }\\\n \\]\\\n}\n\n### Response: undefined\n\n{\\\n \"id\": \"396ca380-83e5-4924-93a5-fca14c554f70\",\\\n \"patient_id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"channel\": \"patient\",\\\n \"text\": \"msg text\",\\\n \"user_type\": \"App\\\\\\\\Models\\\\\\\\Patient\",\\\n \"user_id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"reference_message_id\": **null**,\\\n \"replied_at\": **null**,\\\n \"reply_message_id\": **null**,\\\n \"dismissed_at\": **null**,\\\n \"dismissed_by_user_type\": **null**,\\\n \"dismissed_by_user_id\": **null**,\\\n \"emailed_at\": \"2023-10-24T13:41:09.414220Z\",\\\n \"created_at\": \"2023-10-24T13:41:09.000000Z\",\\\n \"updated_at\": \"2023-10-24T13:41:09.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"user_read_at\": **null**,\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"recent_encounter_id\": \"4ad0d8cb-dc79-4563-8b9b-be2e30f1491e\",\\\n \"user\": {\\\n \"id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"first_name\": \"FirstName\",\\\n \"last_name\": \"LastName\",\\\n \"email\": \"[name+sandbox@test.com](mailto:name+sandbox@test.com)\",\\\n \"active\": **true**,\\\n \"prefix\": \"Sr\",\\\n \"weight\": 80,\\\n \"height\": **null**,\\\n \"gender\": 2,\\\n \"phone_number\": **null**,\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"aa116304-6e65-4ab7-a917-0dbbf39aaef4\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": **null**,\\\n \"current_medications\": **null**,\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"environment_id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"clinician_id\": **null**,\\\n \"metadata\": **null**,\\\n \"intro_video_file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"recent_encounter_id\": \"4ad0d8cb-dc79-4563-8b9b-be2e30f1491e\",\\\n \"created_at\": \"2023-10-03T23:39:44.000000Z\",\\\n \"updated_at\": \"2023-10-24T13:38:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"patient_id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"full_name\": \"FirstName LastName\",\\\n \"abbreviated_name\": \"FirstName L.\",\\\n \"is_live\": **false**,\\\n \"intro_video_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"environment\": {\\\n \"id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"identifier\": \"sandbox\",\\\n \"created_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"updated_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"webhook_url\": **null**,\\\n \"webhook_secret\": **null**,\\\n \"webhook_authorization\": **null**\\\n }\\\n },\\\n \"files\": \\[\\\n {\\\n \"id\": \"0067f10c-1c87-42fc-9c6e-58d1a33b0208\",\\\n \"name\": \"Logo.png\",\\\n \"mime_type\": \"image/png\",\\\n \"path\": \"partners/FovnWapK1WiHk2Rki6I0s05RVyPmi804GOR79DSO.png\",\\\n \"thumbnail_path\": \"partners/0067f10c-1c87-42fc-9c6e-58d1a33b0208_thumbnail.png\",\\\n \"created_at\": \"2022-11-24T14:30:55.000000Z\",\\\n \"updated_at\": \"2023-03-29T10:35:37.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"url\": \"[https://localhost:8000/s3/files/0067f10c-1c87-42fc-9c6e-58d1a33b0208/file?signature=590e2c7823d01a46a30227874ba30bf6ab99855967ff9d5287ed34f392f7a3f9\",](https://localhost:8000/s3/files/0067f10c-1c87-42fc-9c6e-58d1a33b0208/file?signature=590e2c7823d01a46a30227874ba30bf6ab99855967ff9d5287ed34f392f7a3f9\\\",)\\\n \"thumbnail_url\": \"[https://localhost:8000/s3/files/0067f10c-1c87-42fc-9c6e-58d1a33b0208/thumbnail?signature=db1b7610b661ec0af2224dd2827b7c4ec4d6738fa58397b056dd7d5862bfeb78\"](https://localhost:8000/s3/files/0067f10c-1c87-42fc-9c6e-58d1a33b0208/thumbnail?signature=db1b7610b661ec0af2224dd2827b7c4ec4d6738fa58397b056dd7d5862bfeb78\\\")\\\n }\\\n \\],\\\n \"patient\": {\\\n \"id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"first_name\": \"FirstName\",\\\n \"last_name\": \"LastName\",\\\n \"email\": \"[name+sandbox@test.com](mailto:name+sandbox@test.com)\",\\\n \"active\": **true**,\\\n \"prefix\": \"Sr\",\\\n \"weight\": 80,\\\n \"height\": **null**,\\\n \"gender\": 2,\\\n \"phone_number\": **null**,\\\n \"phone_type\": \"2\",\\\n \"address_id\": \"aa116304-6e65-4ab7-a917-0dbbf39aaef4\",\\\n \"driver_license_id\": **null**,\\\n \"allergies\": **null**,\\\n \"current_medications\": **null**,\\\n \"pregnancy\": **false**,\\\n \"partner_id\": \"dcc32340-6606-4756-a4f8-cc7a08b615b5\",\\\n \"environment_id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"clinician_id\": **null**,\\\n \"metadata\": **null**,\\\n \"intro_video_file_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"recent_encounter_id\": \"4ad0d8cb-dc79-4563-8b9b-be2e30f1491e\",\\\n \"created_at\": \"2023-10-03T23:39:44.000000Z\",\\\n \"updated_at\": \"2023-10-24T13:38:05.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"patient_id\": \"813e95aa-3c73-40a3-9289-b13c846c03c5\",\\\n \"full_name\": \"FirstName LastName\",\\\n \"abbreviated_name\": \"FirstName L.\",\\\n \"is_live\": **false**,\\\n \"intro_video_id\": \"ac0c921d-8526-477d-a00d-3fb0c4c8e3a8\",\\\n \"clinician\": **null**,\\\n \"environment\": {\\\n \"id\": \"bf77c962-3915-4d3f-91a3-53cd64799531\",\\\n \"identifier\": \"sandbox\",\\\n \"created_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"updated_at\": \"2023-08-01T02:00:25.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"webhook_url\": **null**,\\\n \"webhook_secret\": **null**,\\\n \"webhook_authorization\": **null**\\\n }\\\n },\\\n \"readings\": \\[\\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Embedding URLs\n\nThe following documentation applies to all white label experiences. Some of this functionality might be limited to certain events.\n\n<**iframe** src=\"{{ mdi_url }}\" allow=\"camera; microphone\"></**iframe**>\n\n## Embedded Form\n\nIf you plan on embedding the intake form on your own page, you may append the following query parameter at the end of the URL provided on workflow request responses to remove borders, branding and other visual elements for a seamless experience:\n\nparam\n\ntype\n\ndescription\n\n**fullscreen**\n\nboolean\\*\n\nIf set to TRUE will remove borders, logos and other visual elements from around the intake form window to make it seamless when embedding it.\n\nYou may also subscribe to [window postMessage events](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) to keep track of important events and user progress. Different workflows may trigger different events.\n\nevent\n\ndata\n\ndescription\n\n**scope**\n\nload\n\n\\-\n\nWhite Label App loaded\n\nall\n\nunload\n\n\\-\n\nUser is attempting to close the screen\n\nall\n\nstart\n\n\\-\n\nUser has started filling out the questionnaire\n\nintake form\n\nfinish\n\n\\-\n\nUser has finished the intake form\n\nintake form\n\nstep\n\nstep, index, estimated, total, question_id\\*\n\nUser has progressed through a step. It can either be a demographic step or customized question\n\nintake form\n\nlogged_in\n\npatient_id\n\nUser has logged in\n\nall\n\nencounter_created\n\nencounter_id, patient_id\n\nEncounter created\n\nintake form\n\npatient_created\n\npatient_id\n\nPatient created\n\nintake form\n\nskipped_question\n\n\\-\n\nUser has skipped a question and progressed through a step.\n\nintake form\n\ndead_end_question\n\n\\-\n\nUser has reached a question that blocks her from progressing on the intake.\n\nintake form\n\notp_ready¹\n\n\\-\n\nUser has reached the OTP screen\n\nall\n\notp_failed¹\n\n\\-\n\nProvided OTP is invalid\n\nall\n\nAn embedded white label app will also support certain events and messages:\n\n**message**\n\n**data**\n\n**description**\n\n**scope**\n\notp¹\n\n*string*\n\nSends in an OTP to be inputted and auto submits the form. Use this message to create a seamless login experience on workflows that require additional authentication\n\nOTP pages\n\nThe following sample showcases how one of the events above would be sent client-side to an iframe with one of our white label experiences embedded:\n\n**const** payload = {\\\n message: 'otp',\\\n data: 'ABCDEF',\\\n};\\\niFrame?.contentWindow?.postMessage(payload, '\\*');\n\nNote by Nov. 12th we will no longer return pre-authenticated URLs for the white label workflows², effectively requiring an OTP code to be inserted manually by the user. If you are embedding them on your website and want to keep a seamless login experience, you should listen for a otp_ready event from the iframe and send an otp message with the verification_code returned by the workflow endpoint like so:\n\nwindow.addEventListener('message', (e) **=>** {\\\n **const** event = [e.data](http://e.data).event;\\\n **if** (event === 'otp_ready') {\\\n iframe.contentWindow.postMessage({ message: 'otp', data: verification_code }, '\\*');\\\n }\\\n});\n\n¹: Feature will only be available after Nov 12th, 2024.\\\n²: Intake Forms are excluded from this change. ### Method: DOC >>... > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### 🔑 Authentication noauth\n\nParam\n\nvalue\n\nType\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Get authenticated partner\n\nGet the following logged partner information:\n\n- Profile\n\n- Address\n\n### Method: GET\n\n{{baseUrl}}/partner\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### 🔑 Authentication bearer\n\nParam\n\nvalue\n\nType\n\ntoken\n\n{{token}}\n\nstring\n\n### Response: 200\n\n{\\\n \"name\": \"MDI USA Partner Editer\",\\\n \"active\": **true**,\\\n \"partner_id\": \"33778db3-8707-4628-81af-4c6451f9f0b6\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Request access token\n\nWith this endpoint, you can exchange your **Client ID** and **Client Secret** for an access token with *limited lifetime*.\n\nThe access token allows your application to make authenticated requests to the MD Integrations API.\n\nFor more details on the expected flow, you can checkout the **Authentication** section in the **Introduction**.\n\n## Payload\n\nFor this request, all fields in the payload are **required**.\n\nfield\n\ntype\n\ndescription\n\ngrant_type\n\nstring\\*\n\nShould always be client_credentials\n\nclient_id\n\nstring\\*\n\nClient ID credential\n\nclient_secret\n\nstring\\*\n\nClient Secret credential\n\nscope\n\nstring\\*\n\nShould always be \\\\\\*\n\n## Expired tokens\n\nWhenever an access token expires, you should request a brand new one for making new requests.\n\n## Client Credentials\n\nYour credentials will be provided to you by the MD Integrations team.\n\nKeep in mind the importance of **protecting your credentials** to avoid unauthorized access. ### Method: POST >>{{baseUrl}}/partner/auth/token > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"grant_type\": \"client_credentials\",\\\n \"client_id\": \"7fe656f8-d29d-439d-bcbc-565654808488\",\\\n \"client_secret\": \"2hxOxYfzkKtPqm27g2hOPJuWoHPycq9dGfFhY1hF\",\\\n \"scope\": \"\\*\"\\\n}\n\n### 🔑 Authentication noauth\n\nParam\n\nvalue\n\nType\n\n### Response: 200\n\n{\\\n \"token_type\": \"Bearer\",\\\n \"expires_in\": 86400,\\\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJkOWIwY2E3MC02N2VhLTQ1MDgtODBhZC1jNDU5YzczZmMzNWEiLCJqdGkiOiIzZjY1NWI2NWU3N2UwYmQ5MWQzMjNhNDRhNDY2NzZmM2ViZGE2MTEwZWJlNDQ2ZTZlZDZiYjI4YTExZTc5Mjc0ZGE5YWE1NWU4NGNhYjA4MSIsImlhdCI6MTYxNDI4Mjc0MCwibmJmIjoxNjE0MjgyNzQwLCJleHAiOjE2MTQzNjkxNDAsInN1YiI6IiIsInNjb3BlcyI6WyIqIl19.juvuznhdcwfj0eKcQb9pFcit6SsRWhcqjOHlCd8oT3RLs-DI6M9Y2nDgQerMlYIS0aQklaIrtGiEZUkodliCPFsQ6WH4UqQgCbawM_N37occ_SWUqW6wSVhO2pJWXgC7exbM_WyS_bUrjk2bFLAMVtQjR4iVYi81MNLk0EYvd91ZLt4cnDEXms_xf6bEZfKn8h_y0HhhZ_U6Br1bKg3BPvMWWHq27RtWHvKLvviKXRaeLkuFJcrWd-TgAH8GnIx4PsXB_4KGAvT9P8eHcEdziTo3AMJDcOfKQqmAMA29fceaH1k6nLrM4wuY_ldI_NHvI8o4de1UGqHqlR8isybf1Y3usPF01JxAMjBxzoGhmX_TqsRuIXW8NLtK1Ttasgk2H7x_Z6xaPaPpsVBc76Jyp7AbdEuefEUCWg1krOu0z9XoU4gKYkUlG6jzrgM4Tt4N47OG4uFa-10DhgvHJkDEurk20pj6laqyo5ImakCqakH-bY0qvarQmgn-lSuyf9B__FCG0ZtXx-gHMGvTlKe2ujBbZOLQ5YzajpF3J45pXzRIGUVhpPjFC7tlVg6eI1cu4zMdLODRBLPK8bAFsb6QNBgNSLQV6ASiF0oFn1DOO_1j6msLgPXH9vTPkALiIMDBVoIyqmpREid0bC1wIVqfnXWRgYBJB7XIt21Gfj-NPMA\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ # 📁 Collection: Webhooks ## Webhook Events\n\nOur API will send information to your application about events that occur on the platform.\n\n## **Retry**\n\nWe’ve implemented resend to make **4 retries** within 1 hour after the first failed event (every 15 minutes).\n\n*Important note*\n\nRetry events can be sent after new events have already happened in the application, for example, status changes or message exchanges, so the implementation for receiving events must take into account the **timestamp** information contained in the payload.\n\nThis timestamp is related to the first attempt to send the event.\n\n## 📁 Collection: Status Transitions\n\nundefined\n\n## End-point: Case Created\n\nThis event will be dispatched when a case has been created.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_created\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Support\n\nThis event will be dispatched when a patient’s case has been moved to Support status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_transferred_to_support\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Waiting\n\nThis event will be dispatched when a patient’s case has been moved to Waiting status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_waiting\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Approved\n\nThis event will be dispatched when a patient’s case has been sent to the Approved status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_approved\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Processing\n\nThis event will be dispatched when a patient’s case has been move to Processing status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_processing\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Completed\n\nThis event will be dispatched when a patient’s case has been moved to Completed status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_completed\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Cancelled\n\nThis event will be dispatched when a patient’s case has been moved to Cancelled status.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_cancelled\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: File undefined\n\n## End-point: Case File Added\n\nThis event will be dispatched when a file is added to an encounter.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_file_added\",\\\n \"case_id\": \"be2fc48f-df75-4cd7-a78a-89d51cc46e17\",\\\n \"file_id\": \"37582b4e-9587-4ca7-9911-0703c534d5d3\",\\\n \"metadata\": \"example of metadata\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case File Deleted\n\nThis event will be dispatched when a file is deleted from an encounter.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_file_deleted\",\\\n \"case_id\": \"be2fc48f-df75-4cd7-a78a-89d51cc46e17\",\\\n \"file_id\": \"37582b4e-9587-4ca7-9911-0703c534d5d3\",\\\n \"metadata\": \"example of metadata\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Medical Necessity Letter Generated\n\nThis event will be dispatched when a medical necessity PDF is generated.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1732920747,\\\n \"event_type\": \"medical_necessity_file_generated\",\\\n \"file_id\": \"9ac56985-a108-4f8b-83f3-eeaec00b8260\",\\\n \"patient_id\": \"65d186ef-89ad-469b-8a88-72ec48399f2a\",\\\n \"message_id\": \"470017d7-fb23-47df-893b-3f87d1033872\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case File Lab Results Processed\n\nThis event will be dispatched when a lab result file is processed.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"file_lab_results_processed\",\\\n \"status\": \"processed\",\\\n \"case_id\": \"be2fc48f-df75-4cd7-a78a-89d51cc46e17\",\\\n \"file_id\": \"37582b4e-9587-4ca7-9911-0703c534d5d3\",\\\n \"file_type\": \"lab-results\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Assignment undefined\n\n## End-point: Case Assigned to Clinician\n\nThis event will be dispatched when a patient case has been assigned to a clinician.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"case_assigned_to_clinician\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Clinical Note undefined\n\n## End-point: Clinical Note Added\n\nThis event will be dispatched when a clinical note is added to an encounter.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"clinical_note_created\",\\\n \"note_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Tag undefined\n\n## End-point: Case Tag Attached\n\nThis event will be dispatched when a tag is attached to an encounter.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666373940,\\\n \"event_type\": \"case_tag_attached\",\\\n \"encounter_id\": \"bb0403b9-a9eb-4402-9965-225f8cfaa1d0\",\\\n \"case_id\": \"bb0403b9-a9eb-4402-9965-225f8cfaa1d0\",\\\n \"tag_id\": \"19eb2aee-4b9f-4a5a-96d4-0c7fe8ad08e5\",\\\n \"notes\": \"example of notes\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Charges undefined\n\n## End-point: Case Cancelled Amount Charge\n\nThis event will be dispatched when a case is cancelled.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733258743,\\\n \"event_type\": \"partner_charge\",\\\n \"encounter_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"case_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"patient_id\": \"9cc18f70-f27a-43c5-9fe4-c9e8ecc24514\",\\\n \"charge_type\": \"case_cancelled\",\\\n \"charge_amount\": 2.1,\\\n \"offering_amount_charge\": 2.0\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Completed Amount Charge\n\nThis event will be dispatched when a case is completed.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733258743,\\\n \"event_type\": \"partner_charge\",\\\n \"encounter_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"case_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"patient_id\": \"9cc18f70-f27a-43c5-9fe4-c9e8ecc24514\",\\\n \"charge_type\": \"case_completed\",\\\n \"charge_amount\": 2.1,\\\n \"offering_amount_charge\": 2.0\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Change Chargeable Amount Charge\n\nThis event will be dispatched when a case is change chargeable.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733258743,\\\n \"event_type\": \"partner_charge\",\\\n \"encounter_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"case_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"patient_id\": \"9cc18f70-f27a-43c5-9fe4-c9e8ecc24514\",\\\n \"charge_type\": \"case_chargeable_change\",\\\n \"charge_amount\": 0,\\\n \"offering_amount_charge\": 0\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Offering undefined\n\n## End-point: Offering Submitted\n\nThis event will be dispatched when a treatment is approved and ready to be ordered, depending on the offering type:\n\n- Dosespot offerings: prescription has been submitted and receipt was acknowledged by the pharmacy;\n\n- Boothwyn offerings: prescription has been sent to the pharmacy, and order was initiated and is currently being fulfilled;\n\n- Services: the service PDF is ready to be downloaded.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"offering_submitted\",\\\n \"case_id\": \"be2fc48f-df75-4cd7-a78a-89d51cc46e17\",\\\n \"metadata\": \"test\",\\\n \"offerings\":\\[\\\n {\\\n \"id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"case_offering_id\": \"da78172e-e253-4458-8bc2-6acbd34f28a6\",\\\n \"title\": \"supply example\",\\\n \"name\": \"supply example\",\\\n \"directions\": \"directions\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"19e21647-e5bf-4996-b9b4-154aab1963ad\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:08.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"ndc\": **null**,\\\n \"otc\": **null**,\\\n \"upc\": **null**,\\\n \"name\": \"supply example\",\\\n \"title\": \"supply example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"directions\",\\\n \"updated_at\": \"2025-04-25T13:44:53.000000Z\",\\\n \"days_supply\": **null**,\\\n \"is_obsolete\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"dosespot_supply_id\": 21\\\n },\\\n \"product_id\": \"dfa4b67d-afe1-46b7-acfe-7c6c4d11abd8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotSupply\"\\\n },\\\n {\\\n \"id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"case_offering_id\": \"70dafa3e-63ab-4d7a-b7ec-bb9c005ff6e6\",\\\n \"title\": \"compound example\",\\\n \"name\": \"compound example\",\\\n \"directions\": \"abc\",\\\n \"is_additional_approval_needed\": **false**,\\\n \"thank_you_note\": \"Thank you!\",\\\n \"clinical_note\": \"Notes from the MD.\",\\\n \"status\": \"pending\",\\\n \"status_details\": **null**,\\\n \"order\": 1,\\\n \"is_important\": **false**,\\\n \"offerable_type\": \"App\\\\\\\\Models\\\\\\\\Offering\",\\\n \"offerable_id\": \"5ff1eae1-1566-4dd5-ad1a-457b105d59ac\",\\\n \"order_status\": **null**,\\\n \"order_date\": **null**,\\\n \"order_details\": **null**,\\\n \"order_updated\": **null**,\\\n \"created_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"updated_at\": \"2025-05-29T22:06:32.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"product\": {\\\n \"id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"name\": \"compound example\",\\\n \"title\": \"compound example\",\\\n \"refills\": 1,\\\n \"metadata\": **null**,\\\n \"quantity\": \"2\",\\\n \"created_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"deleted_at\": **null**,\\\n \"directions\": \"abc\",\\\n \"updated_at\": \"2025-04-25T13:12:48.000000Z\",\\\n \"days_supply\": **null**,\\\n \"pharmacy_id\": **null**,\\\n \"clinician_id\": **null**,\\\n \"dispense_unit\": \"Packet\",\\\n \"pharmacy_name\": **null**,\\\n \"effective_date\": **null**,\\\n \"force_pharmacy\": **false**,\\\n \"pharmacy_notes\": \"Notes for the parmacy.\",\\\n \"dispense_unit_id\": 21,\\\n \"allow_substitutions\": **true**\\\n },\\\n \"product_id\": \"227eeedb-3ad4-4b0a-adda-a09f4ba803c8\",\\\n \"product_type\": \"App\\\\\\\\Models\\\\\\\\DosespotCompound\"\\\n }\\\n \\]\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Prescription Insurance Coverage Updated\n\nThis event will be dispatched when a prescription’s insurance coverage is updated.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"prescription_insurance_coverage_updated\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"prescrption_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Order undefined\n\n## End-point: Case Order Status Changed\n\nThis event will be dispatched when a order status changes.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733258743,\\\n \"event_type\": \"order_status_changed\",\\\n \"encounter_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"case_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"order_status\": \"fulfilled\",\\\n \"order_details\": \"Tracking Number: 101010\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Case Order Tracking Number Changed\n\nThis event will be dispatched when a order tracking number changes.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733258743,\\\n \"event_type\": \"order_tracking_number_changed\",\\\n \"encounter_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"case_id\": \"5124ae37-19db-464e-870d-49a9a33a5153\",\\\n \"order_status\": \"fulfilled\",\\\n \"order_details\": \"Tracking Number: 101010\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Voucher Created\n\nThis event will be dispatched when a voucher has been used and an encounter has been created from it. From this point the voucher is no longer valid.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1718372589,\\\n \"event_type\": \"voucher_created\",\\\n \"voucher_id\": \"91c7bd33-6161-4112-96a3-f46c297689dc\",\\\n \"patient_id\": \"afe6cb7e-f21e-4c92-bfa6-39a8b24c3376\",\\\n \"partner_questionnaire_id\": \"d8bc8352-057e-495b-b5df-cdba45679860\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Voucher Updated\n\nThis event will be dispatched when a voucher has been used and an encounter has been created from it. From this point the voucher is no longer valid.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1718372589,\\\n \"event_type\": \"voucher_updated\",\\\n \"voucher_id\": \"91c7bd33-6161-4112-96a3-f46c297689dc\",\\\n \"patient_id\": \"afe6cb7e-f21e-4c92-bfa6-39a8b24c3376\",\\\n \"partner_questionnaire_id\": \"d8bc8352-057e-495b-b5df-cdba45679860\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Voucher Used\n\nThis event will be dispatched when a voucher has been used and an encounter has been created from it. From this point the voucher is no longer valid.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"voucher_used\",\\\n \"case_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"voucher_id\": \"aa97ff5f-7b36-4abe-a9f9-0ab2990fa70b\",\\\n \"patient_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Voucher Reminder Sent\n\nThis event will be dispatched when we send the patient a reminder to complete their intake form.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"voucher_reminder_sent\",\\\n \"voucher_id\": \"aa97ff5f-7b36-4abe-a9f9-0ab2990fa70b\",\\\n \"patient_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Voucher Expired\n\nThis event will be dispatched when a voucher has been expired.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"voucher_expired\",\\\n \"voucher_id\": \"aa97ff5f-7b36-4abe-a9f9-0ab2990fa70b\",\\\n \"patient_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"partner_questionnaire_id\": \"e54c8c86-fc14-42f3-8768-40010b85aede\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Workflows undefined\n\n## End-point: Drivers License Requested\n\nThis event will be dispatched when a clinician or support user requests the patient to upload a Drivers License.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"drivers_license_requested\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Intro Video Requested\n\nThis event will be dispatched when a clinician or support user requests the patient to upload an Intro Video.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"intro_video_requested\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: File Upload Requested\n\nThis event will be dispatched when a clinician or support user requests the patient to upload a file.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"file_upload_requested\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"case_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Exam Update Requested\n\nThis event will be dispatched when a clinician or support user requests the patient to update her exam details such as height, weight, allergies, medications, etc.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"exam_requested\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Preferred Pharmacy Requested\n\nThis event will be dispatched when a patient is deleted.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"preferred_pharmacy_requested\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\",\\\n \"access_link\": \"pre-auth link to patient app\",\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ## 📁 Collection: Tag undefined\n\n## End-point: Patient Tag Attached\n\nThis event will be dispatched when a tag is attached to a patient.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700767835,\\\n \"event_type\": \"patient_tag_attached\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"tag_id\": \"89282dba-cf88-4dc8-b26e-6653ccbf56ec\",\\\n \"notes\": \"This is an example of notes field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Patient Created\n\nThis event will be dispatched when a patient is created.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"patient_created\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Patient Deleted\n\nThis event will be dispatched when a patient is deleted.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"patient_deleted\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Patient Modified\n\nThis event will be dispatched when a patient is modified.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"patient_modified\",\\\n \"patient_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Patient Email/SMS Opt-in/out\n\nThis event will be dispatched when a patient has their preference for notifications changed.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API\n\n**Event Type** = Can be **patient_opt_in** when the patient will receive notifications or **patient_opt_out** when the patient will stop to receive notifications\n\n**Channel** = Can be **email** for notifications via e-mail or **sms** for notifications via text message ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"patient_opt_out\",\\\n \"patient_id\": \"26f3d453-09ff-41cb-9fc6-724d1b77277c\",\\\n \"metadata\": \"This is an example of metadata field.\",\\\n \"channel\": \"sms\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Patient Insurance Coverage Updated\n\nThis event will be dispatched when a patient’s insurance coverage is updated.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1700768392,\\\n \"event_type\": \"patient_insurance_coverage_updated\",\\\n \"patient_id\": \"796fef8b-a4d5-4e19-8a58-852adfbe8709\",\\\n \"metadata\": \"This is an example of metadata field.\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Message Created\n\nThis event will be dispatched when a patient has a new message.\n\n = *Your API endpoint was previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization was previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API\n\n**Notes**:\n\nAvailable options for user_type and dismissed_by_user_type param:\n\n- App\\\\Models\\\\Patient\n\n- App\\\\Models\\\\Clinician\n\n- App\\\\Models\\\\SupportStaff ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1666384936,\\\n \"event_type\": \"message_created\",\\\n \"message_id\": \"a8f51b2a-c544-4088-bc46-d1da54e93410\",\\\n \"patient_id\": \"b4a1e9cd-4f0b-4787-b77f-1bfb7293f6aa\",\\\n \"user_type\": \"App/Models/Patient\",\\\n \"channel\": \"patient\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Notification Sent\n\nThis event will be dispatched when a patient has a new notification is sent.\n\n = *Your API endpoint was previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization was previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API\n\n**Notes**:\n\nare used to identify who will be notified inside MDI platform. The field notified_model_type can receive the follow data\n\nThese fields notified_model_id and notified_model_type are used to identify who will be notified inside MDI platform. The field notified_model_type can reveive one of the following data:\n\n- App\\\\Models\\\\Clinician\n\n- App\\\\Models\\\\InternalSupportStaff\n\n- App\\\\Models\\\\SupportStaff\n\nWe can also identify the notification through the inbox. The following inboxes can receive notifications:\n\n- triage\n\n- clinician\n\n- support_staff\n\n- internal_support_staff\n\n- dismissed ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nSignature\n\n### Headers\n\nContent-Type\n\nValue\n\nAuthorization\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1738320042,\\\n \"event_type\": \"notification_sent\",\\\n \"patient_id\": \"6336e2bc-f623-4608-9cc0-f84fb0dde20d\",\\\n \"notification_id\": \"3ef730ac-6484-47d0-a50c-6d2746035552\",\\\n \"notified_model_id\": **null**,\\\n \"notified_model_type\": \"App\\\\\\\\Models\\\\\\\\SupportStaff\",\\\n \"inbox\": \"dismissed\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Text Message Amount Charge\n\nThis event will be dispatched when a text message is created.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733247306,\\\n \"event_type\": \"partner_charge\",\\\n \"patient_id\": \"4d7ca035-f1f9-48f1-be0e-f759d622aebe\",\\\n \"charge_type\": \"text_message\",\\\n \"charge_amount\": \"0.10\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Partner Additional Charge Amount\n\nThis event will be dispatched when a additional charge is created.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733256506,\\\n \"event_type\": \"partner_charge\",\\\n \"charge_type\": \"additional_charge\",\\\n \"charge_amount\": 749\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃\n\n## End-point: Vouched Amount Charge\n\nThis event will be dispatched when a vouched is run.\n\n = *Your API endpoint previously registered on our platform.*\n\n**Secret Key** = *Your Secret Key previously registered on our platform.*\n\nThe request will have a header called Signature created by Secret Key that will contain a signature the receiving app can use to verify the payload hasn’t been tampered with.\n\nTo create the Signature we use the Secret Key as a salt with SHA256 following this example below:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret);\n\n**Authorization** = *Your Authorization previously registered on our platform.*\n\nThe request will have a header called Authorization used to authenticate to your API ### Method: POST >> > ### Headers\n\nContent-Type\n\nValue\n\nAccept\n\napplication/json\n\n### Headers\n\nContent-Type\n\nValue\n\nContent-Type\n\napplication/json\n\n### Body (**raw**)\n\n{\\\n \"timestamp\": 1733246084,\\\n \"event_type\": \"partner_charge\",\\\n \"patient_id\": \"5d0d39bd-0622-4cc9-aac5-4d3f65ffd433\",\\\n \"charge_type\": \"vouched_run\",\\\n \"charge_amount\": \"0.10\"\\\n}\n\n⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ","f56fa723-4414-4d2e-af45-5fdf3cd4a242","2025-07-09T22:03:21.905Z","2025-07-11T00:11:36.419Z","96b00a7d-b4b0-4d11-b888-f991b65d4097",{"_25":475,"_72":480},"Test_Data",[],[],{"_101":484,"_103":485,"_105":-5,"_106":486,"_108":-5,"_13":-5,"_95":487,"_97":488,"_25":489,"_27":28,"_111":-5,"_112":490,"_114":491},"Metadata field from cases","metadata-field-from-cases","\\\nYou won't get any data under the metadata field within the Case related webhooks for the Shopify integration. For the case related Webhook, likes *Case Completed*, we return the metadata you sent when creating the case, which can't be done when using the Shopify plug-in integration.","2025-12-18T21:03:58.085Z","2025-12-18T21:04:32.099Z","4a006a64-7efe-4ef7-8156-2ecba77f7161",[],[],{"_101":493,"_103":494,"_105":-5,"_106":495,"_108":-5,"_13":-5,"_95":496,"_97":496,"_25":497,"_27":28,"_111":-5,"_112":498,"_114":499},"Missing Consult Fee at Checkout","missing-consult-fee-at-checkout","\nYour evidence video MUST show the doctor consult fee for the patient. Most companies include it as a small line item as part of their overall fee. This is a very important component of regulatory compliance as only a medical PC can bill for medical consults (a regular company cannot and would be in violation of corporate practice of medicine and fee splitting law). You are billing on our behalf and passing through the fee to us, but to make that compliant the fee must be listed at check out (similar to how Ticketmaster line items their fee). It should say something like \\*includes $XX doctor consult fee\".","2025-10-30T14:09:45.448Z","d2d3c65d-c255-4568-950f-14dd8e0e2a04",[],[],{"_101":501,"_103":502,"_105":-5,"_106":503,"_108":-5,"_13":-5,"_95":504,"_97":504,"_25":505,"_27":28,"_111":-5,"_112":506,"_114":507},"Order and fulfillment","order-and-fulfillment","\nPlease note that we only handle the e-prescribing flow on our side, which means we don’t place orders for the pharmacy to fulfill. Any information related to the order and fulfillment parts of the process will have to be handled between you and the pharmacy.","2025-12-18T21:04:55.384Z","20efce8b-f2bf-4e4f-a64d-85e7b2f88990",[],[],{"_101":509,"_103":510,"_105":-5,"_106":511,"_108":-5,"_13":-5,"_95":512,"_97":512,"_25":513,"_27":28,"_111":-5,"_112":514,"_114":515},"Patient information transmitted to pharmacies","patient-information-transmitted-to-pharmacies","\nWe basically send patient's demographic details over to pharmacies only (like name, address details, phone number, DoB, etc.). We don't send information about patients' medical history, like allergies, current medications, etc.\\\n\\\nAs for pharmacies in Canada, we don't transmit any information over to them on our end, as we don't have any electronic service available in there for transmitting prescriptions.","2026-01-26T23:32:10.787Z","750ebcda-0372-4744-bdf1-8ec7a9d38731",[],[],{"_101":517,"_103":518,"_105":-5,"_106":519,"_108":-5,"_13":-5,"_95":520,"_97":520,"_25":521,"_27":28,"_111":-5,"_112":522,"_114":523},"Patient messages","patient-messages","Messages are indeed associated with a patient record only, not with encounters. Therefore, when calling the [Get Messages](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#0e338c50-52c3-4ac0-a7a3-0e6cb7a895a0) Endpoint, we'll return all the messages history associated with the patient and there is no way of separating them by encounter_id.\\\nWe transitioned from encounter-based messaging to a patient-centered model a while ago specifically to eliminate confusion. Previously, doctors would receive messages about past treatments or unrelated issues within their most recent encounter, making it difficult to maintain a clear and relevant medical history","2026-03-05T02:35:34.713Z","81c5b30e-1437-4b1e-b931-e3d8ed6d65bf",[],[],{"_101":525,"_103":526,"_105":-5,"_106":527,"_108":-5,"_13":-5,"_95":528,"_97":528,"_25":529,"_27":28,"_111":-5,"_112":530,"_114":531},"Patient's phone number and email address","patients-phone-number-and-email-address","Both the patient's email address and phone number are required by Dosespot (our e-prescribing partner). If not provided, the patient profile sync will fail between MDI and Dosespot. The phone number is also required for clinical reasons. Those are mandatory fields and they need to be valid, otherwise the Patient record creation will fail.","2026-03-11T18:31:21.927Z","2653d768-67f6-4eeb-bcd3-5b5dc43def69",[],[],{"_101":533,"_103":534,"_105":-5,"_106":535,"_108":-5,"_13":-5,"_95":536,"_97":536,"_25":537,"_27":28,"_111":-5,"_112":538,"_114":539},"Pre-authenticating patients when embedding our URLs","pre-authenticating-patients-when-embedding-our-urls","To retrieve the OTP/passcode, you can listen for the otp_ready event emitted by the iframe, then send an otp message including the verification_code returned by the workflow endpoint.\\\nSince the 2FA code will be included in the same payload we send to you (and accessible via a postMessage method), you can use it to generate a QR code if needed.\n\nFor pre-authentication flows, you may either forward the 2FA code to the patient for manual entry (as a QR code for instance) or automatically populate the 2FA field on the patient’s behalf.\n\nDocumentation on how to embed our white label URLs.","2026-03-19T17:06:49.041Z","acbd1ec2-317f-4446-8ced-08a5995afcc7",[],[],{"_101":541,"_103":542,"_105":-5,"_106":543,"_108":-5,"_13":-5,"_95":544,"_97":544,"_25":545,"_27":28,"_111":-5,"_112":546,"_114":547},"Prescription Delivery Issue","prescription-delivery-issue","If a prescription appears as *\"prescribed\"* on our end), it indicates that the prescription was successfully submitted to the pharmacy and should have been received by them. Since Dosespot transmits prescriptions to Surescripts, which then forwards them to the pharmacy, there is a possibility that if the electronic submission fails on their side, Surescripts may use a fallback method (such as fax) to complete the delivery. In some cases, however, this fallback may not occur. For this reason, if the pharmacy claims not having received a prescription (which is quite common), we recommend manually resubmitting the pending prescriptions from the case. However, please note that prescriptions can only be resubmitted if the encounter was created less than a month ago.","2025-12-18T21:02:13.811Z","5d2395df-e360-45ab-9c66-f6651b7af78e",[],[],{"_101":549,"_103":550,"_105":551,"_106":552,"_108":-5,"_13":-5,"_95":553,"_97":553,"_25":554,"_27":28,"_111":-5,"_112":555,"_114":556},"Prescriptions missing at the pharmacy","prescriptions-missing-at-the-pharmacy","https://mdintegrations.unthread.io/dashboard/inbox/all/conversations/83d7ff6a-0304-48d5-a7c4-acf7b5e3183c","If a prescription is marked as \"prescribed\" in the platform but the pharmacy is unable to locate it, the issue may have occurred during the transmission of the script between Surescripts and the pharmacy. In such cases, Surescripts typically faxes the prescription to the pharmacy.\n\nTo resolve this issue:\n\n1. Contact your pharmacy representative and ask them to check their fax records for the prescription.\n2. If the pharmacy is still unable to locate the prescription, you can resubmit it by following these steps:\n - Click the \"Manage\" button under the Treatments panel.\n - Select \"Resubmit Prescriptions\".\n\nThis should help ensure the prescription is successfully transmitted to the pharmacy.","2025-07-14T14:04:54.895Z","00bcce46-11f0-41bd-bf17-56e402bf0377",[],[],{"_101":558,"_103":559,"_105":-5,"_106":560,"_108":-5,"_13":-5,"_95":561,"_97":561,"_25":562,"_27":28,"_111":-5,"_112":563,"_114":564},"Prescriptions that are not received by the pharmacy","prescriptions-that-are-not-received-by-the-pharmacy","\nIf a prescription appears as **\"prescribed\"** on our end it indicates that the prescription was successfully submitted to the pharmacy and should have been received by them. Since Dosespot transmits prescriptions to Surescripts, which then forwards them to the pharmacy, there is a possibility that if the electronic submission fails on their side, Surescripts may use a fallback method (such as fax) to complete the delivery. In some cases, however, this fallback may not occur. For this reason, if the pharmacy claims not having received a prescription, your Support team can open the case and manually resubmit the pending prescription by selecting the **Manage >** **Resubmit** option next to the prescription.","2025-09-09T20:41:52.610Z","b7393ae0-039e-4f46-8f9d-216f56dce8d9",[],[],{"_101":566,"_103":567,"_105":-5,"_106":568,"_108":-5,"_13":-5,"_95":569,"_97":569,"_25":570,"_27":28,"_111":-5,"_112":571,"_114":572},"Prescription Stuck due to Dosespot error","prescription-stuck-due-to-dosespot-error","The 1+ country code from the patient's phone number is not required and may lead to Dosespot errors if passed over to us when creating a profile for the patient. Any phone number that is not valid within the US will also lead to Dosespot errors when the prescription gets submitted to the pharmacy.","2026-01-27T16:22:13.830Z","ab2832ea-45c9-453c-ad66-b71d0c83f100",[],[],{"_101":574,"_103":575,"_105":-5,"_106":576,"_108":-5,"_13":-5,"_95":577,"_97":577,"_25":578,"_27":28,"_111":-5,"_112":579,"_114":580},"Question about intake/user payment sequence and case progression","question-about-intakeuser-payment-sequence-and-case-progression","Yes, you can embed our URLs and use the strategy described in our docs to pre-authenticate it.\\\n[Here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#1beb92b7-68f6-432d-b50d-5dab9fb966eb|https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#1beb92b7-68f6-432d-b50d-5dab9fb966eb) are instructions on how to pre-authenticate users when embedding our URLs.\n\nWe'll be sending the 2FA code on the same payload to you and a postMessage method will be available so you can auto input the 2FA code on behalf of the patient to pre-authenticate them.","2025-08-29T19:37:59.688Z","769729ca-2831-4d03-b486-b46b18b280be",[],[],{"_101":574,"_103":582,"_105":-5,"_106":583,"_108":-5,"_13":-5,"_95":584,"_97":584,"_25":585,"_27":28,"_111":-5,"_112":586,"_114":587},"question-about-intakeuser-payment-sequence-and-case-progression-2","That's correct. The hold_status Endpoint was actually created specially for this purpose. When creating an intake voucher, you'll have to set the hold_status flag to true and then release the case (set the flag to false) once you acknowledge payment receipt, so the case will automatically move from the Created to the Assigned folder and get automatically assigned to a doctor.\\\nI've seen partners using both approaches, but we normally hear that placing the intake after checkout leads to less user abandonment.","2025-08-29T19:37:08.992Z","8d28d2e8-4d16-4431-99b4-aae2f26c0142",[],[],{"_101":589,"_103":590,"_105":-5,"_106":591,"_108":-5,"_13":-5,"_95":592,"_97":592,"_25":593,"_27":28,"_111":-5,"_112":594,"_114":595},"Question about prefilling email in MDI Patient Zone login","question-about-prefilling-email-in-mdi-patient-zone-login","[Here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#8fe42f58-4c7d-47f4-8daf-b8aa33558d78) is the API endpoint you'll want to use to generate a pre-authenticated URL for your patients to login directly in the platform. That URL can either be embedded on your page (that's where Ana's link comes into play) or you can redirect patients to it. Note that that URL will contain an `auth_link` and a `verification_code` patient's need to type in order to complete the auth process. You'll have to inform them of that code or follow some of the instructions on embedding to make that process transparent","2025-08-21T20:17:08.719Z","7516bdb5-1c22-47d4-b948-0933deab103a",[],[],{"_101":597,"_103":598,"_105":-5,"_106":599,"_108":-5,"_13":-5,"_95":600,"_97":601,"_25":602,"_27":28,"_111":-5,"_112":603,"_114":604},"Refills and monthly subscriptions","refills-and-monthly-subscriptions","We don't have any logic in place to calculate the remaining number of refills pending for a patient and then trigger an event (like a reorder reminder or a new case) based on that. Therefore, please refer to the use cases below to address refills and monthly subscriptions accordingly:\n\n**For use cases like hair loss and ED**: normally we'll do up to a year supply of refills. Considering that we'll only manage the e-prescribing flow, once the prescription is at the pharmacy you would just initiate orders through the pharmacy ordering API on your side (as you would for traditional e-commerce fulfillment). Normally, the pharmacies will tick down our refills over the course of the year to zero without additional action from the doctor. Depending on the pharmacy, even if the prescription is issued for 0 refills, you would just have to trigger the order requests over to the pharmacy, according to the subscriptions plan that the patient has purchased. Therefore, the patient could actually subscribe either for a 3, 9 or 12 months of supplies and the prescription would be the same on our side - with 0 refills - so you would just change the prescription quantity as part of your integration with the pharmacy. Once the prescription expires (after the one-year period), you’ll need to create a new encounter for the patient. This means that patients will likely need to repeat the initial process: select a product from your store, complete the checkout and fill out the intake form associated with the product.\n\n**For weight-loss**: If you plan to use our white labeled intakes, we have initial and refills intakes, so one option would be to set up an email automation that sends patients a link to the refill intake after a set period following their original order. For the initial intake, our medical team will normally associate the initial dosage of the GLP-1 offering (Semaglutide, Tizerpatide, etc.). As for the refill intake, our intake logic will automatically associate the correct offering within the patient's follow-up encounter based on their response to the intake's questions (e.g., whether they wish to increase, decrease or stay at their current dose). GLP1 prescriptions also require doctor consultation every 90 days. Because of this, you have the choice to do 30 days or 90 days prescriptions and send the refill intake to the patient following their initial order.\n\n**For weight-loss (Shopify or WooCommerce integration)**: when using our Shopify plug-in, one option is to create separate products specifically for refills. You can then set up an email automation to send patients a link to that refill product on Shopify after a certain period following the original order. When they check out, they’ll be prompted to complete a refill intake (which you'll associate with your store's refill product on MDI), ensuring everything is processed correctly. As for subscriptions, currently, our plug-in doesn’t include any logic for subscription models or for tracking the remaining supplies on multi-month products. The process is straightforward: it simply links a product to an intake and presents that intake to the patient after they go through the checkout process. That said, you can still handle multi-month products by either collecting payment upfront and/or using third-party vendors or other plug-ins that manage subscriptions within Shopify *(we are not familiar with how that works in details, though)*. GLP1 prescriptions also require doctor consultation every 90 days. Because of this, you have the choice to do 30 days or 90 days prescriptions and send the refill intake to the patient following their initial order.\n\nOn MDI, the doctor would be available for the patient any time during that year for messaging (with no additional charge).\n\nHow the order and fulfillment process will work with pharmacies:\n\nConsidering that the ordering process is specific to each pharmacy (and you'll have to reach out to them to get more details about it), typically you'll find two different scenarios:\n\n**1.** **Pharmacies that bill you at the end of the month:** In this case the pharmacy will automatically fulfill any prescriptions we send them and based on some information we send along with the prescription and an existing relationship you have with them, they'll charge you for these orders at the end of the month. You wouldn't need any additional setup in this case unless you need to capture order's tracking number for instance.\n\n**2. Pharmacies that require an order to be sent to them:** In this case, you'll have to put additional systems/development work to receive a webhook notification from us and put an electronic order with the pharmacy using their ordering API. Some pharmacies may support receiving the order manually through their EHR system or email.","2026-02-12T19:15:50.853Z","2026-02-12T19:15:54.918Z","0fee3cdb-e5c6-4c0f-bac6-eff3b6b33a49",[],[],{"_101":606,"_103":607,"_105":-5,"_106":608,"_108":-5,"_13":-5,"_95":609,"_97":609,"_25":610,"_27":28,"_111":-5,"_112":611,"_114":612},"Request for advance notice on API endpoint changes","request-for-advance-notice-on-api-endpoint-changes","\nPlease note that in June we introduced a new *case*offerings field, which replaced the *case*prescriptions field. To allow our partners have a smooth transition, the new **offerings** structure has been coexisting along with the old **prescriptions** structure, but the latter will eventually be fully deprecated.You can check more details about this change in our release notes [here](https://status.mdintegrations.com/maintenance/591792) (under '**New Offerings structure')**.\n\nOur current API docs will reflect the new offerings structure only, but all the Endpoints and Webhooks from the previous structure are still active and functional.\n\nAs part of the previous structure, please note that we used to have 4 different classifications for offerings: **medications, compounds, supplies and services**. For your company, I see that you have both **medications** and **compounds** created for it (you can check what each offering corresponds to from [this](https://mdintegrations.com/partner/398d8f3a-529f-47ec-b87c-ee27a181f68f/offerings) page). \\\n\\\nTherefore, if the offering corresponds to a **medication**, in the previous structure we'll show its ID under the **partner_medication_id** field and if it corresponds to a **compound**, we'll show it under the **partner_compound_id** field.","2025-10-13T15:47:47.661Z","ac3080ba-7cdd-4992-9567-97f8414d2029",[],[],{"_101":614,"_103":615,"_105":-5,"_106":616,"_108":-5,"_13":-5,"_95":617,"_97":617,"_25":618,"_27":28,"_111":-5,"_112":619,"_114":620},"Request for automated message at the start of visits","request-for-automated-message-at-the-start-of-visits","Normally doctors will send a Welcome video introducing themselves to the patient once they start working on the patient's encounter, but it'll depend on how each doctor will handle their own cases.\n\nWe'll soon implement some custom workflows which partners will be able to manage on their end, so you can probably leverage from it for triggering these welcome messages over to patients.","2025-07-30T02:20:55.294Z","9a93d8a1-f1b3-44a0-8208-81155bee4faa",[],[],{"_101":622,"_103":623,"_105":-5,"_106":624,"_108":-5,"_13":-5,"_95":625,"_97":626,"_25":627,"_27":28,"_111":-5,"_112":628,"_114":629},"Request for Portal Review Meeting","request-for-portal-review-meeting","Please find below instructions on how to test from our Sandbox environment:\\\n\\\nAfter generating Sandbox API credentials, you'll be able to check the patient profiles and encounters that were created from the intake flows (or via API) from our Clinicians App Sandbox environment. In order to access it, make sure you do the following:\n\n1. Have a Support user account (you can create support user accounts from your company's dashboard under Operations > Management > Support Staff > Add new);\n\n2. Select the right permissions for users (click at the support user profile > edit > permissions and select the permission you want);\n\n3. Once you log into our Clinicians App, click at your user name's initials (top left hand side) > Environment > switch to Sandbox.\n\nAs for testing our end-to-end flows, you can access our Test Bench from your company's dashboard and simulate any MDI event you want to test by following the steps below:Go to the top menu and click at Integration > Resources > Test Bench;\n\n1. Scroll all the way down to the 'Test Bench' section;\n2. Click at 'Simulate Events';\n3. Select the event you want to run (e.g. Submit Prescription);\n4. Fill out the information required (like Sandbox Case ID) and hit *Run*.\n\nOur Test Bench also offers the option to manually trigger some Webhook events by clicking the 'Send Webhooks' option.\n\nNote that you can also manually create patient profiles and encounters from the \\\\Clinicians App Sandbox environment.","2026-01-22T20:23:43.795Z","2026-01-22T20:23:51.349Z","895213bd-177a-4613-82de-9d52b21442ab",[],[],{"_101":631,"_103":632,"_105":-5,"_106":633,"_108":-5,"_13":-5,"_95":634,"_97":634,"_25":635,"_27":28,"_111":-5,"_112":636,"_114":637},"Request for 'Talk to my doctor' link for direct patient-doctor communication","request-for-talk-to-my-doctor-link-for-direct-patient-doctor-communication","You can either use our API to generate a unique [Messaging App URL](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#8fe42f58-4c7d-47f4-8daf-b8aa33558d78) for the patient or use our [Patient App](https://patient.mdintegrations.com), where patients can log in and access their medical history, profile details, Messaging App, etc.","2025-08-06T17:21:36.798Z","5e966fd8-7e9c-493a-8b76-8fc225048b12",[],[],{"_101":639,"_103":640,"_105":-5,"_106":641,"_108":-5,"_13":-5,"_95":642,"_97":642,"_25":643,"_27":28,"_111":-5,"_112":644,"_114":645},"Request to delete all patients for UAT testing","request-to-delete-all-patients-for-uat-testing","You can delete patients, but not via API. You'd have to manually delete them all from the Clinicians App.\\\nTo delete a patient record (along with all encounters created for them), go to the Patient's list (sidebar to the left) > click the 3 dots menu from the patient record you want to delete > Delete Patient.","2025-09-03T19:04:12.634Z","5ff5f933-b822-475e-90d3-2130977b9b06",[],[],{"_101":647,"_103":648,"_105":-5,"_106":649,"_108":-5,"_13":-5,"_95":650,"_97":650,"_25":651,"_27":28,"_111":-5,"_112":652,"_114":653},"Request to merge duplicate profiles for Wallmoon customer Chell Sorricelli","request-to-merge-duplicate-profiles-for-wallmoon-customer-chell-sorricelli","We actually don't merge patient profiles on our end, as it may lead to data inconsistency issues. Considering that MDI is not the data owner, we keep patient profiles as they were sent to us originally. What we do in these scenarios is to show an alert in the UI for doctors and support users whenever possible duplicates are found (basically whenever the patient's email address or name + DoB are the same across profiles).","2025-07-31T19:15:41.952Z","3677e01e-8afd-43b3-a8d7-386ac6afdd1d",[],[],{"_101":655,"_103":656,"_105":-5,"_106":657,"_108":-5,"_13":-5,"_95":658,"_97":658,"_25":659,"_27":28,"_111":-5,"_112":660,"_114":661},"Request to Update CTA Color to Match Branding","request-to-update-cta-color-to-match-branding","Yes, you can customize the CTA button from the email notifications by navigating to the top menu (Account > Branding > Templates > Set Theme).","2026-01-08T17:32:21.817Z","a66c00bc-ff75-4d7c-a5da-eca50a47d171",[],[],{"_101":663,"_103":664,"_105":665,"_106":666,"_108":-5,"_13":-5,"_95":667,"_97":667,"_25":668,"_27":28,"_111":-5,"_112":669,"_114":670},"Resolving 'Field is Empty' Error for Dosepot Medication Name","resolving-field-is-empty-error-for-dosepot-medication-name","https://mdintegrations.unthread.io/dashboard/inbox/all/conversations/f83efd17-cc84-42e2-badd-f6a7aa349fb1","If you encounter an issue where you are unable to save a new medication offering in MDI due to an error stating that the \"Dosepot medication name\" field is empty, even though it appears to be filled, follow these steps to resolve the issue:\n\n1. **Understand the Difference Between Compounds and Medications:**\n\n - **Dosespot Compounds:** These allow you to insert custom formulas, components, and other specific details for your offering.\n - **Dosespot Medications:** These are selected from a predefined list of over-the-counter (OTC) products. The medication field in this case acts as a lookup field.\n\n2. **Steps to Resolve the Issue:**\n\n - Clear the \"Dosepot medication name\" field.\n - Begin typing the first few letters of the medication name.\n - A list of available medications should appear. Select the appropriate medication from the list.\n\n3. **Alternative Solution:**\n\n - If no suitable medication appears in the list, consider creating a compound instead of a medication.\n\nBy following these steps, you should be able to successfully save and upload your new medication offering.","2025-08-04T18:26:54.338Z","08da2538-df94-490f-a066-6ba882c84bfe",[],[],{"_101":672,"_103":673,"_105":-5,"_106":674,"_108":-5,"_13":-5,"_95":675,"_97":676,"_25":677,"_27":28,"_111":-5,"_112":678,"_114":679},"Review medication request and webhook event issue","review-medication-request-and-webhook-event-issue","As for the Webhooks, offering_submitted and prescription_submitted represent the same event and both Webhooks will coexist until we retire the second one. You can check more details about this change in our release notes [here](https://status.mdintegrations.com/maintenance/591792) (under '*New Offerings structure')*.","2025-07-28T16:14:36.437Z","2025-07-28T16:17:17.849Z","0ba3de0b-1ef2-4dbe-90ae-89c802f1499e",[],[],{"_101":681,"_103":682,"_105":-5,"_106":683,"_108":-5,"_13":-5,"_95":684,"_97":684,"_25":685,"_27":28,"_111":-5,"_112":686,"_114":687},"Services Directions","services-directions","Directions should go in the Description field from Services for the pharmacy to see.","2026-03-19T23:18:40.135Z","26703131-5476-4e79-9353-fc5a97a13171",[],[],{"_101":689,"_103":690,"_105":-5,"_106":691,"_108":-5,"_13":-5,"_95":692,"_97":692,"_25":693,"_27":28,"_111":-5,"_112":694,"_114":695},"Setting up STRIPE keys/credentials","setting-up-stripe-keyscredentials"," You can setup your STRIPE credentials by navigating to Integration → Credentials → Add new and selecting the \"Stripe\" option right below Credentials.\n\nOnce you're done, let us know and we'll enable checkout for each one of your questionnaires (and you'll be able to choose between placing it at the start or at the end of the questionnaire).\n\nHowever, please note that we'll won't be managing payment for you on our end, that's why you'll have to use your own STRIPE keys and we'll basically just expose the STRIPE checkout form to users.","2026-03-13T16:27:51.808Z","9f37532d-d556-4bf8-aec0-22f261ae7ad2",[],[],{"_101":697,"_103":698,"_105":-5,"_106":699,"_108":-5,"_13":-5,"_95":700,"_97":700,"_25":701,"_27":28,"_111":-5,"_112":702,"_114":703},"Storing the patient's intake progress.","storing-the-patients-intake-progress","\nThere is no Endpoint for storing the patient's intake progress. \n\nIf you plan on embedding our white labeled URLs on your own page though, you'll be able to track user interactions by subscribing to window.postMessage events. These events allow you to capture key actions during the user journey. Below are some important events you can track:\n\nForm Completion: Triggered when a user finishes the intake form.\n\nAccount Creation: Captures when a user creates an account, including their email and phone.\n\nStep Progression: Tracks when a user progresses through a step in the form.\n\nEncounter Creation: Captures when an encounter is created, including the encounter_id and patient_id.","2026-01-15T16:38:29.143Z","87cd6d70-65bb-439b-8d6e-cfa8aa28bf76",[],[],{"_101":705,"_103":706,"_105":-5,"_106":707,"_108":-5,"_13":-5,"_95":708,"_97":708,"_25":709,"_27":28,"_111":-5,"_112":710,"_114":711},"Testing in the Clinicians App Sandbox environment","testing-in-the-clinicians-app-sandbox-environment","To test in the Clinicians App **Sandbox environment**, you typically do two things: (1) access Sandbox in the Clinicians App to view/create test patients and encounters, and (2) use the Test Bench to simulate end-to-end events.\\\n\\\n1) Access the Clinicians App in Sandbox\\\nMake sure you have a **Support user account** (create it from your company’s dashboard under [**Operations > Management > Support Staff**](https://partners.mdintegrations.com/partner/29b0f6bd-5a8f-4b5d-a7fa-2aac7d657297/operations#support_staff)).\\\nAssign the right **permissions** to that Support user (open the support user profile **> edit > permissions**).\n\n1. Log into the **Clinicians App** at [app.mdintegrations.com](http://app.mdintegrations.com), click your **initials (top-left)**, then **Environment > switch to Sandbox**.\n\nAfter you generate **Sandbox API credentials**, you can also use the API to check the patient profiles and encounters you created in the Sandbox Clinicians App.\\\n\\\n2) Simulate events with Test Bench (end-to-end flow testing)\\\nFrom your company’s dashboard:\n\n- Go to **Integration > Resources > Test Bench**\n- Scroll down to the **Test Bench** section\n- Click **Simulate Events**\n- Pick the event (for example, **Submit Prescription**). *All patient and encounter events can also be manually simulated from the UI, except for submitting a prescription and consequently completing an encounter.*\n- Fill in the required info (often includes a **Sandbox Case ID**) and run it\n\nYou can also manually trigger some webhook events from Test Bench via **Send Webhooks**.\\\n\\\nImportant note about prescriptions in Sandbox\\\nSandbox is for testing the **technical integration** (triggering events), but **sending prescriptions to a real pharmacy isn’t supported in Sandbox**.","2026-04-07T20:52:35.274Z","fe1a38ec-0e57-44ae-b685-bb0f1de5fc98",[],[],{"_101":713,"_103":714,"_105":715,"_106":716,"_108":-5,"_13":-5,"_95":717,"_97":717,"_25":718,"_27":28,"_111":-5,"_112":719,"_114":720},"Testing Prescription Transmission in Sandbox and Live Environments","testing-prescription-transmission-in-sandbox-and-live-environments","https://mdintegrations.unthread.io/dashboard/inbox/all/conversations/19301625-f7b4-4a1f-a15d-182e36d767a1","**Overview:**\n\nIn the Sandbox environment, you can test your technical integration with MDI by triggering various events. However, submitting prescriptions to an actual pharmacy is not possible in the Sandbox environment due to the lack of integration with real pharmacies. Pharmacies do not typically have dedicated test environments and treat all prescriptions as real unless prior arrangements are made.\n\n**Key Points:**\n\n1. **Sandbox Environment:**\n\n - Events listed in the Sandbox are for testing technical integration only.\n - You can trigger these events as much as needed.\n - Prescription transmission to real pharmacies is not supported in the Sandbox.\n\n2. **Live Environment Testing:**\n\n - After going live, you can test prescription transmission to real pharmacies.\n - A licensed doctor must review the encounter and issue the prescription.\n - Pharmacies will treat prescriptions as real unless explicitly informed otherwise.\n\n**Best Practices for Testing in the Live Environment:**\n\n1. **Tagging the Case:**\n\n - Add the tag 'Test Case' to the case, either manually or via the API (tag_id: c456872d-af8d-45e9-a1fe-8db619a369f7).\n\n2. **Communicating with Doctors:**\n\n - Add a message as a new 'Chart Notes' or Case Question via the Post Case Question Endpoint, specifying the test instructions for the doctor. For example: *\"This is a test encounter. Please submit the prescription to the pharmacy.\"*\n - If using white-labeled intakes, include this information as an answer to a question when filling out the intake.\n\n3. **Patient Name:**\n\n - Add the word \"Test\" to the patient's name if the patient is not real.\n\nBy following these steps, you can ensure proper testing of prescription transmission in the Live environment while maintaining clear communication with doctors and pharmacies.","2025-10-08T16:49:05.645Z","7f328b0e-4d60-4417-ad74-ea3822943d74",[],[],{"_101":722,"_103":723,"_105":-5,"_106":724,"_108":-5,"_13":-5,"_95":725,"_97":725,"_25":726,"_27":28,"_111":-5,"_112":727,"_114":728},"Troubleshooting MDI emails not being received by patients","troubleshooting-mdi-emails-not-being-received-by-patients","our email notification system is event-driven: every time a new message is generated for a patient within the platform, a corresponding email notification is automatically sent. This process occurs independently for each message event to ensure real-time communication.\\\nAt this time, we do not expose dedicated webhooks specifically for email notification events (e.g., “email sent,” “email delivered,” or “email bounced”). Therefore, email delivery status cannot be programmatically tracked via webhook callbacks.\\\nIf a patient reports not having received an email notification, the most common technical causes are:\n\n- **Spam/Junk filtering:** The email was successfully delivered by our outbound mail server but was routed to the patient’s spam or junk folder by their email provider’s filtering system or by users themselves if they marked MDI emails as spam for instance.\n- **Recipient server rejection or blocking:** The patient’s mail server may have rejected the message at the SMTP level (e.g., due to blacklisting, strict security policies, or a full mailbox).\n- **Suppression at the email provider level (AWS):** Our infrastructure leverages Amazon Web Services, specifically its email service, which maintains suppression lists for addresses that previously resulted in hard bounces or repeated delivery failures. In such cases (commonly due to a full mailbox or prior server rejection) the email may be automatically suppressed to protect sender reputation and ensure high deliverability rates.\n\n\\\n\\\nFor troubleshooting, we recommend confirming the patient’s email address on file, asking them to check their spam folder, and verifying whether their mail server has any restrictions that could prevent successful delivery.","2026-03-05T22:09:23.345Z","8bc0fca3-133c-4a49-9073-a43c2456a9dd",[],[],{"_101":730,"_103":731,"_105":-5,"_106":732,"_108":-5,"_13":-5,"_95":733,"_97":734,"_25":735,"_27":28,"_111":-5,"_112":736,"_114":737},"Validating a patient's identity","validating-a-patients-identity","**MDI supports four options for validating a patient’s identity:**\n\n---\n\n## **1. Upload a valid patient ID**\n\n### **Requirements**\n\n**For partners using the API integration:**\n\n- Upload any government valid ID (driver’s license, passport, etc.) when creating a profile for the patient.\n- Ensure you pass it within the `driver_license_id` field.\n\n**For partners using our white labeled intakes:**\n\n- We’ll ask patients to upload an ID as part of the intake flow, and they will only be able to complete the questionnaire after uploading their ID.\n\n### **Additional notes**\n\n- If no ID is provided for the patient (and there is no other option available in the case, like intro video or Vouched score results), the physician will trigger an automated workflow asking the patient to upload their ID.\n- To enable this, ensure the option is enabled in your company’s dashboard under:\\\n **Integration > Settings > Notifications > Email patients for missing drivers license**\n\n---\n\n## **2. Upload an intro Video**\n\n### **Requirements**\n\n**For partners using the API integration:**\n\n- Upload a short 5-second video of the patient introducing themselves to the physician when creating a profile for the patient.\n- Ensure you pass it within the `intro_video_id` field.\n\n**For partners using our white labeled intakes:**\n\n- The option of uploading an intro video is currently not supported for this integration type.\n\n### **Additional notes**\n\n- This intro video can be the same as the AV flow video (required for the AV states), so if it has already been provided for the patient, no additional identification will be required.\n\n---\n\n## **3. Run Vouched (using MDI’s integration)**\n\n### **Requirements**\n\n**For partners using the API integration:**\n\n- If partners select the option to “Run Vouched for every patient”, we’ll automatically run Vouched as soon as an encounter is created for the patient.\n\n**For partners using our white labeled intakes:**\n\n- If partners select the option to “Run Vouched for every patient”, we’ll skip the ID upload slide and automatically run Vouched as soon as an encounter is created for the patient.\n\n### **Additional notes**\n\n- Vouched settings can be managed under:\\\n **Integration > Settings > Workflows**\n- Note that we’ll charge 1 USD every time Vouched is run.\n- We’ll only consider that a patient has passed Vouched if their score is **0.8 or higher**.\n\n**There are 4 Vouched options:**\n\n- Run it automatically for every patient\n- Run it only when an ID is missing for the patient\n- Run it only when manually triggered by the physician\n- Disabled\n\n---\n\n## **4. Run Identity validation on the partner’s side**\n\n### **Requirements**\n\n**For any integration type:**\n\n- Partners can run their own identity verification and then pass the resulting score or confirmation that they have validated the patient’s identity via the **Post Case Question endpoint**.\n- This question should preferably be sent as the first intake question.\n\n### **Example**\n\n- **Question 1:** Vouched Identity validation\n- **Answer:** Patient passed Vouched with Score: 1.0\n\n**or**\n\n- **Answer:** Patient’s identity already verified by partner","2026-04-02T00:14:23.959Z","2026-05-21T21:52:28.513Z","73e3fab4-5d6b-4cf4-a661-01c54fb22940",[],[],{"_101":739,"_103":740,"_105":-5,"_106":741,"_108":-5,"_13":-5,"_95":742,"_97":742,"_25":743,"_27":28,"_111":-5,"_112":744,"_114":745},"Webhooks, Auth & credentials, Idempotency & safe retries, API limits and behavior, Case lifecycle & Offerings","webhooks-auth-credentials-idempotency-safe-retries-api-limits-and-behavior-case-lifecycle-offerings","\n## **Webhooks** \n\n### **1. Are webhook events delivered in order? Or can we receive a “case completed” event before the “case processing” event that should logically precede it?**\n\nYes, they’ll be dispatched at the exact time the event occurred. However, if the webhook failed or was delayed for some reason (e.g. because your application returned us an error), we may send it later by our retrial process.\n\nSo in your example, it is possible to see something like **case_completed** arrive before an earlier **case_processing** event if the earlier event was delayed or retried.\n\nTo ensure successful webhook processing, we recommend the following best practices:\n\n- Respond with HTTP 200 as soon as the webhook is received and validated\n\n- Avoid long synchronous processing inside the webhook endpoint\n\n- Process webhook payloads asynchronously when possible\n\n---\n\n## **Data export & migration**\n\n### **3. POST /partner/patients/data — what does this export actually contain (full medical history, demographics, files)? What format (JSON, CSV, PDF)? Is it synchronous or async?**\n\nThe [Patient Post Endpoint](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#d4b1c06f-6db0-43c7-9fc2-079aa3a5b8a9) should be used for creating a patient record on MDI and [here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#d4b1c06f-6db0-43c7-9fc2-079aa3a5b8a9) all the parameters that should be passed over to us within your request payload (most of them will be mandatory). The [Patient Get Endpoint](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#bb368a4c-eb53-4659-88ab-b76b475920e4) will return the same details. If you choose our white labeled integration, we’ll already collect all patients’ details throughout their intake journey. Our API responses will always come in a JSON format.\n\n### **4. Please confirm the webhook authentication scheme. We expect HMAC-SHA256 over the JSON body using a shared secret. Are there additional protection headers (timestamp, replay protection)? And what’s the process to rotate the shared secret if it’s ever compromised?**\n\nOur API will call your webhook URL when certain events happen. On that call, we can include an authorization field you provide in your company’s admin dashboard so you know the request comes from us. The request will have a header called Signature with a HMAC hash generated with the Secret provided using the SHA256 algorithm, so you can compare it with a hash generated on your end to make sure the payload you receive matches with the one we sent. \n\nHere is an example of how the signature is built using your secret key:\n\n$payloadJson = json_encode($payload); \n\n$signature = hash_hmac('sha256', $payloadJson, $secret);\n\nYou can check this signature from your side to make sure the payload has not changed.\n\nAs for the secret key, you can use any key you want, it can be a hash string or just a secret word for example. The \"Authorization\" field will be sent through the request headers, like this:\n\n'Authorization': $yourAuthorizationField,\n\n'signature': $signature\n\n- Here is an example:\n\n$signature = hash_hmac('sha256', json_encode(payload), secret)\n\n- Webhooks also include an **Authorization** header, described as the authorization value previously registered on your platform.\n\n- It shows a **Signature** header carrying the HMAC.\n\n- The payload includes a **timestamp field in the JSON body**.\n\n### **5. If our webhook endpoint is temporarily down or returns an error, does MDI retry the delivery? On what schedule? Is there a way for us to manually request a replay later?**\n\nWhen a webhook delivery fails, we will try sending it again a few extra times using the schedule below:\n\n1st retry: 15 minutes\n\n2nd retry: 30 minutes\n\n3rd retry: 1 hour\n\n4th retry: 4 hours\n\n5th retry: 8 hours\n\n6th retry: 11 hours\n\nWith this retry policy, webhook delivery attempts will occur over a 24-hour period. If all retry attempts fail, the webhook will be marked as permanently failed.\n\nYou can let our team know whenever you need a webhook to get resubmitted to your application.\n\n### **6. Can we register separate webhook URLs per environment (sandbox vs. production), or is it a single URL receiving everything?**\n\nYes, you can set-up multiple webhook URLs for each environment.\n\n---\n\n## **Auth & credentials**\n\n### **7. The OAuth access token expires after 24 hours. Is the expected pattern just “retry on 401 and re-authenticate,” or is there a refresh-token flow we should be using? Any pre-expiry signal we can listen for?\\**\n\\\nYes, the expected pattern is to request a brand new access token when the current one expires, rather than use a separate refresh-token flow. When a token expires, you should **call the token endpoint again with the same client_id and client_secret** to get a new one. A 401 error message means the token may be **invalid, expired, or revoked**\n\n### So in practice, the safest implementation is:\n\n### - Store the token and its expires_in\n\n### - Refresh proactively before 24h is up, or \n\n### - On 401, fetch a new token and retry once\n\n### **8. For sandbox vs. production: do we use the same client_id/client_secret pair with an is_sandbox flag, or are there fully separate credentials issued per environment?**\n\nWhen generating API credentials, you’ll be able to select its corresponding environment and each credential will be unique.\n\n---\n\n## **Idempotency & safe retries**\n\n### **9. Does MDI support an idempotency-key header on POST endpoints (creating cases, patients, offerings)? Or is the recommended pattern to use the metadata field for our own deduplication keys?**\n\nMDI does not currently have an **Idempotency-Key** header for POST endpoints.\n\nThe **metadata** field on our Endpoints should be used as a place to store identifying info from your system, such as an external ID. Therefore, if you need a deduplication logic, you can use your own external key in **metadata** for carrying your identifier. Please note that storing a dedup key in **metadata** helps **you** identify duplicates, but it does not by itself prove the API will enforce idempotent POSTs on the MDI side.\n\n### **10. Which write operations are server-side idempotent today? For example, would two identical POST /partner/cases requests produce one case or two?**\n\nYes, two identical POST requests may create 2 cases/encounters, as we don’t have any **Idempotency** properties on our APIs.\n\n---\n\n## **API limits and behavior**\n\n### **11. We see a rate-limit header x-ratelimit-limit: 6000 in the docs. Is this per minute or per hour? What’s the response on 429 (Retry-After header? Recommended backoff?)? Is there a burst allowance?\\**\n\\\nWe **do not enforce** any API rate limits. However, if security monitoring detects **high volumes of errors** from your API calls, our tech team may reach out, and your IP could potentially be blocked if activity looks abusive. So in practice, it’s still best to:\n\n- \n\n### avoid tight retry loops on repeated 4xx/401 failures\n\n- \n\n### refresh tokens at least every 24 hours\n\n- \n\n### make retries bounded and idempotent\n\n### **12. What is the authoritative case-status enum? We’ve seen a mismatch between the documentation (Created / Assigned / Waiting / Processing / Completed) and live API examples (which sometimes include Pending and Approved). We need the full list with transition rules.**\n\n\\\nBelow is a list of all possible case statuses:\n\n- **Created** — Cases go here if they’re placed on hold during creation or due to partner settings. Once a case leaves **Created**, it can’t be moved back there. This is usually used when the partner still needs to do something before a doctor can work it, like confirming payment.\n\n- **Assigned** — The case is assigned to a doctor and stays here until the doctor takes action.\n\n- **Waiting Patient** — The case is waiting on the patient to do something, such as uploading an ID or replying. When the patient responds, it automatically moves back to **Assigned**.\n\n- **Sent to Support** — The case needs Support intervention, for example if something needs to be added or corrected. Once resolved, Support should manually move it back to **Assigned**.\n\n- **Approved** — The case needs review by the partner’s Support team before being sent to the pharmacy. This is mainly used when a doctor updates a prescription, either manually or due to partner settings.\n\n- **Processing** — The case is in transit to the pharmacy.\n\n- **Completed** — Final status once the pharmacy has acknowledged receipt of the prescription.\n\n- **Cancelled** — The case was canceled, such as when it was created by mistake, duplicated, or the patient no longer wants the requested treatment. In some cases (like when running tests), it can be marked **non-chargeable** so the partner isn’t billed.\n\nPlease refer to [this](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#a96a8d06-15f7-4390-96f7-59f0fddd3c7e) Webhook list for case Status Transitions for all the possible statuses we currently have available for case/encounters.\n\n### **13. What is MDI’s API versioning policy? How are breaking changes communicated, what’s the deprecation window, and is there version pinning?**\n\nWe use a **Status Page** to publish incidents, scheduled maintenance, and related updates. Partners are advised to subscribe for notifications at [MDI status page](https://status.mdintegrations.com/). **Breaking/deprecated changes will be communicated in advance** through release or maintenance notices on our **Status Page**. Depending on the breaking change, both API versions may still coexist before the previous one gets deprecated.\n\n---\n\n## **Sandbox**\n\n### **14. Does the sandbox environment behave identically to production for webhooks, error responses, rate limits, and latency? Are there any production-only behaviors we should plan to test for separately?**\n\nYes, both environments should work the same way. The only part of the flow that you won’t be able to test from our Sandbox environment is the real prescription transmission over to pharmacies, as we’re not connected to pharmacies from our Sandbox environment. You’ll be able to run tests in our Live environment for that purpose, though. \n\n### **15. The /partner/tests/... endpoints — what specific scenarios can we simulate (clinician approval/denial, prescription submission, order fulfillment)? Any limit on test volume per window?**\n\nYou’ll be able to simulate any event from our Sandbox environment, including submitting a prescription to the pharmacy (in this case, the prescription will not get transmitted to a real pharmacy). For the order and fulfillment part of the process, it’ll depend on which pharmacy you’ll be utilizing. If you’ll be partnering with a pharmacy that we have a direct integration with, we’ll manage order and fulfillment on our side, and you’ll be able to test the entire flow. However, if you utilize a pharmacy we don’t have a direct integration with, we’ll only manage the e-prescribing flow on our side and everything related to order and fulfillment will have to be handled on your side. There are no volume limits for running tests.\n\n---\n\n## **Case lifecycle & ofFerings**\n\n### **16. The case_questions\\[\\] field — this is what we plan to use to pass existing intake responses into a case. Are there limits on number of questions, length per answer, special characters, or attachments?**\n\nThere are no limitations, but you’ll only need to use this Endpoint in case you choose the full API integration. Attachments should be attached to Patient records or to Cases only.\n\n### **17. For refills, MD’s pattern is to create a follow-up case using reference_case_id pointing to the original. What’s the recommended pattern? Does the same clinician get reassigned to the follow-up, or is the case routed to whoever is available?**\n\nYou don’t need to use the reference_case_id field for connecting encounters to an existing patient profile or when creating follow-up encounters for the patient (we’ll already do it on our side if you pass us an existing same patient_id). And yes, we’ll always try to assign follow-up encounters to the same doctor who previously prescribed for the patient (as long as the doctor is available at the time of case assignment).","2026-05-08T19:13:46.143Z","eedd240f-3254-413f-870c-28fed16777f1",[],[],{"_101":747,"_103":748,"_105":-5,"_106":749,"_108":-5,"_13":-5,"_95":750,"_97":750,"_25":751,"_27":28,"_111":-5,"_112":752,"_114":753},"What states does MDI serve?","what-states-does-mdi-serve","\nWe have licensed physician coverage across all 50 states, Puerto Rico, Guam, DC, and Canada.\n\nFor GLP-1 / weight loss treatment, MD Integrations has board certified physicians that span across 50 states.\n\nHowever, due to specific state regulations and MDI's operational and business decisions, MDI provides clarifications on the following two states:\n\nLouisiana: Under the Louisiana Administrative Code, the State Board of Medical Examiners prohibits physicians from using telemedicine to treat certain conditions, including obesity. MDI does not service Louisiana for obesity and weight loss. Please reference Louisiana Administrative Code section §6901-6913 of the board’s rules for this specific pronouncement.\n\nMississippi: MDI has made an operational and business decision to only operate with branded weight loss medication in the state, and do not currently support any compounded weight loss treatments in Mississippi.","2026-01-27T17:04:42.272Z","3612b402-a080-499c-83d7-6a2f734a4e11",[],[],{"_101":755,"_103":756,"_105":-5,"_106":757,"_108":-5,"_13":-5,"_95":758,"_97":759,"_25":760,"_27":28,"_111":-5,"_112":761,"_114":762},"White label intake forms and messaging app","white-label-intake-forms-and-messaging-app","Since you are proceeding with the white-labeled integration, the responsibility for managing the **product–intake-MDI offering associations** will be on your side. The process involves the following steps:\n\n**1.Create an Intake Form under your company’s dashboard *(managed by our medical team)***\n\n- This will serve as the entry point for users to provide the necessary information for a provider to prescribe for them.\n- You already have this step completed here.\n\n**2. Associate each product/service in your store with the correct intake form**\n\n- For every product/service you offer in your website, link it to the corresponding MDI intake form and offering.\n- This ensures that when users purchase or initiate a flow involving a product/service, they are directed to the appropriate intake form for that specific product/service and that the encounter created from the intake flow will include the proper MDI offering_id.\n\n**3. Generate a unique voucher URL for each user**\n\n- Use the **Voucher Generation API** to create a new voucher for every individual user.\n- This voucher provides the unique link/URL that allows the user to securely access and complete the intake form.\n- You should include both the `questionnaire_id` and the `offering_id` when creating a voucher URL.\n- If you plan to collect patients' details and create a profile for them on MDI before generating the intake voucher (which is completely optional), you'll just have to pass us the corresponding patient_id in the request payload as well. This will make us skip the patient demographic related questions in the intake.\n\n**4. Incorporate the voucher URLs into your company’s website**\n\n- Place the generated voucher links within your site, typically connected to a button or call-to-action.\n- For example, when the user selects a product/service and clicks “Fill Out Intake,” they are redirected via the voucher URL to the correct intake form.\n\n**5. Monitor the ‘Voucher Used’ Webhook to capture IDs**\n\n- Once a user completes their intake using a generated voucher, the **‘Voucher Used’ Webhook** will fire.\n- This webhook provides you with the **Case and Patient ID** tied to that voucher, which you can then use to track, process, or manage events within your system.\n- We have several other Webhooks available for basically every event that happens on MDI and they're all listed [here](https://documenter.getpostman.com/view/14212272/2s8Yt1r9B8#70b3d169-a2a1-4a0f-a7ee-312b1d791396). You can check them all and listen to the ones that will be relevant for your use case.\n\n**White label Messaging App:**\n\nWhenever patients receive a new message from their doctor, they'll receive a \"New Message\" notification email with a link to click and access our Messaging App, so they can chat with the doctor.\n\nYou can also generate a unique URL for patients to access our Messaging App. With that link, patients wouldn't need to go through any sort of 2FA as long as the link is valid (up to 24hrs).","2025-09-18T00:51:21.909Z","2026-02-25T15:53:55.959Z","49e7d169-6442-465e-8ddc-ae5bf187f456",[],[],"collections",[765,778],{"_72":434,"_103":766,"_93":-5,"_767":-5,"_768":-5,"_13":-5,"_95":769,"_97":769,"_25":429,"_27":28,"_770":771,"_98":772,"_776":777},"faqs","icon","parentId","2025-07-02T15:16:24.063Z","articleCount",1,[773],{"_101":425,"_103":426,"_105":427,"_106":428,"_108":429,"_13":-5,"_95":430,"_97":431,"_25":432,"_27":28,"_112":774,"_114":775},[],[],"subCollections",[],{"_72":480,"_103":779,"_93":-5,"_767":-5,"_768":-5,"_13":-5,"_95":780,"_97":780,"_25":475,"_27":28,"_770":771,"_98":781,"_776":785},"testdata","2025-07-09T15:20:00.741Z",[782],{"_101":472,"_103":473,"_105":-5,"_106":474,"_108":475,"_13":-5,"_95":476,"_97":477,"_25":478,"_27":28,"_112":783,"_114":784},[],[],[],"uncategorizedArticles",[788,791,794,797,800,803,806,809,812,815,818,821,824,827,830,833,836,839,842,845,848,851,854,857,860,863,866,869,872,875,878,881,884,887,890,893,896,899,902,905,908,911,914,917,920,923,926,929,932,935,938],{"_101":102,"_103":104,"_105":-5,"_106":107,"_108":-5,"_13":-5,"_95":109,"_97":109,"_25":110,"_27":28,"_111":-5,"_112":789,"_114":790},[],[],{"_101":117,"_103":118,"_105":-5,"_106":119,"_108":-5,"_13":-5,"_95":120,"_97":120,"_25":121,"_27":28,"_111":-5,"_112":792,"_114":793},[],[],{"_101":125,"_103":126,"_105":-5,"_106":127,"_108":-5,"_13":-5,"_95":128,"_97":128,"_25":129,"_27":28,"_111":-5,"_112":795,"_114":796},[],[],{"_101":133,"_103":134,"_105":-5,"_106":135,"_108":-5,"_13":-5,"_95":136,"_97":136,"_25":137,"_27":28,"_111":-5,"_112":798,"_114":799},[],[],{"_101":141,"_103":142,"_105":-5,"_106":143,"_108":-5,"_13":-5,"_95":144,"_97":144,"_25":145,"_27":28,"_111":-5,"_112":801,"_114":802},[],[],{"_101":149,"_103":150,"_105":-5,"_106":151,"_108":-5,"_13":-5,"_95":152,"_97":153,"_25":154,"_27":28,"_111":-5,"_112":804,"_114":805},[],[],{"_101":158,"_103":159,"_105":-5,"_106":160,"_108":-5,"_13":-5,"_95":161,"_97":162,"_25":163,"_27":28,"_111":-5,"_112":807,"_114":808},[],[],{"_101":167,"_103":168,"_105":-5,"_106":169,"_108":-5,"_13":-5,"_95":170,"_97":170,"_25":171,"_27":28,"_111":-5,"_112":810,"_114":811},[],[],{"_101":175,"_103":176,"_105":-5,"_106":177,"_108":-5,"_13":-5,"_95":178,"_97":178,"_25":179,"_27":28,"_111":-5,"_112":813,"_114":814},[],[],{"_101":183,"_103":184,"_105":-5,"_106":185,"_108":-5,"_13":-5,"_95":186,"_97":186,"_25":187,"_27":28,"_111":-5,"_112":816,"_114":817},[],[],{"_101":191,"_103":192,"_105":-5,"_106":193,"_108":-5,"_13":-5,"_95":194,"_97":194,"_25":195,"_27":28,"_111":-5,"_112":819,"_114":820},[],[],{"_101":199,"_103":200,"_105":-5,"_106":201,"_108":-5,"_13":-5,"_95":202,"_97":202,"_25":203,"_27":28,"_111":-5,"_112":822,"_114":823},[],[],{"_101":199,"_103":207,"_105":-5,"_106":208,"_108":-5,"_13":-5,"_95":209,"_97":209,"_25":210,"_27":28,"_111":-5,"_112":825,"_114":826},[],[],{"_101":214,"_103":215,"_105":-5,"_106":216,"_108":-5,"_13":-5,"_95":217,"_97":217,"_25":218,"_27":28,"_111":-5,"_112":828,"_114":829},[],[],{"_101":222,"_103":223,"_105":-5,"_106":224,"_108":-5,"_13":-5,"_95":225,"_97":225,"_25":226,"_27":28,"_111":-5,"_112":831,"_114":832},[],[],{"_101":230,"_103":231,"_105":-5,"_106":232,"_108":-5,"_13":-5,"_95":233,"_97":233,"_25":234,"_27":28,"_111":-5,"_112":834,"_114":835},[],[],{"_101":238,"_103":239,"_105":-5,"_106":240,"_108":-5,"_13":-5,"_95":241,"_97":241,"_25":242,"_27":28,"_111":-5,"_112":837,"_114":838},[],[],{"_101":246,"_103":247,"_105":-5,"_106":248,"_108":-5,"_13":-5,"_95":249,"_97":250,"_25":251,"_27":28,"_111":-5,"_112":840,"_114":841},[],[],{"_101":255,"_103":256,"_105":-5,"_106":257,"_108":-5,"_13":-5,"_95":258,"_97":258,"_25":259,"_27":28,"_111":-5,"_112":843,"_114":844},[],[],{"_101":263,"_103":264,"_105":-5,"_106":265,"_108":-5,"_13":-5,"_95":266,"_97":266,"_25":267,"_27":28,"_111":-5,"_112":846,"_114":847},[],[],{"_101":271,"_103":272,"_105":-5,"_106":273,"_108":-5,"_13":-5,"_95":274,"_97":274,"_25":275,"_27":28,"_111":-5,"_112":849,"_114":850},[],[],{"_101":279,"_103":280,"_105":-5,"_106":281,"_108":-5,"_13":-5,"_95":282,"_97":283,"_25":284,"_27":28,"_111":-5,"_112":852,"_114":853},[],[],{"_101":288,"_103":289,"_105":-5,"_106":290,"_108":-5,"_13":-5,"_95":291,"_97":291,"_25":292,"_27":28,"_111":-5,"_112":855,"_114":856},[],[],{"_101":296,"_103":297,"_105":-5,"_106":298,"_108":-5,"_13":-5,"_95":299,"_97":299,"_25":300,"_27":28,"_111":-5,"_112":858,"_114":859},[],[],{"_101":304,"_103":305,"_105":-5,"_106":306,"_108":-5,"_13":-5,"_95":307,"_97":307,"_25":308,"_27":28,"_111":-5,"_112":861,"_114":862},[],[],{"_101":312,"_103":313,"_105":-5,"_106":314,"_108":-5,"_13":-5,"_95":315,"_97":315,"_25":316,"_27":28,"_111":-5,"_112":864,"_114":865},[],[],{"_101":320,"_103":321,"_105":-5,"_106":322,"_108":-5,"_13":-5,"_95":323,"_97":323,"_25":324,"_27":28,"_111":-5,"_112":867,"_114":868},[],[],{"_101":328,"_103":329,"_105":-5,"_106":330,"_108":-5,"_13":-5,"_95":331,"_97":332,"_25":333,"_27":28,"_111":-5,"_112":870,"_114":871},[],[],{"_101":337,"_103":338,"_105":-5,"_106":339,"_108":-5,"_13":-5,"_95":340,"_97":340,"_25":341,"_27":28,"_111":-5,"_112":873,"_114":874},[],[],{"_101":345,"_103":346,"_105":-5,"_106":347,"_108":-5,"_13":-5,"_95":348,"_97":348,"_25":349,"_27":28,"_111":-5,"_112":876,"_114":877},[],[],{"_101":353,"_103":354,"_105":-5,"_106":355,"_108":-5,"_13":-5,"_95":356,"_97":356,"_25":357,"_27":28,"_111":-5,"_112":879,"_114":880},[],[],{"_101":361,"_103":362,"_105":-5,"_106":363,"_108":-5,"_13":-5,"_95":364,"_97":364,"_25":365,"_27":28,"_111":-5,"_112":882,"_114":883},[],[],{"_101":369,"_103":370,"_105":-5,"_106":371,"_108":-5,"_13":-5,"_95":372,"_97":372,"_25":373,"_27":28,"_111":-5,"_112":885,"_114":886},[],[],{"_101":369,"_103":377,"_105":-5,"_106":378,"_108":-5,"_13":-5,"_95":379,"_97":379,"_25":380,"_27":28,"_111":-5,"_112":888,"_114":889},[],[],{"_101":384,"_103":385,"_105":-5,"_106":386,"_108":-5,"_13":-5,"_95":387,"_97":387,"_25":388,"_27":28,"_111":-5,"_112":891,"_114":892},[],[],{"_101":392,"_103":393,"_105":-5,"_106":394,"_108":-5,"_13":-5,"_95":395,"_97":395,"_25":396,"_27":28,"_111":-5,"_112":894,"_114":895},[],[],{"_101":400,"_103":401,"_105":-5,"_106":402,"_108":-5,"_13":-5,"_95":403,"_97":404,"_25":405,"_27":28,"_111":-5,"_112":897,"_114":898},[],[],{"_101":409,"_103":410,"_105":-5,"_106":411,"_108":-5,"_13":-5,"_95":412,"_97":412,"_25":413,"_27":28,"_111":-5,"_112":900,"_114":901},[],[],{"_101":417,"_103":418,"_105":-5,"_106":419,"_108":-5,"_13":-5,"_95":420,"_97":420,"_25":421,"_27":28,"_111":-5,"_112":903,"_114":904},[],[],{"_101":438,"_103":439,"_105":-5,"_106":440,"_108":-5,"_13":-5,"_95":441,"_97":441,"_25":442,"_27":28,"_111":-5,"_112":906,"_114":907},[],[],{"_101":446,"_103":447,"_105":-5,"_106":448,"_108":-5,"_13":-5,"_95":449,"_97":450,"_25":451,"_27":28,"_111":-5,"_112":909,"_114":910},[],[],{"_101":455,"_103":456,"_105":-5,"_106":457,"_108":-5,"_13":-5,"_95":458,"_97":459,"_25":460,"_27":28,"_111":-5,"_112":912,"_114":913},[],[],{"_101":464,"_103":465,"_105":-5,"_106":466,"_108":-5,"_13":-5,"_95":467,"_97":467,"_25":468,"_27":28,"_111":-5,"_112":915,"_114":916},[],[],{"_101":484,"_103":485,"_105":-5,"_106":486,"_108":-5,"_13":-5,"_95":487,"_97":488,"_25":489,"_27":28,"_111":-5,"_112":918,"_114":919},[],[],{"_101":493,"_103":494,"_105":-5,"_106":495,"_108":-5,"_13":-5,"_95":496,"_97":496,"_25":497,"_27":28,"_111":-5,"_112":921,"_114":922},[],[],{"_101":501,"_103":502,"_105":-5,"_106":503,"_108":-5,"_13":-5,"_95":504,"_97":504,"_25":505,"_27":28,"_111":-5,"_112":924,"_114":925},[],[],{"_101":509,"_103":510,"_105":-5,"_106":511,"_108":-5,"_13":-5,"_95":512,"_97":512,"_25":513,"_27":28,"_111":-5,"_112":927,"_114":928},[],[],{"_101":517,"_103":518,"_105":-5,"_106":519,"_108":-5,"_13":-5,"_95":520,"_97":520,"_25":521,"_27":28,"_111":-5,"_112":930,"_114":931},[],[],{"_101":525,"_103":526,"_105":-5,"_106":527,"_108":-5,"_13":-5,"_95":528,"_97":528,"_25":529,"_27":28,"_111":-5,"_112":933,"_114":934},[],[],{"_101":533,"_103":534,"_105":-5,"_106":535,"_108":-5,"_13":-5,"_95":536,"_97":536,"_25":537,"_27":28,"_111":-5,"_112":936,"_114":937},[],[],{"_101":541,"_103":542,"_105":-5,"_106":543,"_108":-5,"_13":-5,"_95":544,"_97":544,"_25":545,"_27":28,"_111":-5,"_112":939,"_114":940},[],[],"mixpanelToken","cc23843c498db1553f595eae3fae57d7","sentryDsn","https://cd638f7e7e056e6e02d1d91f09ba2fa9@o563911.ingest.us.sentry.io/4510302612946944","environment","prd","theme","isMac","isEmbed","embedConfig","pages/Login",{"_953":954,"_955":956},"context",{"_23":24},"returnTo","/","actionData","errors"]

Sign in to MD Integrations's support portal