Clinic Account API

GET /accounts [public access]

Get list of accounts

Response


curl -k -X GET https://api.vsee.me/api_v3/accounts.json

{
  "data": [
    {
      "code": "DEMO-ACCOUNT-LOCAL",
      "name": "DEMO-ACCOUNT-LOCAL",
      
    },
    {
      "code": "DEMO-ACCOUNT-LOCAL",
      "name": "DEMO-ACCOUNT-LOCAL",
      
    },
    ...
  ]
}

GET /accounts/:code [public access]

Get current member’s Account data. Each member is mapped to Account which contains some general settings.

It includes schema for Intake forms, Signup form.

Account.code is also used for starting visits.

Intake wizard flow:

Patient should go through all steps defined in 2 arrays: Account.intake_steps and Account.post_intake_steps

Create / update Intake object
When Account.intake_steps are all passed, create a visit
Go through Account.post_intake_steps at which the patient may update existing intake and do other things (take survey, pick pharmacy, etc)

Each step has a code field which defines the type of content of the step. See the description below

Parameters

Parameter	Type	Description

Parameter	Type	Description
`code`	`String`	Account’s code or dash (-) for current account

Response

curl -k -X GET https://api.vsee.me/api_v3/accounts/vclinic.json

{
  data: {
    id: "56ced820-55bc-43ca-9b35-4599ac1f0144",
    code: "vclinic",
    domain: "demo.vsee.me",
    name: "VClinic",
    portal_title: "",
    privacy_id: "",
    states: {
      signup: {
        signup: [
          {
            name: "",
            code: "signup",
            next: {
              title: "Enter"
            },
            sections: [
              {
                code: "signup_activate",
                schema: {
                  first_name: {
                    type: "string",
                    required: true,
                    eligibility: {
                      field: "first_name"
                    }
                  },
                  last_name: {
                    type: "string",
                    required: true,
                    eligibility: {
                      field: "last_name"
                    }
                  },
                  dob: {
                    type: "string",
                    required: true,
                    eligibility: {
                      field: "dob"
                    }
                  },
                  ssn: {
                    type: "integer",
                    maxLength: 4,
                    required: true,
                    allowedEmpty: true,
                    eligibility: {
                      field: "ssn"
                    }
                  },
                  email: {
                    type: "string",
                    required: true
                  }
                },
                form: [
                  {
                    key: "first_name",
                    placeholder: "First Name",
                    type: "text"
                  },
                  {
                    key: "last_name",
                    placeholder: "Last Name",
                    type: "text"
                  },
                  {
                    key: "dob",
                    placeholder: "Date of Birth",
                    type: "datepicker"
                  },
                  {
                    key: "ssn",
                    placeholder: "Last 4 digit of SSN",
                    type: "text"
                  },
                  {
                    key: "email",
                    placeholder: "Email",
                    type: "email"
                  }
                ]
              }
            ]
          }
        ],
        verification: [
          {
            name: "",
            code: "signup_verification",
            next: {
              title: "Enter"
            },
            sections: [
              {
                code: "signup_verification",
                schema: {
                  email_token: {
                    type: "string",
                    required: true
                  },
                  email: {
                    type: "string"
                  }
                },
                form: [
                  {
                    key: "email_token",
                    placeholder: "6-digit verification code",
                    type: "text"
                  }
                ]
              }
            ]
          }
        ],
        update_profile: [
          {
            name: "New account",
            code: "post_signup_update_profile",
            next: {
              title: "Create"
            },
            sections: [
              {
                code: "post_signup_profile",
                schema: {
                  first_name: {
                    type: "string",
                    required: true
                  },
                  last_name: {
                    type: "string",
                    required: true
                  },
                  gender: {
                    type: "string",
                    enum: [
                      "male",
                      "female"
                    ],
                    required: true
                  },
                  dob: {
                    type: "string",
                    required: true
                  },
                  password: {
                    type: "string",
                    required: true
                  },
                  password_retype: {
                    type: "string"
                  },
                  phone: {
                    type: "string",
                    required: false
                  },
                  street_addr: {
                    type: "string"
                  },
                  city: {
                    type: "string"
                  },
                  state: {
                    type: "string",
                    enum: [
                      "AL",
                      "AK",
                      "AZ",
                      "AR",
                      "CA",
                      "CO",
                      "CT",
                      "DE",
                      "DC",
                      "FL",
                      "GA",
                      "HI",
                      "ID",
                      "IL",
                      "IN",
                      "IA",
                      "KS",
                      "KY",
                      "LA",
                      "ME",
                      "MD",
                      "MA",
                      "MI",
                      "MN",
                      "MS",
                      "MO",
                      "MT",
                      "NE",
                      "NV",
                      "NH",
                      "NJ",
                      "NM",
                      "NY",
                      "NC",
                      "ND",
                      "OH",
                      "OK",
                      "OR",
                      "PA",
                      "RI",
                      "SC",
                      "SD",
                      "TN",
                      "TX",
                      "UT",
                      "VT",
                      "VA",
                      "WA",
                      "WV",
                      "WI",
                      "WY"
                    ]
                  },
                  zip: {
                    type: "string"
                  },
                  pcp_name: {
                    type: "string"
                  },
                  pcp_phone: {
                    type: "string"
                  }
                },
                form: [
                  {
                    key: "first_name",
                    title: "First Name",
                    type: "text"
                  },
                  {
                    key: "last_name",
                    title: "Last Name",
                    type: "text"
                  },
                  {
                    key: "gender",
                    type: "radios",
                    title: "Gender",
                    titleMap: {
                      male: "Male",
                      female: "Female"
                    }
                  },
                  {
                    key: "dob",
                    title: "Date of Birth",
                    type: "datepicker"
                  },
                  {
                    key: "password",
                    title: "Password",
                    type: "password"
                  },
                  {
                    key: "password_retype",
                    title: "Retype password",
                    type: "password"
                  },
                  {
                    key: "phone",
                    type: "text",
                    title: "Phone number"
                  },
                  {
                    key: "street_addr",
                    type: "text",
                    title: "Street Addr"
                  },
                  {
                    key: "city",
                    type: "text",
                    title: "City"
                  },
                  {
                    key: "state",
                    type: "select",
                    title: "State",
                    titleMap: {
                      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"
                    }
                  },
                  {
                    key: "zip",
                    type: "text",
                    title: "Zip"
                  },
                  {
                    key: "pcp_name",
                    type: "text",
                    title: "Primary Care Physician Name"
                  },
                  {
                    key: "pcp_phone",
                    type: "text",
                    title: "Primary Care Physician Phone"
                  }
                ]
              },
              {
                code: "post_signup_tos_popup",
                title: "Before you can complete your registration, you must accept the Onduty Terms of Service and Privacy Policy",
                agree: {
                  title: "I Agree"
                },
                terms: {
                  title: "View Terms"
                }
              }
            ]
          }
        ],
        terms_of_service: [
          {
            name: "Terms of Service",
            code: "terms_of_service_text",
            sections: [
              {
                code: "terms_of_service_text"
              }
            ]
          }
        ]
      },
      visits: {
        signin: [

        ],
        intake: [
          {
            name: "Enter Lounge",
            code: "intake",
            next: {
              title: "Next"
            },
            sections: [
              {
                code: "update_intake",
                schema: {
                  reason_for_visit: {
                    type: "string",
                    provider_title: "Chief Complaint",
                    required: true,
                    multiple: true,
                    allow_tags: false,
                    enum: [
                      "Abdominal pain",
                      "Allergic reaction",
                      "Anxiety",
                      "Asthma",
                      "Back pain",
                      "Chest pain",
                      "Cold/runny nose",
                      "Constipation",
                      "Cough",
                      "Cut/scrape",
                      "Depression",
                      "Diarrhea",
                      "Difficulty breathing",
                      "Ear problem",
                      "Extremity injury/fall",
                      "Eye problem",
                      "Fever",
                      "Flu symptoms",
                      "Headache",
                      "Insect sting/bite",
                      "Pregnancy problem",
                      "Rash",
                      "Seasonal allergies",
                      "Sore throat",
                      "Urination problem",
                      "Vomiting",
                      "Other (my symptoms are not listed above)"
                    ]
                  }
                },
                form: [
                  {
                    key: "reason_for_visit",
                    title: "What is your health concern today?",
                    placeholder: "Describe your symptom(s)",
                    type: "select"
                  }
                ]
              },
              {
                code: "file_upload",
                title: "Is there any image you would like to share with the doctor today?"
              }
            ]
          },
          {
            name: "Enter Lounge",
            code: "intake2",
            next: {
              title: "Next"
            },
            sections: [
              {
                code: "update_intake",
                schema: {
                  location: {
                    type: "string",
                    required: true,
                    enum: [
                      "CA"
                    ],
                    show_to_provider: false
                  },
                  phone: {
                    type: "string",
                    provider_title: "Phone",
                    required: true
                  }
                },
                form: [
                  {
                    key: "location",
                    type: "select",
                    title: "Where are you located?",
                    placeholder: "Enter state or zipcode",
                    titleMap: {
                      CA: "California"
                    }
                  },
                  {
                    key: "phone",
                    title: "Which phone number can we reach you at today?",
                    type: "text"
                  }
                ]
              },
              {
                code: "emergency_warning"
              }
            ]
          }
        ],
        visit_type: [
          {
            name: "Enter Lounge",
            code: "visit_type",
            sections: [
              {
                code: "label",
                title: "When would you like to see a doctor?"
              },
              {
                code: "visit_type"
              }
            ]
          }
        ],
        consent: [
          {
            name: "Consent Forms",
            code: "consent_text",
            next: {
              title: "I Agree. Next"
            },
            sections: [
              {
                code: "consent_text"
              }
            ]
          }
        ],
        calendar: [
          {
            name: "Appointment",
            code: "appointment_calendar",
            next: {
              title: "Next"
            },
            sections: [
              {
                code: "appointment_calendar",
                title: "Pick a Date and Time"
              }
            ]
          }
        ],
        post_intake: [
          {
            name: "Enter Lounge",
            code: "emr",
            next: {
              title: "Next"
            },
            sections: [
              {
                code: "label",
                title: "Please update your medical history"
              },
              {
                code: "emr_conditions",
                title: "Past Medical History"
              },
              {
                code: "emr_surgeries",
                title: "Past Surgeries"
              },
              {
                code: "emr_medications",
                title: "Medications"
              },
              {
                code: "emr_allergies",
                title: "Allergies"
              }
            ]
          },
          {
            name: "Enter Lounge",
            code: "pharmacy",
            next: {
              title: "Next"
            },
            sections: [
              {
                code: "pharmacy_picker",
                title: "If you need a prescription today, where would you like it sent?"
              }
            ]
          },
          {
            name: "Enter Lounge",
            code: "survey",
            next: {
              title: "Submit"
            },
            sections: [
              {
                code: "label",
                title: "Your **Parameters** is valuable to help us improve our service. Please take a
                moment to answer the following questions."
              },
              {
                code: "intake_survey"
              }
            ]
          }
        ],
        post_call: [
          {
            name: "Enter Lounge",
            code: "survey",
            next: {
              title: "Submit"
            },
            sections: [
              {
                code: "label",
                title: "Your **Parameters** is valuable to help us improve our service. Please take a
                moment to answer the following questions."
              },
              {
                code: "post_visit_survey"
              }
            ]
          }
        ]
      }
    },
    files: [
      {
        file_id: "56b29a3e-a72c-49e1-93f0-4c23ac1f0144",
        code: "logo",
        path: "https://api.vsee.me/api_v3/files/56b29a3e-a72c-49e1-93f0-4c23ac1f0144"
      },
      {
        file_id: "56fcdfa6-c7cc-433f-b2da-1a21ac1f0144",
        code: "consent",
        path: "https://api.vsee.me/api_v3/files/56fcdfa6-c7cc-433f-b2da-1a21ac1f0144"
      },
      {
        file_id: "57adac35-ac94-4c2d-aedc-7f23ac1f0144",
        code: "terms_of_use",
        path: "https://api.vsee.me/api_v3/files/57adac35-ac94-4c2d-aedc-7f23ac1f0144"
      }
    ],
    waiting_room: {
      subtitle: "If this is an emergency, please call 911 or go to your nearest emergency department.",
      consent: "I consent and reviewed and agreed to <a href='$link' target='_blank'>the terms of use and privacy policy</a>",
      enter_text: "Enter Lounge",
      need_schedule: true,
      show_code: true,
      average_visit_time: 3600,
      capacity: 100,
      default_room_code: "ceproom1"
    }
  }
}