Skip to content
Partner Developer Portal

Schema

Column NameData TypeDescription
unique_patient_idvarcharA globally unique patient identifier.
organisationvarcharAn organisation is synonymous with a pharmacy and is also known as the RXid.
is_deletedbooleanWhether this record should be considered deleted. Data deleted at source has non-key columns set to null while primary keys are retained.
patient_idintegerUnique patient identifier.
pharmacy_idintegerId of the pharmacy.
patient_full_namevarcharPatient full name. E.g. “COLE, Molly Gary (Mr)”, “COLON, Lucas Shari (Dr)”, “DELGADO, Nick Shanda (Ms)“.
sexvarcharPatient gender.
ethnicityvarcharPatient ethnicity.
last_activity_date_timetimestampThe latest activity date and time for the patient.
last_dispensing_datedateDate the patient had their last pharmacy item dispensed on, if applicable, otherwise null.
birth_datedateThe date the patient was born.
death_datedateThe date the patient died.
is_deceasedbooleanWhether or not the patient has died.
added_date_timetimestampThe date and time the patient was added.
exemption_codevarcharEither a single digit code representing the type of exemption or “Not Exempt”.
is_activebooleanWhether or not the patient has had any dispensing activity in the last 1 year by checking last_dispensing_date. They will automatically be considered inactive if they are deceased.
is_newbooleanWhether or not the patient has been registered in the last 6 months.
patient_ageintegerThe difference between the date of birth and either the date of death or the last modelled date.
patient_age_bucketvarcharThe patient age grouped into named buckets, for example “Newborns (0 days to 30 days)”, “Children (2 years to 12 years)”, “Older adults (65 to 78)“.
patient_nhs_numbervarcharNHS number. 10-digit number, like 3347775786 or 334-777-5786.
patient_nhs_number_hashedvarcharHashed value of the patient NHS number.
eps_registration_status_idintegerInteger identifier for EPS registration status.
eps_registration_statusvarcharEPS registration status (like ‘Not Registered’, ‘Registration Pending’).
additional_service_typevarcharHow the patient receives their products (Collection, Delivery, Collection & Delivery, Walk-in).
is_collectionbooleanWhether or not the additional service type is collection.
is_deliverybooleanWhether or not the additional service type is delivery.
is_pmr_lockedbooleanWhether or not this patient has had the PMR lock applied to it or not. This lock prevents dispensing.
pharmacy_namevarcharThe name of the pharmacy.
branch_identifiervarcharBranch identifier assigned by head office for data exchange workflows.
national_practice_codevarcharPharmacy NacsCode used to identify the pharmacy when the user logs in.
imd_decileintegerIndex of Multiple Deprivation decile of the patient.
emailvarcharPatient email contact address.
home_phone_numbervarcharPatient home phone number.
mobile_phone_numbervarcharPatient mobile phone number.
work_phone_numbervarcharPatient work phone number.
fax_numbervarcharPatient fax number.
row_idvarcharUnique hash generated based on column values, used to identify data changes.
last_updated_datedateDate that this record was last updated by the orchestration process.