Skip to content

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 for zimbis patients.

Operations

Zimbis Patient Profile

Operations for zimbis patient profiles.

Operations

Retrieve all site zimbis patient profiles

Request

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

Responses

List of Sites all Zimbis Patient Profiles retrieved successfully.

Bodyapplication/jsonArray [
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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": 1.23,
    "patientId": "123e4567-e89b-12d3-a456-426614174000",
    "fhirId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrTable": "Example Name",
    "zimbisPatientId": 1.23,
    "profileId": "123e4567-e89b-12d3-a456-426614174000",
    "newDiscontinued": 1.23,
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "description1": "Example Name",
    "description2": "Example description",
    "profileQTYReq": 1.23,
    "issueDAU": "example",
    "occurrences": 1.23,
    "giveStrength": 1.23,
    "giveStrengthUnit": "example",
    "chargeCode": "CODE-001",
    "schedule": "Example Name",
    "endDate": "example",
    "bid": "example",
    "instructions": "example",
    "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 profile

Request

Security
bearer
Path
siteIdnumberrequired
siteZimbisPatientIdnumberrequired
Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/zimbis/openapi/site/{siteId}/zimbis/patient/{siteZimbisPatientId}/profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 1.23,
    "patientId": "123e4567-e89b-12d3-a456-426614174000",
    "fhirId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrTable": "Example Name",
    "zimbisPatientId": 1.23,
    "profileId": "123e4567-e89b-12d3-a456-426614174000",
    "newDiscontinued": 1.23,
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "description1": "Example Name",
    "description2": "Example description",
    "profileQTYReq": 1.23,
    "issueDAU": "example",
    "occurrences": 1.23,
    "giveStrength": 1.23,
    "giveStrengthUnit": "example",
    "chargeCode": "CODE-001",
    "schedule": "Example Name",
    "endDate": "example",
    "bid": "example",
    "instructions": "example"
  }'

Responses

Site Zimbis Patient Profile created successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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": 1.23,
  "patientId": "123e4567-e89b-12d3-a456-426614174000",
  "fhirId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrTable": "Example Name",
  "zimbisPatientId": 1.23,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "newDiscontinued": 1.23,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "description1": "Example Name",
  "description2": "Example description",
  "profileQTYReq": 1.23,
  "issueDAU": "example",
  "occurrences": 1.23,
  "giveStrength": 1.23,
  "giveStrengthUnit": "example",
  "chargeCode": "CODE-001",
  "schedule": "Example Name",
  "endDate": "example",
  "bid": "example",
  "instructions": "example",
  "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 zimbis patient profile by FHIR ID

Request

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

Responses

Site Zimbis Patient Profile retrieved successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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": 1.23,
  "patientId": "123e4567-e89b-12d3-a456-426614174000",
  "fhirId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrTable": "Example Name",
  "zimbisPatientId": 1.23,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "newDiscontinued": 1.23,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "description1": "Example Name",
  "description2": "Example description",
  "profileQTYReq": 1.23,
  "issueDAU": "example",
  "occurrences": 1.23,
  "giveStrength": 1.23,
  "giveStrengthUnit": "example",
  "chargeCode": "CODE-001",
  "schedule": "Example Name",
  "endDate": "example",
  "bid": "example",
  "instructions": "example",
  "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 zimbis patient profile by id

Request

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

Responses

List of Site's all Zimbis Patient Profiles retrieved successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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": 1.23,
  "patientId": "123e4567-e89b-12d3-a456-426614174000",
  "fhirId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrTable": "Example Name",
  "zimbisPatientId": 1.23,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "newDiscontinued": 1.23,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "description1": "Example Name",
  "description2": "Example description",
  "profileQTYReq": 1.23,
  "issueDAU": "example",
  "occurrences": 1.23,
  "giveStrength": 1.23,
  "giveStrengthUnit": "example",
  "chargeCode": "CODE-001",
  "schedule": "Example Name",
  "endDate": "example",
  "bid": "example",
  "instructions": "example",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Update site zimbis patient profile

Request

Security
bearer
Path
siteIdnumberrequired
siteZimbisPatientIdnumberrequired
siteZimbisPatientProfileIdnumberrequired
Bodyapplication/jsonrequired
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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}/profile/{siteZimbisPatientProfileId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 1.23,
    "patientId": "123e4567-e89b-12d3-a456-426614174000",
    "fhirId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrId": "123e4567-e89b-12d3-a456-426614174000",
    "ehrTable": "Example Name",
    "zimbisPatientId": 1.23,
    "profileId": "123e4567-e89b-12d3-a456-426614174000",
    "newDiscontinued": 1.23,
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "description1": "Example Name",
    "description2": "Example description",
    "profileQTYReq": 1.23,
    "issueDAU": "example",
    "occurrences": 1.23,
    "giveStrength": 1.23,
    "giveStrengthUnit": "example",
    "chargeCode": "CODE-001",
    "schedule": "Example Name",
    "endDate": "example",
    "bid": "example",
    "instructions": "example",
    "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 Profile updated successfully.

Bodyapplication/json
siteIdnumberrequired

The ID of the site associated with this Patient

Example: 1.23
patientIdstringrequired

Patient identifier - the Account ID in 3rd party system

Example: "123e4567-e89b-12d3-a456-426614174000"
fhirIdstringrequired

The ID of the FHIR Patient associated with this patient

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrIdstringrequired

The ID of the record in ehr system

Example: "123e4567-e89b-12d3-a456-426614174000"
ehrTablestringrequired

The Table name of the record in ehr system

Example: "Example Name"
zimbisPatientIdnumberrequired

The id of the related zimbis patient table record

Example: 1.23
profileIdstringrequired

Profile identifier/medication order number

Example: "123e4567-e89b-12d3-a456-426614174000"
newDiscontinuednumberrequired

0 = New, new profiles are ready to be dispensed to a patient - 1 = Discontinued, discontinued profiles will appear at the cabinet to be dispensed to a patient

Example: 1.23
itemIdstringrequired

Unique identifier for the item to be dispensed, typically provided by the practice management software

Example: "123e4567-e89b-12d3-a456-426614174000"
description1stringrequired

Description of the drug or supply to be dispensed, this is typically the brand name of the drug

Example: "Example Name"
description2stringrequired

Second description of the drug or supply to be dispensed this is typically a generic equivalent of the drug

Example: "Example description"
profileQTYReqnumberrequired

The quantity of the drug or supply to be dispensed at each occurrence, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, this value would be 1

Example: 1.23
issueDAUstringrequired

The unit to be issued, e.g. Each

Example: "example"
occurrencesnumberrequired

The number of times the drug or supply is to be accessed for a patient before the profile is inactive

Example: 1.23
giveStrengthnumberrequired

The strength of the drug or supply to be dispensed, e.g. if a profile specified 1 2mg tablet of Valium to be dispensed 3 times, the GiveStrength would be 2

Example: 1.23
giveStrengthUnitstringrequired

The unit to be dispensed, e.g. mg or cc

Example: "example"
chargeCodestringrequired

Charge code

Example: "CODE-001"
schedulestringrequired

The date and time the drug or supply will be available to be given to the patient, this must be in the time zone of the dispensing cabinet

Example: "Example Name"
endDatestringrequired

The date and time the drug or supply will be discontinued, this must be in the time zone of the dispensing cabinet, when left blank the system will default to the Schedule date and time + 100 years

Example: "example"
bidstringrequired

Dispensing instructions in abbreviations

Example: "example"
instructionsstringrequired

Freeform field to capture any extra information about the drug to be dispensed or the manner in which it is to be dispensed

Example: "example"
idnumberrequired

The ID of the site Zimbis Patient Profile 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": 1.23,
  "patientId": "123e4567-e89b-12d3-a456-426614174000",
  "fhirId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrId": "123e4567-e89b-12d3-a456-426614174000",
  "ehrTable": "Example Name",
  "zimbisPatientId": 1.23,
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "newDiscontinued": 1.23,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "description1": "Example Name",
  "description2": "Example description",
  "profileQTYReq": 1.23,
  "issueDAU": "example",
  "occurrences": 1.23,
  "giveStrength": 1.23,
  "giveStrengthUnit": "example",
  "chargeCode": "CODE-001",
  "schedule": "Example Name",
  "endDate": "example",
  "bid": "example",
  "instructions": "example",
  "id": 100,
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z",
  "syncedAt": "2021-08-01T00:00:00.000Z"
}

Delete site zimbis patient profile

Request

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

Responses

Site Zimbis Patient deleted successfully.

Response
No content