Create Consult

post

https://partner-api.steadymd.com/v1/consult

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.

Retrieve list of valid consult types for the program using the Program API. Choose the appropriate consult type and provide it in the payload. Make sure to supply the Clinician guid when using List Available Appointments to determine if a Clinician can be scheduled.

If you attempt to create a consult in US state where the program is not supported, you will receive a 400 error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

programGuid

uuid

required

consultType

string | null

A friendly identifier for the consult's type. Is required if the given program has multiple consult types in the same US state.

interactionMode

string | null

enum

auto_triage - Async - Auto Triage
chart_review - Async - Chart Review
message - Async - Message
phone_call - Sync - Phone Call
chat - Sync - Text Chat
video_chat - Sync - Video Chat

Allowed:

emrUri

string

required

usState

string

enum

required

AL - Alabama
AK - Alaska
AZ - Arizona
AR - Arkansas
CA - California
CO - Colorado
CT - Connecticut
DE - Delaware
DC - District of Columbia
FL - Florida
GA - Georgia
HI - Hawaii
ID - Idaho
IL - Illinois
IN - Indiana
IA - Iowa
KS - Kansas
KY - Kentucky
LA - Louisiana
ME - Maine
MD - Maryland
MA - Massachusetts
MI - Michigan
MN - Minnesota
MS - Mississippi
MO - Missouri
MT - Montana
NE - Nebraska
NV - Nevada
NH - New Hampshire
NJ - New Jersey
NM - New Mexico
NY - New York
NC - North Carolina
ND - North Dakota
OH - Ohio
OK - Oklahoma
OR - Oregon
PA - Pennsylvania
RI - Rhode Island
SC - South Carolina
SD - South Dakota
TN - Tennessee
TX - Texas
UT - Utah
VT - Vermont
VA - Virginia
WA - Washington
WV - West Virginia
WI - Wisconsin
WY - Wyoming
PR - Puerto Rico

externalLinks

array of objects

externalLinks

metadata

object

preferredClinician

uuid | null

A clinician to be requested for the consult. Clinician may not always be available. This should only be used for special, pre-approved use cases.

isPediatric

boolean

A patient identifier if they're under 18. Is optional for Limited Integration.

reasonForVisit

string | null

enum

Optional. Select a reason for the visit from the list of available choices.

additional_documentation - Additional Documentation
adhoc_follow_up - Adhoc Follow Up
adhoc_side_effect - Adhoc Side Effect
adhoc_pharmacy_change - Adhoc Pharmacy Change
adhoc_pharmacy_call - Adhoc Pharmacy Call
adhoc_medication_change - Adhoc Medication Change
adhoc_additional_documentation - Adhoc Additional Documentation
critical_value - Critical Value
initial - Initial
follow_up - Follow Up
lab_result - Lab Result
medication_change - Medication Change
pharmacy_change - Pharmacy Change
post_test_hiv_counseling - Post-Test HIV Counseling
pre_test_hiv_counseling - Pre-Test HIV Counseling
pre_test_sti_counseling_non_hiv - Pre-Test STI Counseling (Non-HIV)
doc_only_rx_review - Doc Only Rx Review
side_effect - Side Effect

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

201