V3 API Consultations

Get a consultation for given consultationId.

GET v3/admin/consultations/{{consultationId}}

Request

Headers

X-Developer-Id	developer id
X-Api-Key	api key
Authorization	Bearer {{access_token}}
Time-Zone	optional, timezone of time fields in response. default: login user's timezone

 
 

Parameters (QueryString)

ops

string

comma separated values for additions fields to be included in the response. possible values: [soapnote, medcodes, locations, all (all three)]

sample request

GET /api/v3/admin/consultations/58425?ops=all HTTP/1.1
Host: api.qa1.snapvcm.com
X-Developer-Id:  {{apiDeveloperId}}
X-Api-Key:  {{apiKey}}
Authorization:  Bearer {{accessToken}}
time-zone:  Alaskan Standard Time
cache-control: no-cache
Postman-Token: 5738c8d8-7872-4ecb-b256-d584c8f711ed

sample response:

{
    "consultationId": 58425,
    "hospitalId": 126,
    "patient": {
        "userId": 4397,
        "patientId": 5598,
        "firstName": "Dan2Patient2",
        "lastName": "Park",
        "gender": "M",
        "dob": "1990-07-28T00:00:00Z",
        "person": {
            "id": "ed612fb9-5ec8-43bf-935e-bc7709de1613",
            "name": {
                "given": "Dan2Patient2",
                "prefix": "",
                "suffix": "",
                "family": "Park"
            },
            "photoUrl": "https://api.qa1.snapvcm.com/api/v2.1/images/c7cda341-665a-4104-9b2d-540caff2fb27",
            "profileImageId": "c7cda341-665a-4104-9b2d-540caff2fb27",
            "providerId": 126,
            "statusCode": 1,
            "contactTypeCode": 1,
            "phones": [
                {
                    "id": "94b9091f-e356-43e6-b524-c9b862ef54c1",
                    "use": "mobile",
                    "value": "+11123123123"
                }
            ]
        },
        "patientAddress": {
            "line1": "1010 S Olive St",
            "line2": "",
            "city": "Los Angeles",
            "state": "CA",
            "stateCode": "CA",
            "postalCode": "90015",
            "country": "US",
            "countryCode": "US",
            "addressText": "1010 S Olive St, Los Angeles, CA 90015, US"
        },
        "geoLocationAddress": {
            "line1": "121 West Lexington Drive",
            "line2": "",
            "city": "Glendale",
            "state": "California",
            "stateCode": "CA",
            "postalCode": "91203",
            "country": "United States",
            "countryCode": "US",
            "addressText": "121 West Lexington Drive, Glendale, CA 91203, US"
        }
    },
    "encounterTypeCode": 3,
    "concerns": [
        {
            "concernCode": "2306",
            "concernText": "Cough"
        }
    ],
    "consultationStatus": 68,
    "consultationTime": "2018-11-27T10:06:39.293-09:00",
    "isScheduled": false,
    "isNoCharge": false,
    "isHealthPlanApply": false,
    "consultationAmount": 6
}