Skip to content
Partner Developer Portal

Schema

Column NameData TypeDescriptionExampleMax LengthIs Null
userinroleguidvarcharUnique identifier for this user-in-role instance. Part of the composite primary key.{G7H8I9J0-K1L2-3456-MNOP-567890123456}38False
organisationguidvarcharReferences the practice this role is attached to.{C3D4E5F6-A7B8-9012-CDEF-123456789012}38False
titlevarcharTitle of the staff member (e.g., Dr, Mr, Mrs).Dr50True
givennamevarcharFirst given name of the staff member.Sarah108True
surnamevarcharFamily name of the staff member.Jones100True
jobcategorycodecharCoded value for the job category (e.g., R0050 for GP).R00505False
jobcategorynamevarcharHuman-readable label for the job category.General Medical Practitioner100False
contractstartdatedateThe date the person started in this role at the organisation.2015-08-013False
contractenddatedateThe date the role ended. Null if still active.2024-07-313True
registrationnumbervarcharProfessional registration number (e.g., GMC number for GPs).123456750True