Skip to main content
Version: 3.1

Product

Definition

Care keeps two kinds of records for every item that a facility stocks or dispenses. A Product Knowledge entry is the catalog definition of a type of product, for example "Paracetamol 500mg tablet". A Product is one facility's stocked batch of that catalog entry, with its own lot number, expiry date, and purchase price.

Note: Care does not map these two records to a single named FHIR R5 resource.

Key Attributes

Product Knowledge

ComponentsWhat it captures
NameThe name of the catalog entry. This is required.
SlugA short unique code that identifies the catalog entry. This is required.
Product TypeThe kind of product: Medication, Nutritional Product, or Consumable. This is required.
CategoryThe group that the catalog entry belongs to. This is required.
CodeA standard medical code for the product. This is optional.
Base UnitThe unit that measures the product, for example tablet or millilitre. This is required.
StatusThe stage of the catalog entry. This is required.
Alternate IdentifierAnother identifier for the product. This is optional.
Alternate namesTrade names and other aliases of the product. This is optional.
Storage guidelinesThe instructions to store the product. This is optional.

Product

ComponentsWhat it captures
StatusThe stage of the stocked batch. This is required.
Product KnowledgeThe catalog entry that the batch belongs to. This is required. You select it when you create the product, and you cannot change it later.
Lot NumberThe batch number that the supplier prints on the product. This is optional.
Expiration DateThe date that the batch expires on. This is required.
Standard Pack SizeThe number of base units in one pack. This is optional.
Purchase PriceThe price that the facility paid for the product. This is optional.
Charge Item DefinitionThe price that Care uses to bill this product to a patient. This is optional.

Status

Product Knowledge and Product use different status values.

Product Knowledge status

StatusDescription
DraftThe catalog entry is not ready for use.
ActiveStaff can use the catalog entry.
RetiredThe catalog entry is no longer in use.

Product status

StatusDescription
ActiveThe facility stocks and dispenses this batch.
InactiveThe facility no longer uses this batch.
Entered in ErrorSomeone created this batch by mistake.

Note: Care has no delete action for these records. Retire a catalog entry, or set a product to Inactive or Entered in Error.

Ownership and Sharing

A product always belongs to one catalog entry and one facility. A catalog entry is either global or private. A superuser manages global catalog entries, and all facilities share them. A facility admin manages the private catalog entries of that facility.

How Products Connect to Stock

An inventory item tracks how much of a product is in stock at one location. Staff most often create a new product while they receive a purchase delivery. When a delivered item is not already in stock, the person who receives the delivery creates the product record for that batch, expiry date, and price.

You can link a product to a charge item definition. Care then creates a billable charge item when staff dispense the product.

Permissions

Permissions apply within a facility.

PermissionRolesWhat it allows
Can Create Product Knowledge on FacilityFacility Admin, AdminCreate and edit catalog entries.
Can Create Product on FacilityFacility Admin, AdminCreate and edit products.
Can Read Product KnowledgeFacility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, PharmacistView catalog entries.
Can Read ProductFacility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, PharmacistView products.