Skip to main content
API docs by Redocly

Clinical (3.0.0)

Billable Records

Manage billable records

Create a billable record

Create a billable record

Request Body schema: application/json
required
patient-uuid
required
string <uuid>
billing-uuid
required
string <uuid>
formulary-uuid
required
string <uuid>
practitioner-uuid
required
string <uuid>
location-uuid
required
string <uuid>
location-space-uuid
string <uuid>
appointment-uuid
string <uuid>
item-date
required
string <date-time>
quantity
required
number > 0
referral-record-uuid
string <uuid>

Reserved for future use

referral-practice-uuid
string <uuid>

Reserved for future use

legal-entity-uuid
string <uuid>

Reserved for future use

insurance-claim-ref
string

Reserved for future use

microchip-number
string or null
batch-number-uuid
string or null <uuid>
composite-uuid
string or null <uuid>

Responses

Response Schema: application/json
object (CreateBillableResponse)

Request samples

Content type
application/json
{
  • "patient-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "billing-uuid": "04FA8A70-CE7C-4539-A6B9-D978FE65E0C2",
  • "formulary-uuid": "171B8547-D663-457B-A989-CDB79156356B",
  • "practitioner-uuid": "D4D6BF98-F8F3-4F6F-8C02-EEF5881ECC57",
  • "location-uuid": "415C31D7-0DA9-4ED9-AA31-819B81A33AA0",
  • "location-space-uuid": "B1167D93-A240-4E7A-9A0E-0B2946DC6910",
  • "appointment-uuid": "23465A2D-C638-4801-AA6A-59AD5602CCD8",
  • "item-date": "2022-06-16T13:45:27Z",
  • "quantity": 2,
  • "referral-record-uuid": "A109DC00-15ED-4AAC-8867-07A5DAD819F5",
  • "referral-practice-uuid": "5582F9D5-AB86-49E5-B180-FEF341E25E73",
  • "legal-entity-uuid": "638A3BD1-F757-4B20-BBCD-BE9D9A53FF22",
  • "insurance-claim-ref": "ABC12345",
  • "microchip-number": "ABC12345",
  • "batch-number-uuid": "A109DC00-15ED-4AAC-8867-07A5DAD819F5",
  • "composite-uuid": "A109DC00-15ED-4AAC-8867-07A5DAD819F5"
}

Response samples

Content type
application/json
{ }

History

Access clinical history

Create a clinical document

Add a record to the clinical history for an uploaded document folder

Request Body schema: application/json
required
patient-uuid
required
string <uuid>
practitioner-uuid
string <uuid>
clinical-description
required
string [ 1 .. 7000 ] characters
item-date
required
string <date-time>
location-uuid
required
string <uuid>
document-folder-uuid
required
string <uuid>
appointment-uuid
string <uuid>
legal-entity-uuid
string <uuid>
insurance-claim-ref
integer <int64>
referral-practice-uuid
string <uuid>
referral-record-uuid
string <uuid>

Responses

Response Schema: application/json
clinical-history-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "patient-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "clinical-description": "Document Created - Frodo.doc",
  • "item-date": "2022-06-16T13:45:27Z",
  • "location-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "document-folder-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "appointment-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "legal-entity-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "insurance-claim-ref": 156000,
  • "referral-practice-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22",
  • "referral-record-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22"
}

Response samples

Content type
application/json
{
  • "clinical-history-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E"
}

Create a clinical external url

Add a clinical external url, external-url-provider and external-url-content-description

Request Body schema: application/json
required
patient-uuid
required
string <uuid>
clinical-date
string <date-time>
location-uuid
required
string <uuid>
description
required
string [ 1 .. 7000 ] characters
external-url
required
string [ 17 .. 4000 ] characters ^https:\/\/?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[...
external-url-provider
required
string [ 1 .. 250 ] characters
external-url-content-description
string [ 1 .. 250 ] characters

Responses

Response Schema: application/json
clinical-note-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "patient-uuid": "CC3A63CC-BBDC-4E62-A66E-3E428A69548E",
  • "clinical-date": "2023-11-07T13:45:27Z",
  • "location-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "description": "Clinical with provider link",
  • "external-url": "https://www.example.com",
  • "external-url-provider": "URL Provider",
  • "external-url-content-description": "Provider link description"
}

Response samples

Content type
application/json
{
  • "clinical-note-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E"
}

Retrieve Clinical History

Retrieve the clinical records from across the practice.

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
patient-uuid
string <uuid>
Example: patient-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
formulary-uuid
string <uuid>
Example: formulary-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
modified-start
string <date-time>
Example: modified-start=2019-06-07T15:50:00.00Z
modified-end
string <date-time>
Example: modified-end=2019-07-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (ClinicalHistory)
Array
clinical-history-uuid
string <uuid>
location-uuid
string <uuid>
patient-uuid
string <uuid>
date
string <date-time>
total-net
number <double>
contact-practitioner-uuid
string <uuid>
formulary-uuid
string <uuid>
quantity
number <double>
batch-uuid
string <uuid>
description
string
modified
string <date-time>
dispense-instruction
string
dispense-additional-information
string
dispense-commence-date
string <date>
dispense-practitioner-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-history-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "date": "2021-08-07T15:50:00.00Z",
      • "total-net": "700.55",
      • "contact-practitioner-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "formulary-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "quantity": 1,
      • "batch-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "description": "Barium meal",
      • "modified": "2021-09-07T15:50:00.00Z",
      • "dispense-instruction": "instruction",
      • "dispense-additional-information": "additional information",
      • "dispense-commence-date": "2024-09-07",
      • "dispense-practitioner-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
      }
    ]
}

Retrieve Deleted Clinical History

Clinical records which have been deleted from the patient clinical history, audit records are not permanent.

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
patient-uuid
string <uuid>
Example: patient-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
formulary-uuid
string <uuid>
Example: formulary-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
deleted-start
string <date-time>
Example: deleted-start=2019-06-07T15:50:00.00Z
deleted-end
string <date-time>
Example: deleted-end=2019-07-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (ClinicalHistory)
Array
clinical-history-uuid
string <uuid>
location-uuid
string <uuid>
patient-uuid
string <uuid>
date
string <date-time>
total-net
number <double>
contact-practitioner-uuid
string <uuid>
formulary-uuid
string <uuid>
quantity
number <double>
batch-uuid
string <uuid>
description
string
modified
string <date-time>
dispense-instruction
string
dispense-additional-information
string
dispense-commence-date
string <date>
dispense-practitioner-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-history-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "patient-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "date": "2021-08-07T15:50:00.00Z",
      • "total-net": "700.55",
      • "contact-practitioner-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "formulary-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "quantity": 1,
      • "batch-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "description": "Barium meal",
      • "modified": "2021-09-07T15:50:00.00Z",
      • "dispense-instruction": "instruction",
      • "dispense-additional-information": "additional information",
      • "dispense-commence-date": "2024-09-07",
      • "dispense-practitioner-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
      }
    ]
}

Retrieve patient formulary summary

Retrieve patient formulary summary

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=E39CF5C7-C94B-496D-9E4A-91AF460DB581
patient-uuid
string <uuid>
Example: patient-uuid=5F918021-B1CA-492D-995C-D96AA5742011
formulary-uuid
string <uuid>
Example: formulary-uuid=E001094A-C052-482B-AFE7-D6DA803BDA18
date-start
string <date-time>
Example: date-start=2022-11-01T00:00:00.00Z
date-end
string <date-time>
Example: date-end=2022-11-08T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (PatientFormularySummary)
Array
patient-uuid
string <uuid>
formulary-uuid
string <uuid>
record-count
integer <int32>
last-record-date
string <date-time>
total-quantity
number
total-net
number
dispensing-fee-net
number

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-uuid": "5821D436-B569-4B02-8BC2-9FEB22AC7EFD",
      • "formulary-uuid": "6DB53840-E8BE-408B-B1B9-C784135F6D97",
      • "record-count": 7,
      • "last-record-date": "2022-11-03T14:26:59Z",
      • "total-quantity": 16.4,
      • "total-net": 7.79,
      • "dispensing-fee-net": 2.63
      }
    ]
}

Create a clinical integration note

Add a comment to clinical history

Request Body schema: application/json
required
patient-uuid
required
string <uuid>
clinical-date
string <date-time>
location-uuid
required
string <uuid>
clinical-description
required
string [ 1 .. 7000 ] characters
practitioner-uuid
string <uuid>

Responses

Response Schema: application/json
clinical-note-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "patient-uuid": "4EAD5B2E-9AE1-433F-9D1B-34851EB7061B",
  • "clinical-date": "2022-06-16T13:45:27Z",
  • "location-uuid": "433DAC06-8A4B-4742-9609-63F74A779350",
  • "clinical-description": "Lab test order placed",
  • "practitioner-uuid": "27AC90DC-953F-4B95-97D4-CAD30E45456E"
}

Response samples

Content type
application/json
{
  • "clinical-note-uuid": "9B9CCF47-4214-4C6C-A41D-AEF5BD659798"
}

Prescription

Access and Manage prescriptions

Retrieve dosage measures

Retrieve the dosage information in prescriptions

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (DosageMeasure)
Array
prescription-measure-uuid
string <uuid>
prescription-measure
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "prescription-measure-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "prescription-measure": "Bottle(s)"
      }
    ]
}

Retrieve label prefixes

Retrieve the prescription instruction prefixes

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (InstructionPrefix)
Array
prescription-instruction-prefix-uuid
string <uuid>
prescription-instruction
string
prescription-instruction-description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "prescription-instruction-prefix-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "prescription-instruction": "Administer",
      • "prescription-instruction-description": "Administer"
      }
    ]
}

Product Prescription

Access and Manage Basic (Product) prescriptions

Retrieve product prescription status

Retrieve state of a basic (product) prescription.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PrescriptionStatus)
Array
prescription-status-id
integer <int32>
prescription-status
string
prescription-status-description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "prescription-status-id": 1,
      • "prescription-status": "OPENED",
      • "prescription-status-description": "OPENED"
      }
    ]
}

Retrieve MWI Pharmacy statuses

Returns the status options of the pharmacy integration for the prescription.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PharmacyStatus)
Array
mwi-pharmacy-status-id
integer <int32>
mwi-pharmacy-status
string
mwi-pharmacy-status-description
string
mwi-pharmacy-status-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "mwi-pharmacy-status-id": 1,
      • "mwi-pharmacy-status": "arrived",
      • "mwi-pharmacy-status-description": "Order Placed",
      • "mwi-pharmacy-status-order": 1
      }
    ]
}

Retrieves the mwi-pharmacy species selection.

Retrieve the mwi-pharmacy species selection.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PharmacySpecies)
Array
mwi-pharmacy-species-uuid
string <uuid>
mwi-pharmacy-species
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "mwi-pharmacy-species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "mwi-pharmacy-species": "Hamster"
      }
    ]
}

Retrieves MWI Pharmacy Cancel Request Status

Returns the pharmacy cancelled request / confirm state for a prescription.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PharmacyCancelStatus)
Array
mwi-pharmacy-cancel-status-id
integer <int32>
mwi-pharmacy-cancel-status
string
mwi-pharmacy-cancel-status-description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "mwi-pharmacy-cancel-status-id": 1,
      • "mwi-pharmacy-cancel-status": "PendingCancel",
      • "mwi-pharmacy-cancel-status-description": "Pending Cancel"
      }
    ]
}

Retrieves product prescriptions.

Returns the prescriptions.

query Parameters
required
object (Pageable)

Pageable parameters

patient-uuid
string <uuid>
Example: patient-uuid=018D012A-E5CE-4391-8D42-8396EF19CE83
prescribing-practitioner-uuid
string <uuid>
Example: prescribing-practitioner-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
dispensing-practitioner-uuid
string <uuid>
Example: dispensing-practitioner-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
formulary-uuid
string <uuid>
Example: formulary-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
prescription-status-id
integer <int32>
Example: prescription-status-id=2
modified-start
string <date-time>
Example: modified-start=2019-06-07T15:50:00.00Z
modified-end
string <date-time>
Example: modified-end=2019-07-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (Prescription)
Array
prescription-uuid
string <uuid>
prescribing-practitioner-uuid
string <uuid>
dispensing-practitioner-uuid
string <uuid>
patient-uuid
string <uuid>
formulary-uuid
string <uuid>
dispensed-clinical-history-uuid
string <uuid>
dispensed-in-draft
boolean
dispensed-in-estimate
boolean
dispense-as-whole-pack
boolean
prescription-status-id
integer <int32>
prescription-prescribed-date
string <date-time>
prescription-valid-until-date
string <date-time>
prescription-start-date
string <date-time>
prescription-dispensed-date
string <date-time>
prescription-instruction-prefix-uuid
string <uuid>
prescription-dosage
number
prescription-frequency
integer <int32>
prescription-frequency-measure
string
prescription-duration
integer <int32>
prescription-duration-measure
string
prescription-quantity-total
number
prescription-total-in-sequence
integer <int32>
prescription-position-in-sequence
integer <int32>
mwi-pharmacy-status-id
integer <int32>
mwi-pharmacy-cancel-status-id
integer <int32>
mwi-pharmacy-delivery-address-uuid
string <uuid>
mwi-pharmacy-species-uuid
string <uuid>
modified-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "prescription-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "prescribing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "patient-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "formulary-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-clinical-history-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-in-draft": "true",
      • "dispensed-in-estimate": "true",
      • "dispense-as-whole-pack": "true",
      • "prescription-status-id": 1,
      • "prescription-prescribed-date": "2022-06-16T13:45:27Z",
      • "prescription-valid-until-date": "2022-06-16T13:45:27Z",
      • "prescription-start-date": "2022-06-16T13:45:27Z",
      • "prescription-dispensed-date": "2022-06-16T13:45:27Z",
      • "prescription-instruction-prefix-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "prescription-dosage": "1.5",
      • "prescription-frequency": 1,
      • "prescription-frequency-measure": "Hour(s)",
      • "prescription-duration": 5,
      • "prescription-duration-measure": "Day(s)",
      • "prescription-quantity-total": "1.5",
      • "prescription-total-in-sequence": 5,
      • "prescription-position-in-sequence": 3,
      • "mwi-pharmacy-status-id": 3,
      • "mwi-pharmacy-cancel-status-id": 3,
      • "mwi-pharmacy-delivery-address-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "mwi-pharmacy-species-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "modified-date": "2022-06-16T13:45:27Z"
      }
    ]
}

Retrieves deleted product prescriptions.

Returns the deleted prescriptions.

query Parameters
required
object (Pageable)

Pageable parameters

patient-uuid
string <uuid>
Example: patient-uuid=018D012A-E5CE-4391-8D42-8396EF19CE83
deleted-start
string <date-time>
Example: deleted-start=2019-06-07T15:50:00.00Z
deleted-end
string <date-time>
Example: deleted-end=2019-07-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (Prescription)
Array
prescription-uuid
string <uuid>
prescribing-practitioner-uuid
string <uuid>
dispensing-practitioner-uuid
string <uuid>
patient-uuid
string <uuid>
formulary-uuid
string <uuid>
dispensed-clinical-history-uuid
string <uuid>
dispensed-in-draft
boolean
dispensed-in-estimate
boolean
dispense-as-whole-pack
boolean
prescription-status-id
integer <int32>
prescription-prescribed-date
string <date-time>
prescription-valid-until-date
string <date-time>
prescription-start-date
string <date-time>
prescription-dispensed-date
string <date-time>
prescription-instruction-prefix-uuid
string <uuid>
prescription-dosage
number
prescription-frequency
integer <int32>
prescription-frequency-measure
string
prescription-duration
integer <int32>
prescription-duration-measure
string
prescription-quantity-total
number
prescription-total-in-sequence
integer <int32>
prescription-position-in-sequence
integer <int32>
mwi-pharmacy-status-id
integer <int32>
mwi-pharmacy-cancel-status-id
integer <int32>
mwi-pharmacy-delivery-address-uuid
string <uuid>
mwi-pharmacy-species-uuid
string <uuid>
modified-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "prescription-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "prescribing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "patient-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "formulary-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-clinical-history-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-in-draft": "true",
      • "dispensed-in-estimate": "true",
      • "dispense-as-whole-pack": "true",
      • "prescription-status-id": 1,
      • "prescription-prescribed-date": "2022-06-16T13:45:27Z",
      • "prescription-valid-until-date": "2022-06-16T13:45:27Z",
      • "prescription-start-date": "2022-06-16T13:45:27Z",
      • "prescription-dispensed-date": "2022-06-16T13:45:27Z",
      • "prescription-instruction-prefix-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "prescription-dosage": "1.5",
      • "prescription-frequency": 1,
      • "prescription-frequency-measure": "Hour(s)",
      • "prescription-duration": 5,
      • "prescription-duration-measure": "Day(s)",
      • "prescription-quantity-total": "1.5",
      • "prescription-total-in-sequence": 5,
      • "prescription-position-in-sequence": 3,
      • "mwi-pharmacy-status-id": 3,
      • "mwi-pharmacy-cancel-status-id": 3,
      • "mwi-pharmacy-delivery-address-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "mwi-pharmacy-species-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "modified-date": "2022-06-16T13:45:27Z"
      }
    ]
}

Retrieves a product prescription

Returns the prescription by uuid.

path Parameters
prescription-uuid
required
string <uuid>
Example: d64adecb-131e-4d4a-a262-1f6bf07583b1

Responses

Response Schema: application/json
prescription-uuid
string <uuid>
prescribing-practitioner-uuid
string <uuid>
dispensing-practitioner-uuid
string <uuid>
patient-uuid
string <uuid>
formulary-uuid
string <uuid>
dispensed-clinical-history-uuid
string <uuid>
dispensed-in-draft
boolean
dispensed-in-estimate
boolean
dispense-as-whole-pack
boolean
prescription-status-id
integer <int32>
prescription-prescribed-date
string <date-time>
prescription-valid-until-date
string <date-time>
prescription-start-date
string <date-time>
prescription-dispensed-date
string <date-time>
prescription-instruction-prefix-uuid
string <uuid>
prescription-dosage
number
prescription-frequency
integer <int32>
prescription-frequency-measure
string
prescription-duration
integer <int32>
prescription-duration-measure
string
prescription-quantity-total
number
prescription-total-in-sequence
integer <int32>
prescription-position-in-sequence
integer <int32>
mwi-pharmacy-status-id
integer <int32>
mwi-pharmacy-cancel-status-id
integer <int32>
mwi-pharmacy-delivery-address-uuid
string <uuid>
mwi-pharmacy-species-uuid
string <uuid>
modified-date
string <date-time>

Response samples

Content type
application/json
{
  • "prescription-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "prescribing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "dispensing-practitioner-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "patient-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "formulary-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "dispensed-clinical-history-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "dispensed-in-draft": "true",
  • "dispensed-in-estimate": "true",
  • "dispense-as-whole-pack": "true",
  • "prescription-status-id": 1,
  • "prescription-prescribed-date": "2022-06-16T13:45:27Z",
  • "prescription-valid-until-date": "2022-06-16T13:45:27Z",
  • "prescription-start-date": "2022-06-16T13:45:27Z",
  • "prescription-dispensed-date": "2022-06-16T13:45:27Z",
  • "prescription-instruction-prefix-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "prescription-dosage": "1.5",
  • "prescription-frequency": 1,
  • "prescription-frequency-measure": "Hour(s)",
  • "prescription-duration": 5,
  • "prescription-duration-measure": "Day(s)",
  • "prescription-quantity-total": "1.5",
  • "prescription-total-in-sequence": 5,
  • "prescription-position-in-sequence": 3,
  • "mwi-pharmacy-status-id": 3,
  • "mwi-pharmacy-cancel-status-id": 3,
  • "mwi-pharmacy-delivery-address-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "mwi-pharmacy-species-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "modified-date": "2022-06-16T13:45:27Z"
}

Vital Metric

Access and Manage the Vital Metric data

Retrieve Weights

Retrieve a list of weight vital metrics

query Parameters
required
object (Pageable)

Pageable parameters

patient-uuid
string <uuid>
Example: patient-uuid=9182CDF5-C5EE-4FC3-A196-98012B3741C0
date-weighed-start
string <date-time>
Example: date-weighed-start=2021-12-01T00:00:00.00Z
date-weighed-end
string <date-time>
Example: date-weighed-end=2021-12-02T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (VitalMetricsWeight)
Array
weight-uuid
string <uuid>
patient-uuid
string <uuid>
date-weighed
string <date-time>
weight-kg
number

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "weight-uuid": "095A86E6-8C91-405F-8FBB-48D835EE9F85",
      • "patient-uuid": "D1C59922-3FBC-421E-9C30-3D261A787768",
      • "date-weighed": "2021-12-08T14:45:00Z",
      • "weight-kg": 15.5
      }
    ]
}

Create Weight

Create vital metric weight

Request Body schema: application/json
required
patient-uuid
required
string <uuid>
location-uuid
required
string <uuid>
practitioner-uuid
required
string <uuid>
clinical-code-uuid
string <uuid>
weight-kg
required
number ( 0 .. 99999.99999999 ]
date-recorded
string <date-time>

If no date is provided the current date will be assumed

Responses

Response Schema: application/json
weight-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "patient-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "location-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "practitioner-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "clinical-code-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "weight-kg": 5.555,
  • "date-recorded": "2022-06-16T13:45:27Z"
}

Response samples

Content type
application/json
{
  • "weight-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB"
}

Delete weight

Delete vital metric weight

path Parameters
weight-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
weight-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "weight-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB"
}

Ingredient Prescription

Access and Manage Prescription Ingredients

Query for Advanced Prescriptions

Returns a list of matching Advanced Prescriptions.

query Parameters
required
object (Pageable)

Pageable parameters

patient-uuid
string <uuid>
Example: patient-uuid=faa5b9e2-8156-4aa2-9c78-f36291b0b27c
prescribing-practitioner-uuid
string <uuid>
Example: prescribing-practitioner-uuid=7391aa44-292c-4ae4-93e1-12ceecd8d2eb
primary-formulary-uuid
string <uuid>
Example: primary-formulary-uuid=21be53f2-ded5-44a5-876b-c0d220c549cb
prescription-status
string (AdvancedPrescriptionStatus)
Enum: "ACTIVE" "SUSPENDED" "EXPIRED"
Example: prescription-status=SUSPENDED

Responses

Response Schema: application/json
Array of objects (AdvancedPrescription)
Array
adv-prescription-uuid
string <uuid>
alternative-to-adv-prescription-uuid
string <uuid>
patient-uuid
string <uuid>
prescribed-text
string <= 500 characters
dosage-text
string <= 500 characters
issued-on
string <date-time>
expires-on
string <date-time>
prescription-length
integer <int32> [ 0 .. 32767 ]
prescription-length-measure
string <= 10 characters
prescribing-practitioner
string <= 100 characters
prescribing-practitioner-uuid
string <uuid>
practitioner-qualification
string <= 50 characters
practitioner-licence-number
string <= 100 characters
primary-formulary-uuid
string <uuid>
system-generated-instruction
boolean
label-instruction
string <= 350 characters
entered-prescription-instruction-prefix-uuid
string <uuid>
entered-dosage
number [ 0 .. 9999.99 ]
entered-dosage-measure-uuid
string <uuid>
entered-frequency
integer <int32> [ 0 .. 32767 ]
entered-frequency-measure
string <= 10 characters
entered-length
integer <int32> [ 0 .. 32767 ]
entered-length-measure
string <= 10 characters
prescription-status
string (AdvancedPrescriptionStatus)
Enum: "ACTIVE" "SUSPENDED" "EXPIRED"
suspended-on
string <date-time>
suspended-by
string <= 100 characters
suspend-reason-uuid
string <uuid>
suspended-reason
string <= 100 characters
location-uuid
string <uuid>
modified-date
string <date-time>
booked-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "adv-prescription-uuid": "941e6f9a-767c-11ef-b25c-c7ff7f59eb77",
      • "alternative-to-adv-prescription-uuid": "64cc8a40-767e-11ef-92bc-b779c88795c7",
      • "patient-uuid": "70f30e8e-767e-11ef-954d-63e8bfb58a87",
      • "prescribed-text": "Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg",
      • "dosage-text": "Give Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg every 3 Month(s)",
      • "issued-on": "2022-11-03T14:26:59Z",
      • "expires-on": "2022-11-03T14:26:59Z",
      • "prescription-length": 32767,
      • "prescription-length-measure": "Month(s)",
      • "prescribing-practitioner": "Sarah Barnard",
      • "prescribing-practitioner-uuid": "8059f5f4-767e-11ef-b2db-9f5b3c852ebd",
      • "practitioner-qualification": "BSc (Hons) MRCVS",
      • "practitioner-licence-number": "684532",
      • "primary-formulary-uuid": "8d6e91dc-767e-11ef-a687-0be68349eca4",
      • "system-generated-instruction": true,
      • "label-instruction": "Give Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg every 3 Month(s)",
      • "entered-prescription-instruction-prefix-uuid": "98343824-767e-11ef-8196-4f84ce84b313",
      • "entered-dosage": 1235.53,
      • "entered-dosage-measure-uuid": "a656e244-767e-11ef-8a56-7f043f612900",
      • "entered-frequency": 32767,
      • "entered-frequency-measure": "Month(s)",
      • "entered-length": 32767,
      • "entered-length-measure": "Month(s)",
      • "prescription-status": "SUSPENDED",
      • "suspended-on": "2021-09-07T15:50:00.00Z",
      • "suspended-by": "Dr. John Doe",
      • "suspend-reason-uuid": "b333b424-767e-11ef-9583-e3cc1676dc7e",
      • "suspended-reason": "Discontinued due to high blood pressure",
      • "location-uuid": "bca71726-767e-11ef-b8dc-6fdb40a62668",
      • "modified-date": "2021-09-07T15:50:00.00Z",
      • "booked-date": "2021-09-07T15:50:00.00Z"
      }
    ]
}

Retrieve an Advanced Prescription

Returns the Advanced Prescription by UUID.

path Parameters
adv-prescription-uuid
required
string <uuid>
Example: 83206c89-be1a-4039-b40b-494ada32643c

Responses

Response Schema: application/json
adv-prescription-uuid
string <uuid>
alternative-to-adv-prescription-uuid
string <uuid>
patient-uuid
string <uuid>
prescribed-text
string <= 500 characters
dosage-text
string <= 500 characters
issued-on
string <date-time>
expires-on
string <date-time>
prescription-length
integer <int32> [ 0 .. 32767 ]
prescription-length-measure
string <= 10 characters
prescribing-practitioner
string <= 100 characters
prescribing-practitioner-uuid
string <uuid>
practitioner-qualification
string <= 50 characters
practitioner-licence-number
string <= 100 characters
primary-formulary-uuid
string <uuid>
system-generated-instruction
boolean
label-instruction
string <= 350 characters
entered-prescription-instruction-prefix-uuid
string <uuid>
entered-dosage
number [ 0 .. 9999.99 ]
entered-dosage-measure-uuid
string <uuid>
entered-frequency
integer <int32> [ 0 .. 32767 ]
entered-frequency-measure
string <= 10 characters
entered-length
integer <int32> [ 0 .. 32767 ]
entered-length-measure
string <= 10 characters
prescription-status
string (AdvancedPrescriptionStatus)
Enum: "ACTIVE" "SUSPENDED" "EXPIRED"
suspended-on
string <date-time>
suspended-by
string <= 100 characters
suspend-reason-uuid
string <uuid>
suspended-reason
string <= 100 characters
location-uuid
string <uuid>
modified-date
string <date-time>
booked-date
string <date-time>

Response samples

Content type
application/json
{
  • "adv-prescription-uuid": "941e6f9a-767c-11ef-b25c-c7ff7f59eb77",
  • "alternative-to-adv-prescription-uuid": "64cc8a40-767e-11ef-92bc-b779c88795c7",
  • "patient-uuid": "70f30e8e-767e-11ef-954d-63e8bfb58a87",
  • "prescribed-text": "Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg",
  • "dosage-text": "Give Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg every 3 Month(s)",
  • "issued-on": "2022-11-03T14:26:59Z",
  • "expires-on": "2022-11-03T14:26:59Z",
  • "prescription-length": 32767,
  • "prescription-length-measure": "Month(s)",
  • "prescribing-practitioner": "Sarah Barnard",
  • "prescribing-practitioner-uuid": "8059f5f4-767e-11ef-b2db-9f5b3c852ebd",
  • "practitioner-qualification": "BSc (Hons) MRCVS",
  • "practitioner-licence-number": "684532",
  • "primary-formulary-uuid": "8d6e91dc-767e-11ef-a687-0be68349eca4",
  • "system-generated-instruction": true,
  • "label-instruction": "Give Moxidectin 0.24mg, Pyrantel 50.00mg, Sarolaner 12.00mg every 3 Month(s)",
  • "entered-prescription-instruction-prefix-uuid": "98343824-767e-11ef-8196-4f84ce84b313",
  • "entered-dosage": 1235.53,
  • "entered-dosage-measure-uuid": "a656e244-767e-11ef-8a56-7f043f612900",
  • "entered-frequency": 32767,
  • "entered-frequency-measure": "Month(s)",
  • "entered-length": 32767,
  • "entered-length-measure": "Month(s)",
  • "prescription-status": "SUSPENDED",
  • "suspended-on": "2021-09-07T15:50:00.00Z",
  • "suspended-by": "Dr. John Doe",
  • "suspend-reason-uuid": "b333b424-767e-11ef-9583-e3cc1676dc7e",
  • "suspended-reason": "Discontinued due to high blood pressure",
  • "location-uuid": "bca71726-767e-11ef-b8dc-6fdb40a62668",
  • "modified-date": "2021-09-07T15:50:00.00Z",
  • "booked-date": "2021-09-07T15:50:00.00Z"
}

Retrieve suspend reasons

Retrieve the suspend reasons for advanced prescriptions

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (SuspendReason)
Array
suspend-reason-uuid
string <uuid>
suspend-reason
string
deactivated
boolean
modified-date
string <date-time>
created-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "suspend-reason-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "suspend-reason": "Adverse Reaction",
      • "deactivated": "true",
      • "modified-date": "2024-07-16T13:45:27Z",
      • "created-date": "2024-06-16T13:45:27Z"
      }
    ]
}

Retrieves a suspend reason

Returns the suspend reason by uuid.

path Parameters
suspend-reason-uuid
required
string <uuid>
Example: ED919742-256A-4331-A1E8-9B7E0389BC8D

Responses

Response Schema: application/json
suspend-reason-uuid
string <uuid>
suspend-reason
string
deactivated
boolean
modified-date
string <date-time>
created-date
string <date-time>

Response samples

Content type
application/json
{
  • "suspend-reason-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "suspend-reason": "Adverse Reaction",
  • "deactivated": "true",
  • "modified-date": "2024-07-16T13:45:27Z",
  • "created-date": "2024-06-16T13:45:27Z"
}

Get advanced prescription actions

Get a list of advanced prescription action records by date and time boundary.

query Parameters
required
object (Pageable)

Pageable parameters

created-start-date
required
string <date-time>
Example: created-start-date=2019-06-07T15:50:00.00Z
created-end-date
required
string <date-time>
Example: created-end-date=2019-06-07T15:50:00.00Z
modified-start-date
required
string <date-time>
Example: modified-start-date=2019-06-07T15:50:00.00Z
modified-end-date
required
string <date-time>
Example: modified-end-date=2019-06-07T15:50:00.00Z

Responses

Response Schema: application/json
Array of objects (AdvancedPrescriptionAction)
Array
adv-prescription-uuid
string <uuid>
dispensed-formulary-uuid
string <uuid>
unsaved-action
boolean
clinical-history-uuid
string <uuid>
clinical-notes-uuid
string <uuid>
action-type
string
authorised-by
string
modified-date
string <date-time>
created-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "adv-prescription-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-formulary-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "unsaved-action": true,
      • "clinical-history-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-notes-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22",
      • "action-type": "WRITTEN",
      • "authorised-by": "Katie Meredith",
      • "modified-date": "2022-06-16T13:45:27Z",
      • "created-date": "2022-06-16T13:45:27Z"
      }
    ]
}

Advanced Prescription Actions by Advanced Prescription UUID

Get a Pageable list of Advanced Prescription Actions list via the UUID of the Advanced Prescription.

path Parameters
adv-prescription-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (AdvancedPrescriptionAction)
Array
adv-prescription-uuid
string <uuid>
dispensed-formulary-uuid
string <uuid>
unsaved-action
boolean
clinical-history-uuid
string <uuid>
clinical-notes-uuid
string <uuid>
action-type
string
authorised-by
string
modified-date
string <date-time>
created-date
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "adv-prescription-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "dispensed-formulary-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "unsaved-action": true,
      • "clinical-history-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-notes-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22",
      • "action-type": "WRITTEN",
      • "authorised-by": "Katie Meredith",
      • "modified-date": "2022-06-16T13:45:27Z",
      • "created-date": "2022-06-16T13:45:27Z"
      }
    ]
}

Answers

Access and Manage Answers

Retrieve Answers

Retrieve a list answer objects

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Answer)
Array
clinical-answer-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-answer-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "string",
      • "description": "string"
      }
    ]
}

Retrieve Answers

Retrieve a list of answer objects

path Parameters
clinical-question-uuid
required
string <uuid>
Example: ED919742-256A-4331-A1E8-9B7E0389BC8D
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (QuestionAnswer)
Array
clinical-question-answer-uuid
string <uuid>
clinical-answer-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-question-answer-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-answer-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "string",
      • "description": "string"
      }
    ]
}

Retrieve Questions and Answers identifiers

Retrieve a list of question and answer objects

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (QuestionAnswerIdentifiers)
Array
clinical-question-answer-uuid
string <uuid>
clinical-question-uuid
string <uuid>
clinical-answer-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-question-answer-uuid": "D93A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-question-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-answer-uuid": "I93A63CA-BBDC-4E62-A66E-3E428A69548E"
      }
    ]
}

Categories

Access and Manage Categories

Retrieve Clinical Categories

Retrieve categories

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
Example: active=true

Responses

Response Schema: application/json
Array of objects (Category)
Array
clinical-note-category-uuid
string <uuid>
name
string
description
string
multiple-consult
boolean
view-order
integer <int32>
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-note-category-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "Name",
      • "description": "description",
      • "multiple-consult": true,
      • "view-order": 1,
      • "active": true
      }
    ]
}

Retrieve Clinical Code Categories

Retrieve code categories

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (ClinicalCodeCategory)
Array
clinical-code-category-uuid
string <uuid>
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-code-category-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "description": "description"
      }
    ]
}

Clinical Codes

Access and Manage Clinical Codes

Retrieve Clinical Codes

Retrieve clinical codes

path Parameters
clinical-code-category-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
Example: active=true

Responses

Response Schema: application/json
Array of objects (ClinicalCode)
Array
clinical-code-uuid
string <uuid>
name
string
description
string
clinical-code-category-uuid
string <uuid>
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-code-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "Dental",
      • "description": "Dental",
      • "clinical-code-category-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22",
      • "active": true
      }
    ]
}

Retrieve Clinical Codes

Retrieve clinical codes

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
Example: active=true

Responses

Response Schema: application/json
Array of objects (ClinicalCode)
Array
clinical-code-uuid
string <uuid>
name
string
description
string
clinical-code-category-uuid
string <uuid>
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-code-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "Dental",
      • "description": "Dental",
      • "clinical-code-category-uuid": "7C53C6C7-A9AB-462F-B5A5-33E0FAC31D22",
      • "active": true
      }
    ]
}

Clinical Notes

Access and Manage Clinical Notes

Create Clinical Note

Create clinical note

Request Body schema: application/json
required
protocol-uuid
required
string <uuid>
patient-uuid
required
string <uuid>
practitioner-uuid
required
string <uuid>
billing-uuid
required
string <uuid>
clinical-date
required
string <date-time>

If no date is provided the current date will be assumed

location-uuid
required
string <uuid>
appointment-uuid
string <uuid>
Array of objects (ClinicalNoteResponsesRequest)

Responses

Response Schema: application/json
Array of objects (CreateClinicalNoteResult)
Array
clinical-note-uuid
string <uuid>
protocol-question-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "protocol-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "patient-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "practitioner-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "billing-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "clinical-date": "2022-06-16T13:45:27Z",
  • "location-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "appointment-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
  • "responses": [
    • {
      • "clinical-protocol-question-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
      • "answer-free-text": "string",
      • "answer-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705",
      • "clinical-code-uuid": "B02252FD-3889-45BE-8664-A5671B3D2705"
      }
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-note-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB",
      • "protocol-question-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB"
      }
    ]
}

Protocols

Access and Manage Protocols

Retrieve Clinical Protocols

Retrieve protocols

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
Example: active=true

Responses

Response Schema: application/json
Array of objects (Protocol)
Array
clinical-protocol-uuid
string <uuid>
clinical-category-uuid
string <uuid>
name
string
description
string
date-created
string <date-time>
user-created
string
active
boolean
change-status
string
Enum: "Live" "Draft" "Withdrawn"

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-protocol-uuid": "D93A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-category-uuid": "CC3A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "name": "Name",
      • "description": "description",
      • "date-created": "2022-06-16T13:45:27Z",
      • "user-created": "Joe Doe",
      • "active": true,
      • "change-status": "Live"
      }
    ]
}

Questions

Access and Manage Questions

Retrieve Clinical Protocol Questions

Retrieve protocol questions

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (ProtocolQuestion)
Array
clinical-protocol-question-uuid
string <uuid>
clinical-protocol-uuid
string <uuid>
clinical-question-uuid
string <uuid>
view-order
integer <int32>
answer-allow-free-text
boolean
answer-allow-clinical-codes
boolean
clinical-code-category-uuid
string <uuid>
answer-mandatory
boolean
answer-mandatory-clinical-code
boolean
answer-mandatory-free-text
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-protocol-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-protocol-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "view-order": 1,
      • "answer-allow-free-text": true,
      • "answer-allow-clinical-codes": true,
      • "clinical-code-category-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "answer-mandatory": true,
      • "answer-mandatory-clinical-code": true,
      • "answer-mandatory-free-text": true
      }
    ]
}

Retrieve Clinical Protocol Questions

Retrieve protocol questions

path Parameters
protocol-uuid
required
string <uuid>
Example: ED919742-256A-4331-A1E8-9B7E0389BC8D
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (ProtocolQuestion)
Array
clinical-protocol-question-uuid
string <uuid>
clinical-protocol-uuid
string <uuid>
clinical-question-uuid
string <uuid>
view-order
integer <int32>
answer-allow-free-text
boolean
answer-allow-clinical-codes
boolean
clinical-code-category-uuid
string <uuid>
answer-mandatory
boolean
answer-mandatory-clinical-code
boolean
answer-mandatory-free-text
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-protocol-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-protocol-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "clinical-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "view-order": 1,
      • "answer-allow-free-text": true,
      • "answer-allow-clinical-codes": true,
      • "clinical-code-category-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "answer-mandatory": true,
      • "answer-mandatory-clinical-code": true,
      • "answer-mandatory-free-text": true
      }
    ]
}

Retrieve Questions

Retrieve question list

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
Example: active=true
protocol-uuid
string <uuid>
Example: protocol-uuid=ED919742-256A-4331-A1E8-9B7E0389BC8D

Responses

Response Schema: application/json
Array of objects (Question)
Array
clinical-question-uuid
string <uuid>
description
string
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "clinical-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
      • "description": "string",
      • "active": true
      }
    ]
}

Retrieve Question

Retrieve a question object

path Parameters
clinical-question-uuid
required
string <uuid>
Example: ED919742-256A-4331-A1E8-9B7E0389BC8D

Responses

Response Schema: application/json
clinical-question-uuid
string <uuid>
description
string
active
boolean

Response samples

Content type
application/json
{
  • "clinical-question-uuid": "F63A63CA-BBDC-4E62-A66E-3E428A69548E",
  • "description": "string",
  • "active": true
}