Step 1: Request Your Sandbox API KeySet

To get started, you must request a Sandbox account for your company. This is done through your sales person. Once you have your Sandbox account, you need to request your API Key/Secret pair to begin testing. Click the button below to request your keyset.

Step 2: API Testing Tools

MedWand recommends and uses, Postman for all API testing. Although you may use any tool you wish, using Postman will allow us to better assist you if the need arises. You can download and install Postman from Here.

Step 3: First Test

Your first test will be to retrieve a heartbeat response from the api server. To do this follow these steps:

1. Add a new request in Postman.
2. Select "GET" as the method type.
3. Enter "https://api.medwand.cloud/heartbeat" as the URL.
4. In the "Authorization" tab, set the type to "No Auth".
5. Click the "Send" button.

You should receive a response that looks like the JSON below:

        {
        "actionResult": true,
        "actionResponse": "Success",
        "actionMessages": "v2.0.1.1",
        "actionDateUtc": "2018-01-01T18:08:01.5786221Z",
        "environment": "Sandbox"
        }
                                

Once you've successfully retrieved a heartbeat response from the Sandbox API, you are ready to get a deeper understanding of how the flow works between the MedWand Ecosystem.

The flowchart below covers all 3 exam types (Patient, OnSite, and Remote) that you may use.

Once you have a good understanding of the flow, you are ready to begin using our Default API to integrate the MedWand Virtual Care System with your existing PMS/EHR platform.

Step 1: Create your first appointment

1. Add a new request in Postman.
2. Select "POST" as the method type.
3. Enter "https://api.medwand.cloud/default/appointment/create" as the URL.
4. In the "Authorization" tab, set the type to "No Auth".
5. In the "Headers" tab add your API Key/Secret pair.
   • Add "apiKey" in the Key field.
   • Add the API key you received from us in the Value field.
   • Add "apiSecret" in the Key field.
   • Add the API secret you received from us in the Value field.
6. In the "Body" tab, select "Raw" for the type and "JSON" from the dropdown list.
7. Use the code from the "JSON Request" section below for the payload.
8. Click the "Send" button.

            {
                "appointmentId": "",
                "doctorName": "Dr. John Doe",
                "patientName": "Mrs. Jane Patient",
                "patientAge": 0,
                "patientSex": "",
                "patientWeight": "",
                "examType": "Patient",
                "scheduledStartDateUtc": "2023-01-01T18:08:01.5786221Z",
                "scheduledDuration": 30
            }
                                        

            {
                "medWandAppointmentId": "",
                "customerExamId": "",
                "doctorUrl": "https://examroom.medwand.cloud?platform=api.medwand.cloud&token=hzGBAmPl2UCfrkKwM-VacA",
                "patientUrl": "https://client.medwand.com?platform=api.medwand.cloud&token=ADsmk4pcqE6V1HfT4WQPqg",
                "guestUrl": "https://examroom.medwand.cloud/Guest?platform=api.medwand.cloud&token=MIUrf3cGVkqde7bJc_prOw",
                "actionResult": true,
                "actionResponse": "Success",
                "actionMessages": "",
                "actionDateUtc": "2023-01-01T18:08:02.2156221Z",
                "environment": "Sandbox"
            }
                                        

Step 2: Run your first exam

1. Add an anchor tag to the HTML file with the "patientUrl" value in the href attribute.
2. Launch the HTML file in the Chrome browser.
3. Click the "Run Exam" link.

The MedWand Client Application will run and you will be able to start the exam. If this did not happen, retry the steps above.

Take whatever readings you would like during the exam. When you are done, click "Summary" and then click "Exit Exam". The MedWand Client Application will close when the exam results have been sent to our server for processing.

You should have received a notification at the Callback URL that you provided with the following information:

            {
                examId = "",
                endDate = "2023-01-01T18:08:15.5786221Z"
            }
                                        

Step 3: Retrieve your exam results

Retrieving the basic exam results. We will retrieve the media results in the next section.

1. Add a new request in Postman.
2. Select "POST" as the method type.
3. Enter "https://api.medwand.cloud/default/exam/basics" as the URL.
4. In the "Authorization" tab, set the type to "No Auth".
5. In the "Headers" tab add your API Key/Secret pair.
   • Add "apiKey" in the Key field.
   • Add the API key you received from us in the Value field.
   • Add "apiSecret" in the Key field.
   • Add the API secret you received from us in the Value field.
6. In the "Body" tab, select "Raw" for the type and "JSON" from the dropdown list.
7. Use the code from the "JSON Request" section below for the payload.
8. Click the "Send" button.

            {
                "appointmentId": ""
            }
                                        

            {
                "appointmentId": "",
                "doctorName": "Dr. John Doe",
                "patientName": "Mrs. Jane Patient",
                "examType": "Patient",
                "notesForDoctor": "",
                "notesForPatient": null,
                "vitals": [
                    {
                        "sensor": "Thermometer",
                        "data": "99.4",
                        "settings": "unit:Fahrenheit"
                    },
                    {
                        "sensor": "PulseRate",
                        "data": "70",
                        "settings": ""
                    },
                    {
                        "sensor": "SpO2",
                        "data": "100",
                        "settings": ""
                    }
                ],
                "media": [
                    {
                        "sensor": "Otoscope",
                        "readingId": "f1e05047-a519-476c-afe5-6c72cda56044"
                    }
                ],
                "actionResult": true,
                "actionResponse": "Success",
                "actionMessages": "",
                "actionDateUtc": "2023-01-01T18:08:02.2156221Z",
                "environment": "Sandbox"
            }
                                        

Retrieving the media results by looping through the media[] array from Response JSON and call the url for each item.

1. Add a new request in Postman.
2. Select "POST" as the method type.
3. Enter "https://api.medwand.cloud/default/exam/reading" as the URL.
4. In the "Authorization" tab, set the type to "No Auth".
5. In the "Headers" tab add your API Key/Secret pair.
   • Add "apiKey" in the Key field.
   • Add the API key you received from us in the Value field.
   • Add "apiSecret" in the Key field.
   • Add the API secret you received from us in the Value field.
6. In the "Body" tab, select "Raw" for the type and "JSON" from the dropdown list.
7. Use the code from the "JSON Request" section below for the payload.
8. Click the "Send" button.

            {
                "appointmentId": "",
                "readingId": "f1e05047-a519-476c-afe5-6c72cda56044"
            }
                                        

            {
                "sortOrder": 1,
                "deviceName": "MedWand Device",
                "deviceModel": "Generation2",
                "sensor": "Otoscope",
                "sensorMode": "Dermatoscope",
                "sensorSettings": "",
                "sensorData": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/...",
                "actionResult": true,
                "actionResponse": "Success",
                "actionMessages": "",
                "actionDateUtc": "2023-01-01T18:08:02.2156221Z",
                "environment": "Sandbox"
            }
                                        

At this point you should have a full understanding of how to use the MedWand Default API to create appointments, run an exam against an appointment, and then retrieve the results.

Exam Types

These values are case sensitive

• Patient : This is a self exam completed by the patient only.
• OnSite : This is a local exam completed by a practitioner (nurse, doctor, etc.).
• Remote : This is an exam completed by practitioner (nurse, doctor, etc.) from a remote location.

Sensor Types

These are the available sensor types along with their possible unit types.

• Thermometer : The settings field indicates the unit type.
  • unit:Fahrenheit
  • unit:Celsius
• SpO2 :
• PulseRate :
• BloodPressure :
• WeightScale : The settings field indicates the unit type.
  • unit:Pounds
  • unit:Kilograms
• HeightScale : The settings field indicates the unit type.
  • unit:Inches
  • unit:Centimeters
• Glucometer :
• Respiratory :
• SpirometerPef :
• SpirometerFev1 :
• SpirometerFvc :
• PainLevel : The settings field indicates the unit type.
  • unit:Numeric
  • unit:PAINAD

Media Types

These are the available Media Types along with their possible modes.

• Stethoscope : The sensorMode field indicates the mode the sensor was in during the reading.
  • Heart
  • Lungs
  • Abdominal
• Otoscope : The sensorMode field indicates the mode the sensor was in during the reading.
  • Dermatoscope
  • Otoscope
• Ecg