Skip to main content
API docs by Redocly

Formulary Management (3.0.0)

Stock

Access and Manage Stock related formulary

Retrieve Stock Configurations

Retrieve a list of stock objects

query Parameters
required
object (Pageable)

Pageable parameters

modified-start
string <date-time>
Example: modified-start=2019-09-07T15:50:00.00Z
modified-end
string <date-time>
Example: modified-end=2019-09-07T15:50:00.00Z
include-archived
boolean
request-repeat-prescription
boolean
formulary-type-uuid
string <uuid>
Example: formulary-type-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
treatment-category-uuid
string <uuid>
Example: treatment-category-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
legal-category-uuid
string <uuid>
Example: legal-category-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
formulary-group-uuid
string <uuid>
Example: formulary-group-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
healthplan-group-uuid
string <uuid>
Example: healthplan-group-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
location-uuid
string <uuid>
Example: location-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
code
string
Example: code=012AD63C
description
string
Example: description=A description

Responses

Response Schema: application/json
Array of objects (StockItem)
Array
formulary-uuid
string <uuid>
formulary-code
string
archived
boolean
description
string
formulary-type-uuid
string <uuid>
quantity-per-pack
integer <int32>
tax-uuid
string <uuid>
cost-type
string (CostTypeEnum)
Enum: "COST" "NET" "NETNET"
markup
number
dispensing-fee-net
number
minimum-charge
number
supplier-uuid
string <uuid>
supplier-sku
string
cost
number

aka net (Cost Per Pack)

cost-net-discount
number

aka net-net %

cost-netnet-discount
number

aka net-net-net %

multi-dispensing-fee
boolean
overwrite-price-enabled
boolean
overwrite-price
number
sell-at-cost
boolean
wholepack-price-enabled
boolean
wholepack-exclude-disp-fee
boolean
document-attached
boolean
prevent-hide
boolean
request-quantity
boolean
reminder-enabled
boolean
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string
wormer-enabled
boolean
flea-enabled
boolean
request-batch
boolean
request-chip
boolean
request-alter-sex
boolean
request-repeat-prescription
boolean
request-label
boolean
label-calc-quantity
boolean
label-external-use
boolean
label-additional-info
string
discount-category-enabled
boolean
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
string <uuid>
formulary-group-uuid
string <uuid>
treatment-category-uuid
string <uuid>
species-uuid
string <uuid>
product-alert
string
legal-category-uuid
string <uuid>
prescription-instruction-prefix-uuid
string <uuid>
prescription-measure-uuid
string <uuid>
prescription-frequency-measure
string
prescription-written-allowed
boolean
prescription-advanced-calculate-dosage
boolean
prescription-advanced-child-mandatory
boolean
prescription-advanced-dispense-suggested
boolean
marketing-authorisation-number
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "formulary-code": "ABC",
      • "archived": false,
      • "description": "Barium meal",
      • "formulary-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "quantity-per-pack": 20,
      • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "cost-type": "NET",
      • "markup": 20,
      • "dispensing-fee-net": 0.5,
      • "minimum-charge": 10,
      • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "supplier-sku": "ABCDEFG",
      • "cost": 50,
      • "cost-net-discount": 5,
      • "cost-netnet-discount": 2,
      • "multi-dispensing-fee": false,
      • "overwrite-price-enabled": false,
      • "overwrite-price": 5,
      • "sell-at-cost": false,
      • "wholepack-price-enabled": false,
      • "wholepack-exclude-disp-fee": false,
      • "document-attached": false,
      • "prevent-hide": false,
      • "request-quantity": false,
      • "reminder-enabled": false,
      • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "reminder-length": 5,
      • "reminder-delta": "WEEKS",
      • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "treatment-reminder-enabled": false,
      • "treatment-reminder-repeat": 5,
      • "treatment-reminder-occurrences": 5,
      • "treatment-reminder-delta": "WEEKS",
      • "treatment-reminder-product-description": "Extra info",
      • "wormer-enabled": false,
      • "flea-enabled": false,
      • "request-batch": false,
      • "request-chip": false,
      • "request-alter-sex": false,
      • "request-repeat-prescription": false,
      • "request-label": false,
      • "label-calc-quantity": false,
      • "label-external-use": false,
      • "label-additional-info": "More label info",
      • "discount-category-enabled": false,
      • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "hcp-eqm": 3,
      • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "product-alert": "Alert",
      • "legal-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "prescription-instruction-prefix-uuid": "918H012A-T5CE-4391-8F42-8396EF19CE83",
      • "prescription-measure-uuid": "918H052A-T5CE-4391-8F42-8396EF13CS83",
      • "prescription-frequency-measure": "Day(s)",
      • "prescription-written-allowed": false,
      • "prescription-advanced-calculate-dosage": false,
      • "prescription-advanced-child-mandatory": false,
      • "prescription-advanced-dispense-suggested": false,
      • "marketing-authorisation-number": "XYZ",
      • "modified": "2019-09-07T15:50:00.00Z"
      }
    ]
}

Create Stock configuration

Create a stock configuration

Request Body schema: application/json
required
formulary-code
required
string [ 1 .. 50 ] characters
description
required
string [ 1 .. 150 ] characters
formulary-type-uuid
required
string <uuid>
quantity-per-pack
required
integer <int32> >= 1
cost
required
number >= 0

aka net (Cost Per Pack)

cost-type
required
string (CostTypeEnum)
Enum: "COST" "NET" "NETNET"
markup
number
Default: 0
dispensing-fee-net
number
Default: 0
minimum-charge
number
Default: 0
supplier-uuid
required
string <uuid>
supplier-sku
string <= 50 characters
cost-net-discount
number [ 0 .. 100 ]

aka net-net %

cost-netnet-discount
number [ 0 .. 100 ]

aka net-net-net %

multi-dispensing-fee
boolean
Default: false
overwrite-price-enabled
boolean
Default: false
overwrite-price
number >= 0
sell-at-cost
boolean
Default: false
wholepack-price-enabled
boolean
Default: false
wholepack-exclude-disp-fee
boolean
Default: false
tax-uuid
required
string <uuid>
prevent-hide
required
boolean
request-quantity
boolean
Default: false
reminder-enabled
boolean
Default: false
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
Default: false
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string <= 50 characters
wormer-enabled
boolean
Default: false
flea-enabled
boolean
Default: false
request-batch
boolean
Default: false
request-chip
boolean
Default: false
request-alter-sex
boolean
Default: false
request-repeat-prescription
boolean
Default: false
request-label
boolean
Default: false
label-calc-quantity
boolean
Default: false
label-external-use
boolean
Default: false
label-additional-info
string <= 7000 characters
discount-category-enabled
boolean
Default: false
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
required
string <uuid>
formulary-group-uuid
required
string <uuid>
treatment-category-uuid
required
string <uuid>
species-uuid
string <uuid>
product-alert
string <= 255 characters
legal-category-uuid
string <uuid>
manufacturer-uuid
string <uuid>
hidden-on-creation
required
boolean
prescription-instruction-prefix-uuid
string <uuid>
prescription-measure-uuid
string <uuid>
prescription-frequency-measure
string (PrescriptionFrequencyMeasureEnum) ^(Hour|Day|Week|Month)\(s\)$
prescription-written-allowed
boolean
Default: true
prescription-advanced-calculate-dosage
boolean
Default: false
prescription-advanced-child-mandatory
boolean
Default: false
prescription-advanced-dispense-suggested
boolean
Default: false
marketing-authorisation-number
string

Responses

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

Request samples

Content type
application/json
{
  • "formulary-code": "ABSZOESL4",
  • "description": "Synulox Inj 40ml (per ml)",
  • "formulary-type-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "quantity-per-pack": 3,
  • "cost": 20,
  • "cost-type": "NET",
  • "markup": 20,
  • "dispensing-fee-net": 0.5,
  • "minimum-charge": 10,
  • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "supplier-sku": "ABCDEFG",
  • "cost-net-discount": 5,
  • "cost-netnet-discount": 2,
  • "multi-dispensing-fee": false,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "sell-at-cost": false,
  • "wholepack-price-enabled": false,
  • "wholepack-exclude-disp-fee": false,
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert",
  • "legal-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "manufacturer-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hidden-on-creation": false,
  • "prescription-instruction-prefix-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE84",
  • "prescription-measure-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE85",
  • "prescription-frequency-measure": "Day(s)",
  • "prescription-written-allowed": false,
  • "prescription-advanced-calculate-dosage": false,
  • "prescription-advanced-child-mandatory": false,
  • "prescription-advanced-dispense-suggested": false,
  • "marketing-authorisation-number": "12345"
}

Response samples

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

Retrieve Stock Configuration

Retrieve a single stock configuration

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

Responses

Response Schema: application/json
formulary-uuid
string <uuid>
formulary-code
string
archived
boolean
description
string
formulary-type-uuid
string <uuid>
quantity-per-pack
integer <int32>
tax-uuid
string <uuid>
cost-type
string (CostTypeEnum)
Enum: "COST" "NET" "NETNET"
markup
number
dispensing-fee-net
number
minimum-charge
number
supplier-uuid
string <uuid>
supplier-sku
string
cost
number

aka net (Cost Per Pack)

cost-net-discount
number

aka net-net %

cost-netnet-discount
number

aka net-net-net %

multi-dispensing-fee
boolean
overwrite-price-enabled
boolean
overwrite-price
number
sell-at-cost
boolean
wholepack-price-enabled
boolean
wholepack-exclude-disp-fee
boolean
document-attached
boolean
prevent-hide
boolean
request-quantity
boolean
reminder-enabled
boolean
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string
wormer-enabled
boolean
flea-enabled
boolean
request-batch
boolean
request-chip
boolean
request-alter-sex
boolean
request-repeat-prescription
boolean
request-label
boolean
label-calc-quantity
boolean
label-external-use
boolean
label-additional-info
string
discount-category-enabled
boolean
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
string <uuid>
formulary-group-uuid
string <uuid>
treatment-category-uuid
string <uuid>
species-uuid
string <uuid>
product-alert
string
legal-category-uuid
string <uuid>
prescription-instruction-prefix-uuid
string <uuid>
prescription-measure-uuid
string <uuid>
prescription-frequency-measure
string
prescription-written-allowed
boolean
prescription-advanced-calculate-dosage
boolean
prescription-advanced-child-mandatory
boolean
prescription-advanced-dispense-suggested
boolean
marketing-authorisation-number
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-code": "ABC",
  • "archived": false,
  • "description": "Barium meal",
  • "formulary-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "quantity-per-pack": 20,
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "cost-type": "NET",
  • "markup": 20,
  • "dispensing-fee-net": 0.5,
  • "minimum-charge": 10,
  • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "supplier-sku": "ABCDEFG",
  • "cost": 50,
  • "cost-net-discount": 5,
  • "cost-netnet-discount": 2,
  • "multi-dispensing-fee": false,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "sell-at-cost": false,
  • "wholepack-price-enabled": false,
  • "wholepack-exclude-disp-fee": false,
  • "document-attached": false,
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert",
  • "legal-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prescription-instruction-prefix-uuid": "918H012A-T5CE-4391-8F42-8396EF19CE83",
  • "prescription-measure-uuid": "918H052A-T5CE-4391-8F42-8396EF13CS83",
  • "prescription-frequency-measure": "Day(s)",
  • "prescription-written-allowed": false,
  • "prescription-advanced-calculate-dosage": false,
  • "prescription-advanced-child-mandatory": false,
  • "prescription-advanced-dispense-suggested": false,
  • "marketing-authorisation-number": "XYZ",
  • "modified": "2019-09-07T15:50:00.00Z"
}

Update Stock configuration

Update a stock configuration

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
formulary-code
required
string or null [ 1 .. 50 ] characters
description
required
string or null [ 1 .. 150 ] characters
formulary-type-uuid
required
string or null <uuid>
quantity-per-pack
required
integer or null <int32> >= 1
cost
required
number or null >= 0

aka net (Cost Per Pack)

cost-type
required
string or null (NullableCostTypeEnum) ^COST$|^NET$|^NETNET$
markup
number or null
Default: 0
dispensing-fee-net
number or null
Default: 0
minimum-charge
number or null
Default: 0
supplier-uuid
required
string or null <uuid>
supplier-sku
string or null <= 50 characters
cost-net-discount
number or null [ 0 .. 100 ]

aka net-net %

cost-netnet-discount
number or null [ 0 .. 100 ]

aka net-net-net %

multi-dispensing-fee
boolean or null
Default: false
overwrite-price-enabled
boolean or null
Default: false
overwrite-price
number or null >= 0
sell-at-cost
boolean or null
Default: false
wholepack-price-enabled
boolean or null
Default: false
wholepack-exclude-disp-fee
boolean or null
Default: false
tax-uuid
required
string or null <uuid>
prevent-hide
required
boolean or null
request-quantity
boolean or null
Default: false
reminder-enabled
boolean or null
Default: false
reminder-type-uuid
string or null <uuid>
reminder-length
integer or null <int32>
reminder-delta
string or null (NullableReminderDeltaEnum) ^DAYS$|^WEEKS$|^MONTHS$
reminder-next-formulary-uuid
string or null <uuid>
treatment-reminder-enabled
boolean or null
Default: false
treatment-reminder-repeat
integer or null <int32>
treatment-reminder-occurrences
integer or null <int32>
treatment-reminder-delta
string or null (NullableTreatmentReminderDeltaEnum) ^DAYS$|^WEEKS$|^MONTHS$
treatment-reminder-product-description
string or null <= 50 characters
wormer-enabled
boolean or null
Default: false
flea-enabled
boolean or null
Default: false
request-batch
boolean or null
Default: false
request-chip
boolean or null
Default: false
request-alter-sex
boolean or null
Default: false
request-repeat-prescription
boolean or null
Default: false
request-label
boolean or null
Default: false
label-calc-quantity
boolean or null
Default: false
label-external-use
boolean or null
Default: false
label-additional-info
string or null <= 7000 characters
discount-category-enabled
boolean or null
Default: false
healthplan-group-uuid
string or null <uuid>
hcp-eqm
integer or null <int32>
account-type-uuid
required
string or null <uuid>
formulary-group-uuid
required
string or null <uuid>
treatment-category-uuid
required
string or null <uuid>
species-uuid
string or null <uuid>
product-alert
string or null <= 255 characters
legal-category-uuid
string or null <uuid>
manufacturer-uuid
string or null <uuid>
prescription-instruction-prefix-uuid
string or null <uuid>
prescription-measure-uuid
string or null <uuid>
prescription-frequency-measure
string or null (NullablePrescriptionFrequencyMeasureEnum) ^(Hour|Day|Week|Month)\(s\)$
prescription-written-allowed
boolean or null
prescription-advanced-calculate-dosage
boolean or null
prescription-advanced-child-mandatory
boolean or null
prescription-advanced-dispense-suggested
boolean or null
marketing-authorisation-number
string or null

Responses

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

Request samples

Content type
application/json
{
  • "formulary-code": "ABSZOESL4",
  • "description": "Synulox Inj 40ml (per ml)",
  • "formulary-type-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "quantity-per-pack": 3,
  • "cost": 20,
  • "cost-type": "NET",
  • "markup": 20,
  • "dispensing-fee-net": 0.5,
  • "minimum-charge": 10,
  • "supplier-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "supplier-sku": "ABCDEFG",
  • "cost-net-discount": 5,
  • "cost-netnet-discount": 2,
  • "multi-dispensing-fee": false,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "sell-at-cost": false,
  • "wholepack-price-enabled": false,
  • "wholepack-exclude-disp-fee": false,
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert",
  • "legal-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "manufacturer-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prescription-instruction-prefix-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE84",
  • "prescription-measure-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE85",
  • "prescription-frequency-measure": "Day(s)",
  • "prescription-written-allowed": false,
  • "prescription-advanced-calculate-dosage": false,
  • "prescription-advanced-child-mandatory": false,
  • "prescription-advanced-dispense-suggested": false,
  • "marketing-authorisation-number": "12345"
}

Response samples

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

Service

Access and Manage Service related formulary

Retrieve Service Configurations

Retrieve a list of Service Configurations

query Parameters
required
object (Pageable)

Pageable parameters

modified-start
string <date-time>
Example: modified-start=2019-09-07T15:50:00.00Z
modified-end
string <date-time>
Example: modified-end=2019-09-07T15:50:00.00Z
include-archived
boolean
formulary-type-uuid
string <uuid>
Example: formulary-type-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
treatment-category-uuid
string <uuid>
Example: treatment-category-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
formulary-group-uuid
string <uuid>
Example: formulary-group-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
healthplan-group-uuid
string <uuid>
Example: healthplan-group-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
location-uuid
string <uuid>
Example: location-uuid=012AD63C-4846-4394-BDD3-A18610BB8EBD
code
string
Example: code=012AD63C
description
string
Example: description=A description

Responses

Response Schema: application/json
Array of objects (ServiceItem)
Array
formulary-uuid
string <uuid>
formulary-code
string
archived
boolean
description
string
formulary-type-uuid
string <uuid>
tax-uuid
string <uuid>
net-price
number

aka net (Cost Per Pack)

overwrite-price-enabled
boolean
overwrite-price
number
document-attached
boolean
prevent-hide
boolean
request-quantity
boolean
reminder-enabled
boolean
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string
wormer-enabled
boolean
flea-enabled
boolean
request-batch
boolean
request-chip
boolean
request-alter-sex
boolean
request-repeat-prescription
boolean
request-label
boolean
label-calc-quantity
boolean
label-external-use
boolean
label-additional-info
string
discount-category-enabled
boolean
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
string <uuid>
formulary-group-uuid
string <uuid>
treatment-category-uuid
string <uuid>
species-uuid
string <uuid>
product-alert
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "formulary-code": "ABC",
      • "archived": false,
      • "description": "Barium meal",
      • "formulary-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "net-price": 50,
      • "overwrite-price-enabled": false,
      • "overwrite-price": 5,
      • "document-attached": false,
      • "prevent-hide": false,
      • "request-quantity": false,
      • "reminder-enabled": false,
      • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "reminder-length": 5,
      • "reminder-delta": "WEEKS",
      • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "treatment-reminder-enabled": false,
      • "treatment-reminder-repeat": 5,
      • "treatment-reminder-occurrences": 5,
      • "treatment-reminder-delta": "WEEKS",
      • "treatment-reminder-product-description": "Extra info",
      • "wormer-enabled": false,
      • "flea-enabled": false,
      • "request-batch": false,
      • "request-chip": false,
      • "request-alter-sex": false,
      • "request-repeat-prescription": false,
      • "request-label": false,
      • "label-calc-quantity": false,
      • "label-external-use": false,
      • "label-additional-info": "More label info",
      • "discount-category-enabled": false,
      • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "hcp-eqm": 3,
      • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "product-alert": "Alert",
      • "modified": "2019-09-07T15:50:00.00Z"
      }
    ]
}

Create Service configuration

Create a service configuration

Request Body schema: application/json
required
formulary-code
required
string [ 1 .. 50 ] characters
description
required
string [ 1 .. 150 ] characters
formulary-type-uuid
required
string <uuid>
net-price
required
number >= 0
overwrite-price-enabled
boolean
Default: false
overwrite-price
number >= 0
tax-uuid
required
string <uuid>
prevent-hide
required
boolean
request-quantity
boolean
Default: false
reminder-enabled
boolean
Default: false
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
Default: false
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string <= 50 characters
wormer-enabled
boolean
Default: false
flea-enabled
boolean
Default: false
request-batch
boolean
Default: false
request-chip
boolean
Default: false
request-alter-sex
boolean
Default: false
request-repeat-prescription
boolean
Default: false
request-label
boolean
Default: false
label-calc-quantity
boolean
Default: false
label-external-use
boolean
Default: false
label-additional-info
string <= 7000 characters
discount-category-enabled
boolean
Default: false
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
required
string <uuid>
formulary-group-uuid
required
string <uuid>
treatment-category-uuid
required
string <uuid>
species-uuid
string <uuid>
product-alert
string <= 255 characters
hidden-on-creation
required
boolean

Responses

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

Request samples

Content type
application/json
{
  • "formulary-code": "ABSZOESL4",
  • "description": "Synulox Inj 40ml (per ml)",
  • "formulary-type-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "net-price": 3,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert",
  • "hidden-on-creation": false
}

Response samples

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

Retrieve Service Configuration

retrieve a single service configuration

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

Responses

Response Schema: application/json
formulary-uuid
string <uuid>
formulary-code
string
archived
boolean
description
string
formulary-type-uuid
string <uuid>
tax-uuid
string <uuid>
net-price
number

aka net (Cost Per Pack)

overwrite-price-enabled
boolean
overwrite-price
number
document-attached
boolean
prevent-hide
boolean
request-quantity
boolean
reminder-enabled
boolean
reminder-type-uuid
string <uuid>
reminder-length
integer <int32>
reminder-delta
string (ReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
reminder-next-formulary-uuid
string <uuid>
treatment-reminder-enabled
boolean
treatment-reminder-repeat
integer <int32>
treatment-reminder-occurrences
integer <int32>
treatment-reminder-delta
string (TreatmentReminderDeltaEnum)
Enum: "DAYS" "WEEKS" "MONTHS"
treatment-reminder-product-description
string
wormer-enabled
boolean
flea-enabled
boolean
request-batch
boolean
request-chip
boolean
request-alter-sex
boolean
request-repeat-prescription
boolean
request-label
boolean
label-calc-quantity
boolean
label-external-use
boolean
label-additional-info
string
discount-category-enabled
boolean
healthplan-group-uuid
string <uuid>
hcp-eqm
integer <int32>
account-type-uuid
string <uuid>
formulary-group-uuid
string <uuid>
treatment-category-uuid
string <uuid>
species-uuid
string <uuid>
product-alert
string
modified
string <date-time>

Response samples

Content type
application/json
{
  • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-code": "ABC",
  • "archived": false,
  • "description": "Barium meal",
  • "formulary-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "net-price": 50,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "document-attached": false,
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert",
  • "modified": "2019-09-07T15:50:00.00Z"
}

Update Service Configuration

update a service configuration

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
formulary-code
required
string or null [ 1 .. 50 ] characters
archived
boolean
Default: false
description
required
string or null [ 1 .. 150 ] characters
formulary-type-uuid
required
string or null <uuid>
net-price
required
number or null >= 0
overwrite-price-enabled
boolean or null
Default: false
overwrite-price
number or null >= 0
tax-uuid
required
string or null <uuid>
prevent-hide
required
boolean or null
request-quantity
boolean or null
Default: false
reminder-enabled
boolean or null
Default: false
reminder-type-uuid
string or null <uuid>
reminder-length
integer or null <int32>
reminder-delta
string or null (NullableReminderDeltaEnum) ^DAYS$|^WEEKS$|^MONTHS$
reminder-next-formulary-uuid
string or null <uuid>
treatment-reminder-enabled
boolean or null
Default: false
treatment-reminder-repeat
integer or null <int32>
treatment-reminder-occurrences
integer or null <int32>
treatment-reminder-delta
string or null (NullableTreatmentReminderDeltaEnum) ^DAYS$|^WEEKS$|^MONTHS$
treatment-reminder-product-description
string or null <= 50 characters
wormer-enabled
boolean or null
Default: false
flea-enabled
boolean or null
Default: false
request-batch
boolean or null
Default: false
request-chip
boolean or null
Default: false
request-alter-sex
boolean or null
Default: false
request-repeat-prescription
boolean or null
Default: false
request-label
boolean or null
Default: false
label-calc-quantity
boolean or null
Default: false
label-external-use
boolean or null
Default: false
label-additional-info
string or null <= 7000 characters
discount-category-enabled
boolean or null
Default: false
healthplan-group-uuid
string or null <uuid>
hcp-eqm
integer or null <int32>
account-type-uuid
required
string or null <uuid>
formulary-group-uuid
required
string or null <uuid>
treatment-category-uuid
required
string or null <uuid>
species-uuid
string or null <uuid>
product-alert
string or null <= 255 characters

Responses

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

Request samples

Content type
application/json
{
  • "formulary-code": "ABSZOESL4",
  • "archived": false,
  • "description": "Consultation",
  • "formulary-type-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "net-price": 3,
  • "overwrite-price-enabled": false,
  • "overwrite-price": 5,
  • "tax-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "prevent-hide": false,
  • "request-quantity": false,
  • "reminder-enabled": false,
  • "reminder-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "reminder-length": 5,
  • "reminder-delta": "WEEKS",
  • "reminder-next-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-reminder-enabled": false,
  • "treatment-reminder-repeat": 5,
  • "treatment-reminder-occurrences": 5,
  • "treatment-reminder-delta": "WEEKS",
  • "treatment-reminder-product-description": "Extra info",
  • "wormer-enabled": false,
  • "flea-enabled": false,
  • "request-batch": false,
  • "request-chip": false,
  • "request-alter-sex": false,
  • "request-repeat-prescription": false,
  • "request-label": false,
  • "label-calc-quantity": false,
  • "label-external-use": false,
  • "label-additional-info": "More label info",
  • "discount-category-enabled": false,
  • "healthplan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "hcp-eqm": 3,
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "product-alert": "Alert"
}

Response samples

Content type
application/json
{
  • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
}

Labelling

Access and Manage Labelling metadata

Retrieve Dispensing Notes

Retrieve a list of dispensing notes

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (DispensingNote)
Array
description
string
dispensing-note-uuid
string <uuid>
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "description": "Take tablets daily",
      • "dispensing-note-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "view-order": 1
      }
    ]
}

Retrieve Formulary Dispensing Notes

Retrieve a list of dispensing notes associated to the formulary record.

path Parameters
formulary-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 (FormularyDispensingNote)
Array
dispensing-note-uuid
string <uuid>
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "dispensing-note-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "view-order": 1
      }
    ]
}

Add Formulary Dispensing Note

Add a dispensing note to a formulary item

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
dispensing-note-uuid
required
string <uuid>
view-order
integer <int32> >= 0

Responses

Response Schema: application/json
object (CreateFormularyDispensingNoteResponse)

Request samples

Content type
application/json
{
  • "dispensing-note-uuid": "0709B5D4-3131-4AF1-8E41-552EEA125617",
  • "view-order": 123
}

Response samples

Content type
application/json
{ }

Replace Formulary Dispensing Notes

Replace the dispensing notes of a formulary item

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
Array (non-empty)
dispensing-note-uuid
required
string <uuid>
view-order
required
integer <int32> >= 0

Responses

Response Schema: application/json
object (UpdateFormularyDispensingNoteResponse)

Request samples

Content type
application/json
[
  • {
    • "dispensing-note-uuid": "EB197366-538D-4E03-9761-7834193DC713",
    • "view-order": 5
    }
]

Response samples

Content type
application/json
{ }

Delete dispensing note

Delete a dispensing note from a formulary record

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
dispensing-note-uuid
required
string <uuid>
Example: 48411941-68B0-4B5D-904D-2DA554E411D4

Responses

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

Response samples

Content type
application/json
{
  • "dispensing-note-uuid": "A5512219-CA2C-4CC8-BEC9-569FD80030B4"
}

Formulary Admin

Information stored only for formulary administrators

Retrieve Formulary Notes

Retrieve a list of notes associated to the formulary record.

path Parameters
formulary-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 (Note)
Array
note-uuid
string <uuid>
date
string <date-time>
note
string
initials
string
location-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "note-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "date": "2019-09-07T15:50:00.00Z",
      • "note": "Misc note",
      • "initials": "JC",
      • "location-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50"
      }
    ]
}

Create formulary note

Create a formulary note

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
location-uuid
required
string <uuid>
note-date
string <date-time>

Defaults to the current date if left blank

note
required
string [ 1 .. 7000 ] characters
initials
required
string [ 1 .. 50 ] characters

Responses

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

Request samples

Content type
application/json
{
  • "location-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "note-date": "2022-09-02T08:32:59Z",
  • "note": "string",
  • "initials": "GWB"
}

Response samples

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

Update formulary note

Update a formulary note

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
formulary-note-uuid
required
string <uuid>
Example: 6AD1E709-71E9-4F70-8132-46C525A2BC7E
Request Body schema: application/json
required
location-uuid
string or null <uuid>
note-date
string or null <date-time>
note
string or null [ 1 .. 7000 ] characters
initials
string or null [ 1 .. 50 ] characters

Responses

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

Request samples

Content type
application/json
{
  • "location-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "note-date": "2022-09-02T08:32:59Z",
  • "note": "string",
  • "initials": "GWB"
}

Response samples

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

Delete formulary note

Delete a formulary note

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
formulary-note-uuid
required
string <uuid>
Example: 6AD1E709-71E9-4F70-8132-46C525A2BC7E

Responses

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

Response samples

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

Scanning

Access and Manage scanning capability and relationship to formulary

Retrieve Formulary's Barcodes

Retrieve a list of barcodes associated to the formulary record.

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

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
Array of objects (Barcode)
Array
barcode-uuid
string <uuid>
barcode
string
manufacturer
string
location-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "barcode-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "barcode": "5055141551999",
      • "manufacturer": "Royal canin",
      • "location-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50"
      }
    ]
}

Create Formulary's Barcodes

Create a barcode associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
barcode
required
string [ 1 .. 50 ] characters
manufacturer
required
string [ 1 .. 100 ] characters
location-uuid
string <uuid>

Responses

Response Schema: application/json
object (CreateBarcodeResponse)

Request samples

Content type
application/json
{
  • "barcode": "5055141551999",
  • "manufacturer": "Royal canin",
  • "location-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50"
}

Response samples

Content type
application/json
{ }

Delete Formulary's Barcodes

Delete a barcode.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
location-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
barcode
required
string
Example: 1248765921495

Responses

Response Schema: application/json
object (DeleteBarcodeResponse)

Response samples

Content type
application/json
{ }

Delete Formulary's Barcodes

Delete a barcode.

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

Responses

Response Schema: application/json
object (DeleteBarcodeResponse)

Response samples

Content type
application/json
{ }

Pricing Deviation

Access and Manage billing related metadata such as discounts, location deviations

Retrieve Location Deviations

Retrieve a list of Deviations based on the location and formulary record.

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
formulary-uuid
string <uuid>
Example: formulary-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
Array of objects (LocationDeviation)
Array
location-uuid
string <uuid>
formulary-uuid
string <uuid>
min-charge-percentage
number
dispensing-fee-percentage
number
price-percentage
number
hidden
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "location-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "formulary-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "min-charge-percentage": 2.5,
      • "dispensing-fee-percentage": 0.4,
      • "price-percentage": 6.5,
      • "hidden": false
      }
    ]
}

Update location deviations

Update a list of Deviations based on the location and formulary record.

Request Body schema: application/json
required
required
Array of objects (UpdateLocationDeviation)
Array
formulary-uuid
required
string <uuid>

Formulary UUID, combined key with location UUID

location-uuid
required
string <uuid>

Location UUID, combined key with formulary UUID

min-charge-percentage
number [ -100 .. 100 ]
Default: 0

Minimum charge percentage

dispensing-fee-percentage
number [ -100 .. 100 ]
Default: 0

Dispensing fee percentage

price-percentage
number [ -100 .. 100 ]
Default: 0

Price percentage

hidden
boolean

Responses

Response Schema: application/json
Array of objects (UpdateLocationDeviationResult)
Array
formulary-uuid
string <uuid>
location-uuid
string <uuid>
status
integer <int32>

status code

message
string

Description of error, used if status other than 2XX

Request samples

Content type
application/json
{
  • "locationDeviations": [
    • {
      • "formulary-uuid": "123e4567-e89b-12d3-a456-426655440000",
      • "location-uuid": "123e4567-e89b-12d3-a456-426655440000",
      • "min-charge-percentage": 10.5,
      • "dispensing-fee-percentage": 5.5,
      • "price-percentage": 20.5,
      • "hidden": false
      }
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    • {
      • "formulary-uuid": "123e4567-e89b-12d3-a456-426655440000",
      • "location-uuid": "123e4567-e89b-12d3-a456-426655440000",
      • "status": 400,
      • "message": "Formulary cannot be hidden"
      }
    ]
}

Clinical Workflow

Access and Manage additional workflow options

Retrieve Formulary's Send-To Actions

Retrieve a list of Send-To Actions associated to the formulary record.

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

Pageable parameters

Responses

Response Schema: application/json
results
Array of integers <int32> [ items <int32 > ]

Response samples

Content type
application/json
{
  • "results": [
    • 12345
    ]
}

Update Formulary's Send-To Actions

Update Send-To Actions associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
send-to-action-uuid
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

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

Request samples

Content type
application/json
{
  • "send-to-action-uuid": [
    • "D9A21292-606A-4AE2-9655-BD0B6AA51940"
    ]
}

Response samples

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

Create Formulary's Send-To Action

Create a Send-To Action associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
send-to-action-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

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

Response samples

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

Delete Formulary's Send-To Action

Delete a Send-To Action associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
send-to-action-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
object (DeleteSendTosResponse)

Response samples

Content type
application/json
{ }

Retrieve Send-To Actions Library

Retrieve a list of Send-To actions from the library

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (SendTo)
Array
send-to-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "send-to-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Hospital",
      • "description": "Hospital",
      • "view-order": 111
      }
    ]
}

Categorisation

Access and Manage formulary type categorisation

Retrieve Formularys Discount Categories

Retrieve a list of Discount Categories associated to the formulary record.

path Parameters
formulary-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 (DiscountCategory)
Array
dispensing-category-uuid
string <uuid>
amount
number

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "dispensing-category-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "amount": 25
      }
    ]
}

Create Formulary Discount Category

Create a Discount Category associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
discount-category-uuid
required
string <uuid>
value-percent
required
number ( 0 .. 100 ]

Responses

Response Schema: application/json
object (CreateFormularyDiscountCategoryResponse)

Request samples

Content type
application/json
{
  • "discount-category-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "value-percent": 50.45
}

Response samples

Content type
application/json
{ }

Delete Formulary's Discount Category

Delete a Discount Category associated to the formulary record.

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

Responses

Response Schema: application/json
object (DeleteDiscountCategoryResponse)

Response samples

Content type
application/json
{ }

Update Formulary's Discount Category

Update a Discount Category associated to the formulary record.

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
discount-category-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
value-percent
required
number ( 0 .. 100 ]

Responses

Response Schema: application/json
object (UpdateFormularyDiscountCategoryResponse)

Request samples

Content type
application/json
{
  • "value-percent": 50.45
}

Response samples

Content type
application/json
{ }

Retrieve Formulary Types

Retrieve a list of Formulary Types.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (FormularyType)
Array
formulary-type-uuid
string <uuid>
name
string
view-order
integer <int32>
stock
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Diagnostic",
      • "view-order": 1,
      • "stock": false
      }
    ]
}

Retrieve Treatment Categories

Retrieve a list of Treatment Categories.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (TreatmentCategory)
Array
treatment-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "treatment-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Diagnostic",
      • "description": "Diagnostic"
      }
    ]
}

Retrieve Legal Categories

Retrieve a list of Legal Categories from the library.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (LegalCategory)
Array
legal-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "legal-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "AVM-GSL",
      • "description": "AVM-GSL"
      }
    ]
}

Formulary Identifiers

Access formulary identifiers

Retrieve Formulary identifiers

Retrieve a list of Formulary identifiers.

query Parameters
required
object (Pageable)

Pageable parameters

formulary-uuid
string <uuid>
Example: formulary-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
code-id
integer <int32>
Example: code-id=123

Responses

Response Schema: application/json
Array of objects (FormularyIdentifiers)
Array
formulary-uuid
string <uuid>
code-id
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "code-id": 123
      }
    ]
}

Formulary Groups

Access and Manage formulary groups

Retrieve Formulary Groups

Retrieve a list of Formulary Group

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (FormularyGroup)
Array
formulary-group-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "formulary-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Prof Fees",
      • "description": "Prof Fees description"
      }
    ]
}

Healthcare Plan

Access healthcare plan

Retrieve Health Plan Groups

Retrieve a list of Healthcare Plan Groups from the library.

query Parameters
required
object (Pageable)

Pageable parameters

core-category
boolean

Responses

Response Schema: application/json
Array of objects (HealthPlanGroup)
Array
plan-group-uuid
string <uuid>
name
string
description
string
default-discount-percentage
number

Default discount percentage of the health plan group

core-category
boolean
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "plan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Health Plan Group name",
      • "description": "Health Plan Group description",
      • "default-discount-percentage": 50,
      • "core-category": false,
      • "modified": "2019-09-07T15:50:00.00Z"
      }
    ]
}

Retrieve Health Plans

Retrieve a list of Health Plans

query Parameters
required
object (Pageable)

Pageable parameters

species-uuid
string <uuid>
Example: species-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
status-active
boolean
status-deleted
boolean

Responses

Response Schema: application/json
Array of objects (HealthPlan)
Array
plan-uuid
string <uuid>
value-total
number

Full cost of the health plan

value-monthly
number

Cost for one month of using the health plan

status-active
boolean
status-deleted
boolean
date-deleted
string <date-time>
sale-start-date
string <date-time>
sale-end-date
string <date-time>
plan-name
string
species-uuid
string <uuid>
plan-length-months
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "plan-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "value-total": 50,
      • "value-monthly": 50,
      • "status-active": false,
      • "status-deleted": false,
      • "date-deleted": "2019-09-07T15:50:00.00Z",
      • "sale-start-date": "2019-09-07T15:50:00.00Z",
      • "sale-end-date": "2019-09-07T15:50:00.00Z",
      • "plan-name": "Small Dog Plan",
      • "species-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "plan-length-months": 12
      }
    ]
}

Retrieve Health Plan Contents

Retrieve Health Plan Contents

path Parameters
plan-uuid
required
string <uuid>
Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2
query Parameters
required
object (Pageable)

Pageable parameters

treatment-group-uuid
string <uuid>
Example: treatment-group-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
point-in-range
integer <int32>
Example: point-in-range=1

Responses

Response Schema: application/json
Array of objects (HealthPlanContent)
Array
plan-content-uuid
string <uuid>
plan-group-uuid
string <uuid>
range-start-in-days
integer <int32>
range-end-in-days
integer <int32>
allowance
integer <int32>
discount-percentage
number

Discount percentage of the health plan content

view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "plan-content-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "plan-group-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "range-start-in-days": 1,
      • "range-end-in-days": 10,
      • "allowance": 2,
      • "discount-percentage": 50,
      • "view-order": 2
      }
    ]
}

Retrieve Health Plan Sites

Retrieve Health Plan Sites

query Parameters
required
object (Pageable)

Pageable parameters

plan-uuid
string <uuid>
Example: plan-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
location-uuid
string <uuid>
Example: location-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
Array of objects (HealthPlanSite)
Array
plan-uuid
string <uuid>
location-uuid
string <uuid>

Response samples

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

Composites

Access and Manage composites

Retrieve Composites

Retrieve Composites

query Parameters
required
object (Pageable)

Pageable parameters

parent-formulary-uuid
string <uuid>
Example: parent-formulary-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
location-uuid
string <uuid>
Example: location-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
include-mandated
boolean

Responses

Response Schema: application/json
Array of objects (Composite)
Array
composite-uuid
string <uuid>
location-uuid
string <uuid>
parent-formulary-uuid
string <uuid>
child-formulary-uuid
string <uuid>
composite-mandated
boolean
composite-quantity
number
composite-view-order
integer <int32>
composite-no-charge
boolean
composite-inherit
boolean
composite-mandatory
boolean
composite-opt-in
boolean
composite-no-destocking
boolean
composite-non-billable-destocking
boolean
composite-do-not-use-parent-quantity
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "composite-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "parent-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "child-formulary-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "composite-mandated": false,
      • "composite-quantity": 0.25,
      • "composite-view-order": 400,
      • "composite-no-charge": false,
      • "composite-inherit": false,
      • "composite-mandatory": false,
      • "composite-opt-in": false,
      • "composite-no-destocking": false,
      • "composite-non-billable-destocking": false,
      • "composite-do-not-use-parent-quantity": false
      }
    ]
}

Create Composite

Create Composite

Request Body schema: application/json
required
location-uuid
required
string <uuid>
parent-formulary-uuid
required
string <uuid>
child-formulary-uuid
required
string <uuid>
composite-quantity
required
number > 0
composite-view-order
integer <int32> >= 1
composite-no-charge
boolean
composite-inherit
boolean
composite-mandatory
boolean
composite-opt-in
boolean
composite-no-destocking
boolean
composite-non-billable-destocking
boolean
composite-do-not-use-parent-quantity
boolean

Responses

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

Request samples

Content type
application/json
{
  • "location-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "parent-formulary-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "child-formulary-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD",
  • "composite-quantity": 0.25,
  • "composite-view-order": 400,
  • "composite-no-charge": false,
  • "composite-inherit": false,
  • "composite-mandatory": false,
  • "composite-opt-in": false,
  • "composite-no-destocking": false,
  • "composite-non-billable-destocking": false,
  • "composite-do-not-use-parent-quantity": false
}

Response samples

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

Delete Composite

Delete Composite

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

Responses

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

Response samples

Content type
application/json
{
  • "composite-uuid": "A5512219-CA2C-4CC8-BEC9-569FD80030B4"
}

Document Template

Access and Manage Templates on Documents

Retrieve Formulary's Document Templates

Retrieve a list of Document Templates associated to the formulary record.

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

Responses

Response Schema: application/json
results
Array of strings <uuid> [ items <uuid > ]

Response samples

Content type
application/json
{
  • "results": [
    • "918D012A-E5CE-4391-8D42-8396EF19CE83"
    ]
}

Add Formulary Document Template

Attach a document template to a formulary item

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
document-template-uuid
required
string <uuid>

Responses

Response Schema: application/json
object (CreateFormularyDocumentTemplateResponse)

Request samples

Content type
application/json
{
  • "document-template-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD"
}

Response samples

Content type
application/json
{ }

Update Formulary Document Template

Update a document template for a formulary item

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
document-template-uuid
required
string <uuid>

Responses

Response Schema: application/json
object (UpdateFormularyDocumentTemplateResponse)

Request samples

Content type
application/json
{
  • "document-template-uuid": "012AD63C-4846-4394-BDD3-A18610BB8EBD"
}

Response samples

Content type
application/json
{ }

Delete a document template

Delete a document template

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
document-template-uuid
required
string <uuid>
Example: 6AD1E709-71E9-4F70-8132-46C525A2BC7E

Responses

Response Schema: application/json
document-template-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "document-template-uuid": "A5512219-CA2C-4CC8-BEC9-569FD80030B4"
}

Active Ingredients

Access and Manage Active Ingredients

Retrieve Active Ingredients

Retrieve a list of active ingredients

query Parameters
required
object (Pageable)

Pageable parameters

search-ingredient
string

Filter where the ingredient name starts with this search term

Responses

Response Schema: application/json
Array of objects (ActiveIngredient)
Array
active-ingredient-uuid
string <uuid>
active-ingredient
string
inactive
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "active-ingredient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "active-ingredient": "Aciclovir",
      • "inactive": false
      }
    ]
}

Retrieve Active Ingredient

Retrieve a single active ingredient object

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

Responses

Response Schema: application/json
active-ingredient-uuid
string <uuid>
active-ingredient
string
inactive
boolean

Response samples

Content type
application/json
{
  • "active-ingredient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "active-ingredient": "Aciclovir",
  • "inactive": false
}

Retrieve Active Ingredient Measures

Retrieve a list of Active Ingredient Measures

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (ActiveIngredientMeasure)
Array
active-ingredient-measure-uuid
string <uuid>
measure
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "active-ingredient-measure-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "measure": "mg"
      }
    ]
}

Retrieve Active Ingredient Measure

Retrieve a single active ingredient measure object

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

Responses

Response Schema: application/json
active-ingredient-measure-uuid
string <uuid>
measure
string

Response samples

Content type
application/json
{
  • "active-ingredient-measure-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "measure": "mg"
}

Retrieve Formulary Active Ingredients

Retrieve a list of Active Ingredients associated to the formulary record.

path Parameters
formulary-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 (FormularyActiveIngredient)
Array
active-ingredient-uuid
string <uuid>
strength-per-unit
number
strength-active-ingredient-measure-uuid
string <uuid>
prescription-dosage-active-ingredient-measure-uuid
string <uuid>
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "active-ingredient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "strength-per-unit": 10,
      • "strength-active-ingredient-measure-uuid": "7598090-00ee-41da-b887-f5c97db3f4fc",
      • "prescription-dosage-active-ingredient-measure-uuid": "164a9c79-b7ff-48f7-8bbc-bfd27997560c",
      • "modified": "2024-07-01T16:15:00.00Z"
      }
    ]
}

Create Formulary Active Ingredient

Create a formulary active ingredient associated to the formulary record

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
active-ingredient-uuid
required
string <uuid>
strength-per-unit
required
number > 0
strength-active-ingredient-measure-uuid
required
string <uuid>
prescription-dosage-active-ingredient-measure-uuid
required
string <uuid>

Responses

Response Schema: application/json
active-ingredient-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "active-ingredient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "strength-per-unit": 0.5,
  • "strength-active-ingredient-measure-uuid": "7598090-00ee-41da-b887-f5c97db3f4fc",
  • "prescription-dosage-active-ingredient-measure-uuid": "164a9c79-b7ff-48f7-8bbc-bfd27997560c"
}

Response samples

Content type
application/json
{
  • "active-ingredient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
}

Update Formulary Active ingredient

Update Formulary Active ingredient

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
active-ingredient-uuid
required
string <uuid>
Example: 58e45ffb-00ea-4419-9033-7c4c7a3a9c44
Request Body schema: application/json
required
strength-per-unit
required
number or null > 0
strength-active-ingredient-measure-uuid
required
string or null <uuid>
prescription-dosage-active-ingredient-measure-uuid
required
string or null <uuid>

Responses

Response Schema: application/json
active-ingredient-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "strength-per-unit": 0.5,
  • "strength-active-ingredient-measure-uuid": "7598090-00ee-41da-b887-f5c97db3f4fc",
  • "prescription-dosage-active-ingredient-measure-uuid": "164a9c79-b7ff-48f7-8bbc-bfd27997560c"
}

Response samples

Content type
application/json
{
  • "active-ingredient-uuid": "A5512219-CA2C-4CC8-BEC9-569FD80030B4"
}

Delete Active Ingredient

Delete an Active Ingredient from a formulary record

path Parameters
formulary-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
active-ingredient-uuid
required
string <uuid>
Example: 58e45ffb-00ea-4419-9033-7c4c7a3a9c44

Responses

Response Schema: application/json
object (DeleteFormularyActiveIngredientResponse)

Response samples

Content type
application/json
{ }