# SteadyMD Documentation

> Documentation for SteadyMD

## Guides: Getting Started
- [Introduction](https://docs.steadymd.com/docs/getting-started.md)
  - [Key Terms](https://docs.steadymd.com/docs/key-terms.md): Concepts in the SteadyMD Platform
  - [Modalities](https://docs.steadymd.com/docs/modalities.md): The different ways clinicians and patients can connect during a visit.
  - [Types of Care](https://docs.steadymd.com/docs/define-program-consult-types.md)
    - [Labs](https://docs.steadymd.com/docs/labs.md)
    - [Urgent Care ](https://docs.steadymd.com/docs/urgent-care.md)
  - [Authentication](https://docs.steadymd.com/docs/authentication.md)
  - [Visit Status Updates / SNS Topics](https://docs.steadymd.com/docs/consult-status-updates.md): SteadyMD sends notifications at every step of the consult workflow so partners always know where the patient is at in their care journey. Platform events inform partners when a visit is starting, a…
    - [Platform Event Examples - AWS SNS Messages ](https://docs.steadymd.com/docs/example-response.md)
  - [Consult Statuses](https://docs.steadymd.com/docs/consult-statuses.md)
    - [Consult Status Reasons](https://docs.steadymd.com/docs/consult-status-reasons.md): Partners should match on the reason slug. The reason string can change at any time.
  - [Quick Start Options](https://docs.steadymd.com/docs/quick-start-options.md)
    - [Patient UI Elements](https://docs.steadymd.com/docs/patient-ui-element.md)
    - [Direct to Patient Notifications - SMS & Email](https://docs.steadymd.com/docs/direct-to-patient-notifications-sms-email.md)
    - [Limited Integrations](https://docs.steadymd.com/docs/limited-integrations.md)

## Guides: EMR Endpoints
- [Patient and Chart Information](https://docs.steadymd.com/docs/emr-endpoints.md)
  - [Phone Number Validation](https://docs.steadymd.com/docs/phone-number-validation.md)
  - [Episode Of Care](https://docs.steadymd.com/docs/episode-of-care.md)
  - [Intake Questionnaires](https://docs.steadymd.com/docs/intakes.md)
  - [Preferred Pharmacy](https://docs.steadymd.com/docs/preferred-pharmacy.md)
  - [ID Verification](https://docs.steadymd.com/docs/id-verification.md)
  - [Pediatric Requirements](https://docs.steadymd.com/docs/pediatric-requirements.md): Pediatric visits are for patients ages 17 and under.
  - [Update Patient](https://docs.steadymd.com/docs/update-patient.md)

## Guides: Standard Features
- [Pharmacy Search](https://docs.steadymd.com/docs/pharmacy-search.md): Ensure the patient provides a valid pharmacy when needed for treatment by using our pharmacy search endpoint. If a patient’s pharmacy changes, please update the preferred pharmacy on the episode…
- [Clinicians](https://docs.steadymd.com/docs/clinicians.md)
- [Light Integration](https://docs.steadymd.com/docs/light-integration.md)
- [Consults](https://docs.steadymd.com/docs/consult-meta-data.md)
  - [Async + Messaging](https://docs.steadymd.com/docs/async-messaging.md)
  - [On Demand Video](https://docs.steadymd.com/docs/on-demand-video.md)
  - [Scheduled Video](https://docs.steadymd.com/docs/scheduled-video.md)

## Guides: White Label
- [SSO](https://docs.steadymd.com/docs/sso.md)
- [Stripe Account Integration](https://docs.steadymd.com/docs/stripe-account.md): SteadyMD White Labels can plug into a partner’s Stripe account.

## API Reference: SteadyMD Partner API
- patient
  - [Create Patient](https://docs.steadymd.com/reference/patientcreate.md): Create and retrieve patient data.
  - [Retrieve Patient](https://docs.steadymd.com/reference/patientretrieve.md): Create and retrieve patient data.
- episode
  - [Create Episode](https://docs.steadymd.com/reference/episodecreate.md): Create a new Episode for a Patient.
  - [Retrieve Episode](https://docs.steadymd.com/reference/episoderetrieve.md): Retrieve an Episode of care including any treatment plan, pharmacy, and prescription data that has been generated by SteadyMD while providing treatment for this episode.
  - [Update Episode](https://docs.steadymd.com/reference/episodepartialupdate.md): Update the Requested Pharmacy or the Parents or Guardians on an Episode. You may not modify any other fields. You may send some or all of the read-only fields. If they are unmodified they will be…
- identity
  - [List Identity Verification Claims](https://docs.steadymd.com/reference/identitylist.md)
  - [Claim Identity Verification](https://docs.steadymd.com/reference/identitycreate.md)
- encounter
  - [List Encounters](https://docs.steadymd.com/reference/encounterlist.md): Encounter is a clinical interaction between a patient and a healthcare provider or system, which can include an admission, a visit, a consultation, or a phone call.
  - [Get Encounter](https://docs.steadymd.com/reference/encounterretrieve.md): Encounter is a clinical interaction between a patient and a healthcare provider or system, which can include an admission, a visit, a consultation, or a phone call.
- intake
  - [List Intakes](https://docs.steadymd.com/reference/intakelist.md): An intake is a set of questionnaire responses and files associated with a given Episode.
  - [Create Intake](https://docs.steadymd.com/reference/intakecreate.md): <h3>Observations format:</h3>
  - [Retrieve Intake](https://docs.steadymd.com/reference/intakeretrieve.md): An intake is a set of questionnaire responses and files associated with a given Episode.
  - [Update Intake](https://docs.steadymd.com/reference/intakeupdate.md): Update the Episode, Observations, Questionnaire, Lab Requisition or the isDraft on an Intake. You may not modify any other fields. Note that intake files cannot be updated from this endpoint, but new…
  - [Add Allergy or Intolerance](https://docs.steadymd.com/reference/intakeallergyintolerancecreate.md): Associate allergies or intolerance to the intake
- intakeFile
  - [Create Intake File](https://docs.steadymd.com/reference/intakefilecreate.md): Create an intake file
- consult
  - [List Consults](https://docs.steadymd.com/reference/consultlist.md)
  - [Create Consult](https://docs.steadymd.com/reference/consultcreate.md): Create a new Consult. Supply an emrUri which identifies the Episode that this Consult is for or in the case of a Lightweight Integration a valid URL in your EMR. <br><br> Retrieve list of valid…
  - [Retrieve Consult](https://docs.steadymd.com/reference/consultretrieve.md)
  - [Create Patient UI URL](https://docs.steadymd.com/reference/consultpatientuicreate.md)
  - [Schedule Consult Appointment](https://docs.steadymd.com/reference/consultscheduleappointmentcreate.md): Schedule an appointment for this Consult.
  - [Retrieve Available Appointments](https://docs.steadymd.com/reference/consultscheduleavailabilityretrieve.md): Retrieve a list of available appointments for this Consult. Clinicians who have availability within 15 days.
  - [Update Consult Status](https://docs.steadymd.com/reference/consultstatuscreate.md): For limited integration, after a clinician has completed a consult, partner can use this endpoint to tell SteadyMD that a consult has been completed. Also, for all integrations and types this…
  - [Retrieve Consult Status History](https://docs.steadymd.com/reference/consultstatushistorylist.md): Retrieve all status changes for a consult, ordered chronologically.
  - [Create Consult Issue](https://docs.steadymd.com/reference/consultissuescreate.md): Creates an issue requiring resolution. If the consult transitions to a resolved status while still having unresolved issues, it will instead transition to ISSUE STATUS until everything is resolved.
  - [Create Message Consult](https://docs.steadymd.com/reference/consultmessagecreate.md): DEPRECATED - Create a message consult that is a follow up to an existing completed Consult. This endpoint receives an empty BODY.
- labOrder
  - [List LabOrders](https://docs.steadymd.com/reference/laborderlist.md): Create and retrieve LabOrders
  - [Create LabOrder](https://docs.steadymd.com/reference/labordercreate.md): Creates a new LabOrder for a specific Episode
  - [Retrieve LabOrder](https://docs.steadymd.com/reference/laborderretrieve.md): Access a LabOrder by GUID, which includes both lab requisitions and results GUIDs. Please note that if the results have not yet been submitted, the results section will be empty
  - [Retrieve Lab Order PDF](https://docs.steadymd.com/reference/laborderpdfretrieve.md): Create and retrieve LabOrders
  - [List Lab Results](https://docs.steadymd.com/reference/laborderresultslist.md): List all released LabResults for a given LabOrder
  - [Create Lab Result](https://docs.steadymd.com/reference/laborderresultscreate.md): Create and retrieve LabOrders
  - [Get Lab Result PDF](https://docs.steadymd.com/reference/laborderresultspdfretrieve.md): Create and retrieve LabOrders
  - [Upload Lab Result PDF](https://docs.steadymd.com/reference/laborderresultspdfcreate.md): Create and retrieve LabOrders
  - [Retrieve Multiple Lab Result PDF](https://docs.steadymd.com/reference/laborderresultspdfslist.md): Create and retrieve LabOrders
  - [Upload Multiple Lab Result PDF](https://docs.steadymd.com/reference/laborderresultspdfscreate.md): Create and retrieve LabOrders
  - [Retrieve Lab Result](https://docs.steadymd.com/reference/laborderresultsretrieve.md): Retrieve a specific Lab Result by GUID
  - [Retrieve Medical Necessity Form PDF](https://docs.steadymd.com/reference/labordermedicalnecessityformpdfretrieve.md): Create and retrieve LabOrders
  - [Retrieve Lab Result FHIR Data](https://docs.steadymd.com/reference/laborderresultsfhirretrieve.md): Retrieves the raw FHIR R4 Bundle for a specific lab result by GUID. The FHIR Bundle includes Patient, ServiceRequest, DiagnosticReport, Observation, Organization, Practitioner, and Specimen resources…
  - [Retrieve Latest Lab Result](https://docs.steadymd.com/reference/laborderresultslatestretrieve.md): Retrieve the most recent Lab Result for a given Lab Order
  - [Retrieve Latest Lab Result FHIR Data](https://docs.steadymd.com/reference/laborderresultslatestfhirretrieve.md): Retrieves the raw FHIR R4 Bundle for the most recent lab result associated with this lab order. The FHIR Bundle includes Patient, ServiceRequest, DiagnosticReport, Observation, Organization,…
  - [Get Latest Lab Result PDF](https://docs.steadymd.com/reference/laborderresultslatestpdfretrieve.md): Create and retrieve LabOrders
  - [Get Latest Lab Result PDFs](https://docs.steadymd.com/reference/laborderresultslatestpdfslist.md): Create and retrieve LabOrders
- message
  - [List Messages](https://docs.steadymd.com/reference/messagelist.md): Create and retrieve messages for an episode
  - [Create Message](https://docs.steadymd.com/reference/messagecreate.md): Create and retrieve messages for an episode
  - [Retrieve Message](https://docs.steadymd.com/reference/messageretrieve.md): Create and retrieve messages for an episode
- messageAttachment
  - [Create Message Attachment](https://docs.steadymd.com/reference/messageattachmentcreate.md): Create a message attachment
- program
  - [List Programs](https://docs.steadymd.com/reference/programlist.md): Retrieve a paginated list of all the programs available to your organization.
  - [Retrieve Program](https://docs.steadymd.com/reference/programretrieve.md)
  - [List Available Appointments](https://docs.steadymd.com/reference/programappointmentsretrieve.md): Retrieve a list of available appointments for this Program. Clinicians who have availability within 15 days.
  - [List Clinicians](https://docs.steadymd.com/reference/programclinicianslist.md): Retrieve a paginated list of all the clinicians available to your program.
  - [Retrieve consult create options for a program](https://docs.steadymd.com/reference/programconsultoptionslist.md): Retrieve a list of consult options for this Program. Supply a US State and optionally  a consult_type to see available options in that US state.
  - [List Available Lab Tests](https://docs.steadymd.com/reference/programlablist.md): Retrieve a list of available lab tests for this Program.
- pharmacy
  - [Search Pharmacies](https://docs.steadymd.com/reference/pharmacylist.md): Retrieve a list of available pharmacies with given parameters. Note: searching by zipcode only will return results from the given zip code, nearby zipcodes, as well as mail order pharmacies.…
- clinician
  - [Retrieve Clinician](https://docs.steadymd.com/reference/clinicianretrieve.md)
- patientAccount
  - [Create Patient Account](https://docs.steadymd.com/reference/patientaccountcreate.md): Create a new Patient Account for use with white label implementations. Provide the Patient GUID to link the Patient Account to a Patient. After creating a Patient Account you can use the Patient…
- patientLoginLink
  - [List Patient Login Links](https://docs.steadymd.com/reference/patientloginlinklist.md): List Patient Login Links. Filter by the Patient guid or the Patient Account guid.
  - [Create Patient Login Link](https://docs.steadymd.com/reference/patientloginlinkcreate.md): Create a new Patient Login Link which can be used by the Patient to login to a white label implementation. You must provide a Patient Account guid to link the Patient Login Link to a Patient Account
  - [Retrieve Patient Login Links](https://docs.steadymd.com/reference/patientloginlinkretrieve.md): Retrieve a Patient Login Link by short code. Use this to check if a Patient Login Link has been.
- patientPayment
  - [Search Patient Payments](https://docs.steadymd.com/reference/patientpaymentsessionlist.md): Retrieve a list of payment sessions with given parameters. The results are non-paginated and the max sessions returned is 100.
  - [Retrieve Patient Payment](https://docs.steadymd.com/reference/patientpaymentsessionretrieve.md): Retrieve a payment sessions with id.
- consentFile
  - [List Consent Files](https://docs.steadymd.com/reference/consentfilelist.md): List consent files created by the authenticated partner
  - [Create Consent File](https://docs.steadymd.com/reference/consentfilecreate.md): Upload a consent file for the partner
  - [Retrieve Consent File](https://docs.steadymd.com/reference/consentfileretrieve.md): Create, retrieve and list consent files
- vendor
  - [List Vendor Partners](https://docs.steadymd.com/reference/vendorpartnerslist.md): Returns the list of partners the vendor is authorized to act on behalf of.

## API Reference: Sandbox API
- consult
  - [Complete](https://docs.steadymd.com/reference/consultcompletecreate.md): Complete a Consult with a canned treatment plan, notes, and Rx. Pass encounter_guid to instead clone a completed example encounter.
  - [Message and Wait](https://docs.steadymd.com/reference/consultmessageandwaitcreate.md): Send a canned message from the Clinician and move the Consult visitStatus to waiting. Pass tasks to attach one or more patient tasks to that message. ndc is required when tasks includes…
  - [Refer Out](https://docs.steadymd.com/reference/consultreferoutcreate.md): Refer out a Consult with a canned treatment plan, notes, and no Rx. Pass encounter_guid to instead clone a completed example encounter.
  - [Start](https://docs.steadymd.com/reference/consultstartcreate.md): Start a Consult by assigning a test Clinician and setting visitStatus to in_progress.
  - [In Call](https://docs.steadymd.com/reference/consultincallcreate.md): Move the Consult visitStatus to in_call. Only available for sync consults with an assigned Clinician, and the Consult must be in one of the following statuses: in_progress, external_in_progress,…
  - [In Progress](https://docs.steadymd.com/reference/consultinprogresscreate.md): Move the Consult visitStatus to in_progress (e.g. stepping back from in_call). Requires an assigned Clinician, and the Consult must be in one of the following statuses: in_call or ready_to_resume.
  - [Reject](https://docs.steadymd.com/reference/consultrejectcreate.md): Reject a Consult with a reject reason. reason_slug must reference an active reject reason (see GET consult/reasons?status=rejected).
  - [Reject Reasons (deprecated)](https://docs.steadymd.com/reference/consultrejectreasonslist.md): Deprecated: use GET consult/reasons?status=rejected instead. List active reject reasons available to sandbox partners.
  - [Reasons](https://docs.steadymd.com/reference/consultreasonslist.md): List active reasons for a given consult status. Pass status=rejected or status=referred_out. Use a reason slug as reason_slug when rejecting or referring out a consult.

## Changelog
- [February 2025 - Consult Status Set At](https://docs.steadymd.com/changelog/february-2025-consult-status-set-at.md)
- [October 2024 - Partial Lab Results Release](https://docs.steadymd.com/changelog/october-2024-partial-lab-results-release.md)
- [August 2024 Asyncs escalate to Video / Phone](https://docs.steadymd.com/changelog/august-2024-asyncs-escalate-to-video-phone.md)
- [June 2024 - Refer Out Reasons](https://docs.steadymd.com/changelog/june-2024-refer-out-reasons.md)
- [May 2024 - Ready to Book Status, reasons for visits, Intake observations](https://docs.steadymd.com/changelog/may-2024-ready-to-book-status-reasons-for-visits-intake-observations.md)
- [April 2024 - Consults Issue Status](https://docs.steadymd.com/changelog/april-2024.md)