Skip to main content
Complete visit
curl --request POST \
  --url https://{tenantId}.api.nestmed.com/api/v1/visits/{visitId}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endTime": "2023-11-07T05:31:56Z",
  "duration": 123,
  "mileage": 123,
  "summary": "<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.

Path Parameters

visitId
string
required

Body

application/json
endTime
string<date-time>
duration
integer

Duration in minutes

mileage
number
summary
string

Response

200 - application/json

Visit completed 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>