Skip to main content
Create visit
curl --request POST \
  --url https://{tenantId}.api.nestmed.com/api/v1/visits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "episodeId": "<string>",
  "clinicianId": "<string>",
  "visitTypeId": "<string>",
  "scheduledDate": "2023-11-07T05:31:56Z",
  "location": {},
  "notes": "<string>"
}
'
{
  "visitId": "<string>",
  "episodeId": "<string>",
  "patientId": "<string>",
  "clinicianId": "<string>",
  "visitTypeId": "<string>",
  "visitType": {
    "visitTypeId": "<string>",
    "name": "<string>",
    "discipline": "<string>",
    "serviceCode": "<string>"
  },
  "scheduledDate": "2023-11-07T05:31:56Z",
  "actualDate": "2023-11-07T05:31:56Z",
  "duration": 123,
  "status": "scheduled",
  "location": {},
  "patient": {},
  "clinician": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string<uuid>

A unique key (e.g., UUID) to ensure a POST request is processed only once. If a request with the same key is received again within 24 hours, the original response will be returned without creating a new resource.

Body

application/json
​
episodeId
string
required
​
clinicianId
string
required
​
visitTypeId
string
required
​
scheduledDate
string<date-time>
required
​
location
object
​
notes
string

Response

201 - application/json

Visit created successfully.

​
visitId
string
​
episodeId
string
​
patientId
string
​
clinicianId
string
​
visitTypeId
string
​
visitType
object
​
scheduledDate
string<date-time>
​
actualDate
string<date-time>
​
duration
integer
​
status
enum<string>
Available options:
scheduled,
inProgress,
completed,
cancelled
​
location
object
​
patient
object
​
clinician
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>