Skip to content
Partner Developer Portal

Schema

Column NameData TypeDescription
dispensed_item_deletedbooleanDispensed item deleted flag.
unique_patient_idvarcharA globally unique patient identifier.
organisationvarcharAn organisation is synonymous with a pharmacy and is also known as the RXid.
prescription_item_dispensed_idintegerDispensing identifier. Unique in combination with organisation.
prescription_item_dispensed_guidvarcharA globally unique Prescription identifier.
prescription_idintegerPrescription identifier.
prescription_item_idintegerPrescription item identifier.
prescription_typevarcharPrescription type description.
prescribed_datedatePrescription date.
prescribed_endorsementvarcharEndorsement for prescription.
prescribed_dosagevarcharDosage of prescribed item.
prescribed_quantitynumericPrescribed quantity.
is_opd_appliedbooleanSet to true when original pack dispensing has been applied.
prescribed_productvarcharPrescribed product.
is_owedbooleanA flag that is true when the owing quantity is greater than 0.
owing_datedateThe date when the owing was created.
owing_quantitynumericOwed quantity for a prescribed item.
dispensed_date_timetimestampThe date and time when the item was dispensed on.
dispensed_pack_code_idintegerPack identifier.
dispensed_quantitynumericDispensed quantity.
dispensed_costnumericCost of dispensed item.
dispensed_pricenumericPrice of dispensed item.
dispensed_not_givenbooleanA flag that indicates whether the dispensed item was given to a patient or not.
is_dispensing_activitybooleanA flag that is true when a dispensed item’s is_given flag is true, quantity is more than 0, and is not deleted.
product_pack_sizenumericPack size from PKB.
dispensed_packsnumericPacks dispensed, calculated based on dispensed quantity and product pack size.
product_namevarcharPKB product name.
manufacturer_namevarcharPKB manufacturer name.
product_pack_typeintegerDmd Product Type (0 = VMPP, 1 = AMPP).
product_pack_code_idintegerDmd Pack (VMPP/AMPP) identifier. Relates to Dmd.VirtualProductPack and Dmd.ActualProductPack tables.
virtual_product_pack_idintegerGeneric pack information corresponding to a virtual product. Virtual packs form the base for actual pack equivalents and provide additional data such as unit measure and size links.
virtual_product_namevarcharPKB virtual product name.
dispensed_virtual_product_idintegerUnique Virtual Product identifier of the dispensed item.
dispensed_drug_codevarcharThe DrugCode of the Pack from which the Preparation is derived.
prescribed_virtual_product_idintegerUnique Virtual Product identifier of the prescribed item.
dispensed_pip_codevarcharPIP code of the dispensed drug.
pharmacy_namevarcharThe name of the pharmacy.
surgery_namevarcharSurgery description name.
surgery_registration_codevarcharAlpha-numeric surgery code.
patient_full_namevarcharName of the patient.
patient_birth_datedateBirth date of the patient.
patient_house_number_flat_numbervarcharPatient house number or flat number.
patient_number_and_streetvarcharPatient number and street.
patient_villagevarcharPatient village.
patient_townvarcharPatient town.
patient_post_codevarcharPatient post code.
nursing_home_idintegerIdentifier for the nursing home.
nursing_home_namevarcharName for the nursing home.
nursing_home_typevarcharNursing home type.
nursing_home_house_name_flat_numbervarcharNursing home house name or flat number.
nursing_home_number_and_streetvarcharNursing home number and street.
nursing_home_villagevarcharNursing home village.
nursing_home_townvarcharNursing home town.
nursing_home_post_codevarcharNursing home post code.
nursing_home_address_idintegerIdentifier for the nursing home address.
nursing_home_registrationvarcharNursing home identifier value.
off_site_fulfilmentbooleanIndicates whether the item was fulfilled or dispensed off-site.
bnf_chapter_refsarrayAn array of BNF chapters that the item is referenced in.
uom_descriptionvarcharMeasurement unit of the drug.
preparation_descriptionvarcharText description of the preparation code.
branch_identifiervarcharBranch identifier assigned by the head office. Used when sending and receiving data from a a head office, but otherwise not used by the application.
national_practice_codevarcharPharmacy NacsCode. Used to identify the pharmacy when the user logs in.
non_MDSbooleanBoolean flag indicating whether the prescription item is non-MDS (Medicine Dispensing Service).
audited_clinical_check_datetimestampDate when the clinical check was audited.
audited_clinical_check_pharmacist_idintegerID of the pharmacist who performed the audited clinical check.
audited_clinical_check_user_in_role_idintegerUser in role ID who performed the audited clinical check.
external_accuracy_check_user_and_datevarcharExternal accuracy check user and date information.
row_idvarcharUnique hash generated based on column values, used to identify data changes.
last_updated_datedateThe date that this record was last updated. Its basis is from the ingestion process and is populated by the job orchestration tool.