HeyDonto Zimbis API Documentation (1.0)

API documentation for HeyDonto Zimbis API

Powered by HeyDonto
Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/zimbis/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Zimbis Patient

Operations

Retrieve Site's all Zimbis Patients

Request

Security
bearer
Path
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Sites all Zimbis Patients retrieved successfully.

Bodyapplication/jsonArray [
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
]
Response
application/json
[
  {
    "siteId": 0,
    "patientId": "string",
    "fhirId": "string",
    "ehrId": "string",
    "ehrTable": "string",
    "patient": "string",
    "clientId": "string",
    "clientFirstName": "string",
    "clientLastName": "string",
    "dob": "string",
    "permanent": 0,
    "caution": 0,
    "species": "string",
    "gender": "string",
    "weight": 0,
    "weightUnits": "string",
    "height": 0,
    "heightUnits": "string",
    "location": "string",
    "allergies": "string",
    "clientGender": "string",
    "breed": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "clientDOB": "string",
    "dlNumber": "string",
    "clientPhone": "string",
    "clientEmail": "string",
    "id": 100,
    "createdAt": "2021-08-01T00:00:00.000Z",
    "updatedAt": "2021-08-01T00:00:00.000Z",
    "syncedAt": "2021-08-01T00:00:00.000Z"
  }
]

Create Site Zimbis Patient

Request

Security
bearer
Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 0,
    "patientId": "string",
    "fhirId": "string",
    "ehrId": "string",
    "ehrTable": "string",
    "patient": "string",
    "clientId": "string",
    "clientFirstName": "string",
    "clientLastName": "string",
    "dob": "string",
    "permanent": 0,
    "caution": 0,
    "species": "string",
    "gender": "string",
    "weight": 0,
    "weightUnits": "string",
    "height": 0,
    "heightUnits": "string",
    "location": "string",
    "allergies": "string",
    "clientGender": "string",
    "breed": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "clientDOB": "string",
    "dlNumber": "string",
    "clientPhone": "string",
    "clientEmail": "string"
  }'

Responses

Site Zimbis Patient created successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "patientId": "string",
  "fhirId": "string",
  "ehrId": "string",
  "ehrTable": "string",
  "patient": "string",
  "clientId": "string",
  "clientFirstName": "string",
  "clientLastName": "string",
  "dob": "string",
  "permanent": 0,
  "caution": 0,
  "species": "string",
  "gender": "string",
  "weight": 0,
  "weightUnits": "string",
  "height": 0,
  "heightUnits": "string",
  "location": "string",
  "allergies": "string",
  "clientGender": "string",
  "breed": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "clientDOB": "string",
  "dlNumber": "string",
  "clientPhone": "string",
  "clientEmail": "string",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Retrieve Site's Zimbis Patient by FHIR ID

Request

Security
bearer
Path
siteIdnumberrequired
fhirIdstringrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient/fhir/{fhirId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site's Zimbis Patient retrieved successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "patientId": "string",
  "fhirId": "string",
  "ehrId": "string",
  "ehrTable": "string",
  "patient": "string",
  "clientId": "string",
  "clientFirstName": "string",
  "clientLastName": "string",
  "dob": "string",
  "permanent": 0,
  "caution": 0,
  "species": "string",
  "gender": "string",
  "weight": 0,
  "weightUnits": "string",
  "height": 0,
  "heightUnits": "string",
  "location": "string",
  "allergies": "string",
  "clientGender": "string",
  "breed": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "clientDOB": "string",
  "dlNumber": "string",
  "clientPhone": "string",
  "clientEmail": "string",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Retrieve Site's Zimbis Patient By Id

Request

Security
bearer
Path
siteZimbisPatientIdnumberrequired
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient/{siteZimbisPatientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of Site's all Zimbis Patients retrieved successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "patientId": "string",
  "fhirId": "string",
  "ehrId": "string",
  "ehrTable": "string",
  "patient": "string",
  "clientId": "string",
  "clientFirstName": "string",
  "clientLastName": "string",
  "dob": "string",
  "permanent": 0,
  "caution": 0,
  "species": "string",
  "gender": "string",
  "weight": 0,
  "weightUnits": "string",
  "height": 0,
  "heightUnits": "string",
  "location": "string",
  "allergies": "string",
  "clientGender": "string",
  "breed": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "clientDOB": "string",
  "dlNumber": "string",
  "clientPhone": "string",
  "clientEmail": "string",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Update an existing Site Zimbis Patient

Request

Security
bearer
Path
siteZimbisPatientIdnumberrequired
Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient/{siteZimbisPatientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 0,
    "patientId": "string",
    "fhirId": "string",
    "ehrId": "string",
    "ehrTable": "string",
    "patient": "string",
    "clientId": "string",
    "clientFirstName": "string",
    "clientLastName": "string",
    "dob": "string",
    "permanent": 0,
    "caution": 0,
    "species": "string",
    "gender": "string",
    "weight": 0,
    "weightUnits": "string",
    "height": 0,
    "heightUnits": "string",
    "location": "string",
    "allergies": "string",
    "clientGender": "string",
    "breed": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "clientDOB": "string",
    "dlNumber": "string",
    "clientPhone": "string",
    "clientEmail": "string",
    "id": 100,
    "createdAt": "2021-08-01T00:00:00.000Z",
    "updatedAt": "2021-08-01T00:00:00.000Z",
    "syncedAt": "2021-08-01T00:00:00.000Z"
  }'

Responses

Site Zimbis Patient updated successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

ehrIdstringrequired

The ID of the record in ehr system

ehrTablestringrequired

The Table name of the record in ehr system

patientstringrequired

Patient name – typically the first and last name of a human patient or the name of an animal patient

clientIdstringrequired

Client identifier – most often used in veterinary environments to identify the owner

clientFirstNamestringrequired

Patient first name in a human care environment, owner first name in a veterinary environment

clientLastNamestringrequired

Patient last name in a human care environment, owner last name in a veterinary environment

dobstringrequired

Patient date of birth

permanentnumberrequired

Flag to say whether patient is permanent or not / 0 = temporary, 1 = permanent

cautionnumberrequired

Most often used in a veterinary environment / 0 = not aggressive, 1 = aggressive

speciesstringrequired

Species

genderstringrequired

M = Male, F = Female, NM = Neutered Male, SF = Spayed Female, U = Unidentified

weightnumberrequired

Patient weight

weightUnitsstringrequired

Patient weight units

heightnumberrequired

Patient height

heightUnitsstringrequired

Patient height units

locationstringrequired

Patient location in the facility, E.g Surgery, Floor / Room / Bed, etc

allergiesstringrequired

Patient allergies

clientGenderstringrequired

Typically used in veterinary environments to satisfy DEA regulations / M = Male, F = Female, U = Unknown

breedstringrequired

Patient breed, typically used in veterinary environments

address1stringrequired

Patient address1 in human environments, owner address1 in veterinary environments

address2stringrequired

Patient address2 in human environments, owner address2 in veterinary environments

citystringrequired

Patient city in human environments, owner city in veterinary environments

statestringrequired

Patient state in human environments, owner state in veterinary environments

zipstringrequired

Patient zip in human environments, owner zip in veterinary environments

countrystringrequired

Patient country in human environments, owner country in veterinary environments

clientDOBstringrequired

Owner DOB in veterinary environments, this is typically used to satisfy DEA regulations

dlNumberstringrequired

Owner Drivers License number in veterinary environments, this is typically used to satisfy DEA regulations / DO NOT use social security number

clientPhonestringrequired

Patient phone in human environments, owner phone in veterinary environments

clientEmailstringrequired

Patient email in human environments, owner email in veterinary environments

idnumberrequired

The ID of the site Zimbis Patient to be updated

Example: 100
createdAtstringrequired

The date and time the data record was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the data record was last updated

Example: "2021-08-01T00:00:00.000Z"
syncedAtstringrequired

The date and time the data record was last synced

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "siteId": 0,
  "patientId": "string",
  "fhirId": "string",
  "ehrId": "string",
  "ehrTable": "string",
  "patient": "string",
  "clientId": "string",
  "clientFirstName": "string",
  "clientLastName": "string",
  "dob": "string",
  "permanent": 0,
  "caution": 0,
  "species": "string",
  "gender": "string",
  "weight": 0,
  "weightUnits": "string",
  "height": 0,
  "heightUnits": "string",
  "location": "string",
  "allergies": "string",
  "clientGender": "string",
  "breed": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "clientDOB": "string",
  "dlNumber": "string",
  "clientPhone": "string",
  "clientEmail": "string",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Delete a Site Zimbis Patient by its ID

Request

Security
bearer
Path
siteZimbisPatientIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient/{siteZimbisPatientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site Zimbis Patient deleted successfully.

Response
No content

Zimbis Patient Profile

Operations