Skip to content
Partner Developer Portal

Schema

Column NameData TypeDescription
nms_idintegerAuto incrementing primary key for the NMS record.
organisationvarcharAn organisation is synonymous with a pharmacy and is also known as the RXid.
nms_guidvarcharUnique identifier across other systems.
date_nms_addedtimestampThe date and time when the NMS record was added.
date_nms_modifiedtimestampThe date and time when the NMS record was last modified.
patient_idintegerForeign key to the patient record linked to the NMS.
unique_patient_idvarcharUnique identifier for patient across systems.
patient_full_namevarcharFull patient name derived from patient demographics.
patient_ageintegerPatient age at model date, based on birth date and death date where applicable.
patient_nhs_numbervarcharNHS number. 10-digit number like 3347775786 or 334-777-5786.
patient_home_numbervarcharHome contact details of patient.
patient_mobile_numbervarcharMobile contact details of patient.
pharmacist_idintegerForeign key to the pharmacist who did the initial stage.
prescription_idintegerForeign key to the prescription linked to the NMS.
declinedbooleanMarks the NMS record as declined.
region_idsvarcharComma-separated region identifiers derived from NMS drugs and pharmacy region mapping.
nms_item_namevarcharAggregated item name list for NMS drugs.
decline_pharmacist_idintegerPharmacist identifier for who declined the NMS.
escapedbooleanMarks the NMS record as escaped.
asthma_copdbooleanAsthma and COPD flag.
diabetesbooleanDiabetes flag.
antiplatelet_anticoagulant_therapybooleanAntiplatelet or anticoagulant therapy flag.
hypertensionbooleanHypertension flag.
engagement_non_providedbooleanPatient engagement stage non-provided flag.
engagement_dietbooleanPatient engagement stage diet flag.
engagement_physical_activitybooleanPatient engagement stage physical activity flag.
engagement_sexual_healthbooleanPatient engagement stage sexual health flag.
engagement_weight_managementbooleanPatient engagement stage weight management flag.
engagement_smokingbooleanPatient engagement stage smoking flag.
engagement_alcoholbooleanPatient engagement stage alcohol flag.
engagement_pharmacist_idintegerPharmacist identifier for engagement stage.
date_engagement_completedtimestampPatient engagement completed datetime.
intervention_attendedbooleanIntervention stage attended flag.
intervention_not_attended_reasonvarcharIntervention not attended reason text.
intervention_non_providedbooleanIntervention stage non-provided flag.
intervention_dietbooleanIntervention stage diet flag.
intervention_physical_activitybooleanIntervention stage physical activity flag.
intervention_sexual_healthbooleanIntervention stage sexual health flag.
intervention_weight_managementbooleanIntervention stage weight management flag.
intervention_smokingbooleanIntervention stage smoking flag.
intervention_alcoholbooleanIntervention stage alcohol flag.
intervention_pharmacist_idintegerPharmacist identifier for intervention stage.
date_intervention_completedtimestampIntervention completed datetime.
followup_attendedbooleanFollow-up stage attended flag.
followup_not_attended_reasonvarcharFollow-up not attended reason text.
followup_non_providedbooleanFollow-up stage non-provided flag.
followup_dietbooleanFollow-up stage diet flag.
followup_physical_activitybooleanFollow-up stage physical activity flag.
followup_sexual_healthbooleanFollow-up stage sexual health flag.
followup_weight_managementbooleanFollow-up stage weight management flag.
followup_smokingbooleanFollow-up stage smoking flag.
followup_alcoholbooleanFollow-up stage alcohol flag.
followup_pharmacist_idintegerPharmacist identifier for follow-up stage.
date_followup_completedtimestampFollow-up completed datetime.
date_exitedtimestampDatetime when the NMS was exited.
prescriber_prescribing_organisation_idintegerPrescribing organisation identifier associated with the NMS prescription context.
session_idintegerSession ID from appointment session NMS.
session_partsvarcharComma-separated list of session parts recorded against the NMS.
hospital_discharge_notevarcharHospital discharge note text for NMS.
other_notevarcharFree-text other note for NMS.
hypercholesterolaemiabooleanHypercholesterolaemia flag.
osteoporosisbooleanOsteoporosis flag.
goutbooleanGout flag.
glaucomabooleanGlaucoma flag.
epilepsybooleanEpilepsy flag.
parkinsons_diseasebooleanParkinsons disease flag.
urinary_incontinence_retentionbooleanUrinary incontinence retention flag.
heart_failurebooleanHeart failure flag.
acute_coronary_syndromesbooleanAcute coronary syndromes flag.
atrial_fibrillationbooleanAtrial fibrillation flag.
risk_of_embolismbooleanRisk of embolism flag.
stroke_or_transient_ischemic_attackbooleanStroke or transient ischemic attack flag.
coronary_heart_diseasebooleanCoronary heart disease flag.
antidepressantbooleanAntidepressant flag.
drug_given_previously_status_idintegerDrug given previously status identifier used in claimability logic.
nms_statusvarcharOverall NMS status derived from decline, escape, deletion, and stage completion logic.
nms_intervention_statusvarcharDerived intervention-stage status including claimability pathway outcomes.
nms_followup_statusvarcharDerived follow-up-stage status including claimability pathway outcomes.
pharmacy_namevarcharName 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.
is_deletedbooleanWhether this record should be considered deleted. Data deleted at source has non-key columns set to null while primary keys are retained.
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.