...
POST /intakes
| Status | ||||
|---|---|---|---|---|
|
Create intake information.data object
Custom parameters
Apart from the parameters below, any amount of custom JSON field-value pairs may be sent. They will all be saved into the Intake object. Later they may be displayed to the provider (please contact VSee to configure the rendering format).
...
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited |
|
| (optional) Reason for visit |
|
| (optional) Visit type: 1 - walkin; 2 - schedule |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Room’s code |
|
| (optional) Multiple formats supported: |
|
| (optional) |
|
| (optional) e.g |
Sample Request
| Code Block |
|---|
curl -k -X POST -d "provider=541&reason_for_visit=Test&reset=true&type=1" https://api.vseepreview.com/vc/next/api_v3/intakes.json
{
"data": {
"id": "56e8c536-566c-44b6-bbca-66f0ac1f0144"
}
}
|
...
POST /intakes/:id
| Status | ||||
|---|---|---|---|---|
|
Update a selected intake informationdata object
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited |
|
| (optional) Reason for visit |
|
| (optional) Visit type: 1 - walkin; 2 - schedule |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Room’s code |
|
| Multiple formats supported: |
|
|
|
|
|
|
|
| (optional) Required for payment related, the consultation objects can be found at |
...
GET /intakes/:id
| Status | ||||
|---|---|---|---|---|
|
Get the specific intakeRetrieve a selected intake data object
Parameters
None
Response
| Code Block |
|---|
curl -X GET \
-H "X-ApiToken: 5a2eb231d652b49f4d7fc0fbb78328fb" \
-H "X-AccountCode: vclinic" \
"https://api.vseepreview.com/vc/next/api_v3/intakes/57a0705e-1c4c-4f24-b51d-3c71ac1f0144"
{
"data": {
"modified": 1471465080,
"created": 1471465080,
"type": "1",
"reason_for_visit": "the reason",
"attachments": [
{
"_id": "57b4c65d-7ef8-461f-8951-43b1ac1f0144",
"name": "575004c7-b350-421d-8542-4dcdac1f0144.png",
"path": "files/2016/08/17/57b4c65d-7ef8-461f-8951-43b1ac1f0144.png",
"size": 12859,
"ext": "png",
"type": 0,
"creator_id": "575",
"remark": null,
"using": 1,
"modified": {
"sec": 1471465053,
"usec": 966000
},
"created": {
"sec": 1471465053,
"usec": 967000
}
}
],
"id": "57b4c678-de20-4c1a-a52b-43e9ac1f0144"
}
}
|
...
POST /visits/add_walkin
| Status | ||||
|---|---|---|---|---|
|
Create a walkin walk-in visit
Parameters
Parameter | Type | Description |
|---|---|---|
|
| (optional) The ID of the provider who is being visited if patient is starting an appointment. Shouldn’t pass this for walkins. |
|
| The ID of the intake. |
|
| The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment. |
|
| (optional) The ID of a scheduled appointment. This one is used in the case when the patient visits a scheduled appointment. |
|
| (optional) Patient’s code ID on behalf of whom the intake will be created |
|
| Current room’s code in which the visit will be created |
...