Remote Subscriber Database (RSD) Schema (Compass 2): Difference between revisions
No edit summary |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 225: | Line 225: | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
Line 260: | Line 236: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |dbid | ||
|int(11) | |int(11) | ||
|NOT NULL | |NOT NULL | ||
Line 314: | Line 290: | ||
| | | | ||
|- | |- | ||
|updated | |updated | ||
|datetime | |datetime | ||
|NOT NULL | |NOT NULL | ||
Line 324: | Line 300: | ||
== Table: concept_map == | == Table: concept_map == | ||
PRIMARY KEY ( | PRIMARY KEY (id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 350: | Line 326: | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT PRIMARY KEY ( | |id | ||
|int(11) | |||
| | |||
| | |||
| | |||
|- | |||
|deleted | |||
|tinyint(1) | |||
| | |||
| | |||
| | |||
|- | |||
| colspan="5" |CONSTRAINT PRIMARY KEY (id) | |||
|} | |} | ||
== Table: | == Table: diagnostic_order == | ||
PRIMARY KEY (organization_id,person_id,id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 361: | Line 350: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the diagnostic order | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
|The | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
| | | | ||
|- | |- | ||
| | |person_id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |Unique individual across all organisations | ||
| | | | ||
|- | |- | ||
| | |encounter_id | ||
| | |bigint | ||
| | |DEFAULT NULL | ||
| | |Reference to the encounter the observation was recorded at | ||
| | |||
|- | |||
|practitioner_id | |||
|bigint | |||
|DEFAULT NULL | |||
|The clinician the activity is recorded against | |||
| | | | ||
|- | |- | ||
| | |clinical_effective_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date the diagnostic order was identified by a clinician | ||
| | | | ||
|- | |- | ||
| | |date_precision_concept_id | ||
|int | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | ||
| | | | ||
|- | |- | ||
| | |result_value | ||
| | |real | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The value of the result of the observation | ||
| | | | ||
|- | |- | ||
| | |result_value_units | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The units of the result of the observation | ||
| | | | ||
|- | |- | ||
| | |result_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date of the result | ||
| | | | ||
|- | |- | ||
| | |result_text | ||
| | |text | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Any text associated with the result | ||
| | |||
|- | |||
|result_concept_id | |||
|int | |||
|DEFAULT NULL | |||
|Reference to the clinical coding of the result | |||
| | | | ||
|- | |- | ||
| | |is_problem | ||
| | |boolean | ||
| | |NOT NULL | ||
|Whether the | |Whether the observation is marked as a problem | ||
| | | | ||
|- | |- | ||
| | |is_review | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the observation is a review of an existing problem | ||
| | | | ||
|- | |- | ||
| | |problem_end_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The end date of the problem | ||
| | | | ||
|- | |- | ||
| | |parent_observation_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the parent observation in a complex observation eg systolic and diastolic blood pressures will have a parent observation of Blood pressure | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the observation | ||
| | |||
|- | |||
|non_core_concept_id | |||
|int | |||
|DEFAULT NULL | |||
|Reference to the clinical coding of the observation | |||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
| | |decimal (5,2) | ||
| | |DEFAULT NULL | ||
|The age of the patient at the time of the observation | |||
| | | | ||
|- | |||
|episodicity_concept_id | |||
|int | |||
|DEFAULT NULL | |||
|Reference to the episodicity of the problem eg First, review, flare | |||
| | | | ||
|- | |- | ||
| | |is_primary | ||
| | |boolean | ||
| | |DEFAULT NULL | ||
| | |Whether the diagnostic order is a primary order | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT PRIMARY KEY (id) | | colspan="5" |CONSTRAINT pk_diagnostic_order_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | ||
|- | |||
| colspan="5" |CONSTRAINT fk_diagnostic_order_encounter_id FOREIGN KEY (encounter_id) | |||
|- | |||
| colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_diagnostic_order_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | |||
|- | |||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_diagnostic_order_practitioner_id FOREIGN KEY (practitioner_id) | |||
|- | |||
| colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |} | ||
== Table: | == Table: encounter == | ||
PRIMARY KEY (organization_id,person_id,id) | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
Line 512: | Line 515: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the encounter | ||
| | | | ||
|- | |- | ||
Line 533: | Line 536: | ||
| | | | ||
|- | |- | ||
| | |practitioner_id | ||
|bigint | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The clinician the activity is recorded against | ||
| | | | ||
|- | |- | ||
| | |appointment_id | ||
|bigint | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the appointment this encounter took part on | ||
| | | | ||
|- | |- | ||
Line 548: | Line 551: | ||
|date | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The date the | |The date the clinical code is recorded for | ||
| | | | ||
|- | |- | ||
|date_precision_concept_id | | | ||
date_precision_concept_id | |||
|int | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the precision of the date of the encounter | ||
| | | | ||
|- | |- | ||
| | |episode_of_care_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Is this instance of the code a review of a previous encounter | ||
| | | | ||
|- | |- | ||
| | |service_provider_organization_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the service provider organisation | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the type of encounter | ||
| | | | ||
|- | |- | ||
| | |non_core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the type of encounter | ||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
| | |decimal(5,2) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The age the patient was when this encounter took place | ||
| | | | ||
|- | |- | ||
| | |Type | ||
| | |text | ||
| | |DEFAULT NULL | ||
| | |Unused | ||
| | | | ||
|- | |- | ||
| | |sub_type | ||
| | |text | ||
| | |DEFAULT NULL | ||
| | |Unused | ||
| | | | ||
|- | |- | ||
| | |admission_method | ||
| | |varchar(40) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The admission method of the encounter | ||
| | | | ||
|- | |- | ||
| | |end_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The end date of the encounter | ||
| | | | ||
|- | |- | ||
| | |institution_location_id | ||
| | |text | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the | |Reference to the institution the encounter took place at | ||
| | | | ||
|- | |- | ||
| | |date_recorded | ||
| | |datetime | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date the encounter was recorded | ||
| | | | ||
|- | |- | ||
| | | colspan="5" | | ||
CONSTRAINT pk_encounter_id PRIMARY KEY (organization_id,person_id,id), | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_encounter_appointment_id FOREIGN KEY (appointment_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES appointment (id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| colspan="5" | | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_practitioner_id FOREIGN KEY (practitioner_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_episode_of_care_id FOREIGN KEY (episode_of_care_id) | ||
|- | |||
| colspan="5" |REFERENCES episode_of_care (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_encounter_service_provider_organization_id FOREIGN KEY (service_provider_organization_id) | |||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES organization (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
== Table: | == Table: encounter_additional == | ||
PRIMARY KEY ( | PRIMARY KEY (id, property_id, value_id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 674: | Line 673: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |same as the id column on the encounter table | ||
| | | | ||
|- | |- | ||
| | |property_id | ||
| | |int | ||
|NOT NULL | |NOT NULL | ||
| | |IM reference (i.e. Admission method) | ||
| | | | ||
|- | |- | ||
| | |value_id | ||
| | |int | ||
|NOT NULL | |NOT NULL | ||
| | |IM reference (i.e. Emergency admission) | ||
| | | | ||
|- | |- | ||
| | |json_value | ||
| | |JSON | ||
| | |NULL | ||
| | |where there is no mapped value_id, just raw JSON (i.e. birth delivery details) | ||
| | |||
|- | |||
|text_value | |||
|varchar(255) | |||
|NULL | |||
|where there is no mapped value_id, or raw JSON, just a basic text value (i.e. FIN number) | |||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_encounter_additional_id PRIMARY KEY (id, property_id, value_id) | ||
|} | |||
== Table: encounter_event == | |||
PRIMARY KEY (organization_id, person_id, id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |||
|id | |||
|bigint | |bigint | ||
| | |NOT NULL | ||
| | |Unique Id of the encounter event | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
|bigint | |bigint | ||
| | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint | ||
| | |NOT NULL | ||
|The | |The patient this event belongs to | ||
| | | | ||
|- | |- | ||
|person_id | |||
|bigint | |||
|NOT NULL | |||
|The person this event belongs to | |||
| | | | ||
|- | |||
| | |encounter_id | ||
| | |bigint | ||
|Reference to the | |NOT NULL | ||
|Reference to the parent encounter record | |||
| | | | ||
|- | |- | ||
| | |practitioner_id | ||
|bigint | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The clinician the activity is recorded against | ||
| | | | ||
|- | |- | ||
| | |appointment_id | ||
|bigint | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the | |Reference to the appointment this encounter took part on | ||
| | | | ||
|- | |- | ||
| | |clinical_effective_date | ||
| | |datetime | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date the encounter took place | ||
| | | | ||
|- | |- | ||
|non_core_concept_id | |date_precision_concept_id | ||
|int | |||
|DEFAULT NULL | |||
|Reference to the precision of the date of the encounter | |||
| | |||
|- | |||
|episode_of_care_id | |||
|bigint | |||
|DEFAULT NULL | |||
|Reference to the episode of care this encounter belongs to | |||
| | |||
|- | |||
|service_provider_organization_id | |||
|bigint | |||
|DEFAULT NULL | |||
|Reference to the service provider organisation | |||
| | |||
|- | |||
|core_concept_id | |||
|int | |||
|DEFAULT NULL | |||
|Reference to the type of encounter | |||
| | |||
|- | |||
|non_core_concept_id | |||
|int | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
Line 747: | Line 793: | ||
|decimal(5,2) | |decimal(5,2) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The age the patient | |The age of the patient at the time of the encounter | ||
| | | | ||
|- | |- | ||
| | |type | ||
|text | |text | ||
|DEFAULT NULL | |DEFAULT NULL | ||
Line 775: | Line 821: | ||
|- | |- | ||
|institution_location_id | |institution_location_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the institution the encounter took place at | |Reference to the institution the encounter took place at | ||
Line 786: | Line 832: | ||
| | | | ||
|- | |- | ||
| | |finished | ||
|boolean | |||
|DEFAULT NULL | |||
|Whether the encounter is finished | |||
| | |||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT pk_encounter_event_id PRIMARY KEY (organization_id, person_id, id), | ||
|- | |- | ||
| colspan="5" |CONSTRAINT fk_encounter_event_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | |||
| colspan="5" |CONSTRAINT | |||
|- | |- | ||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
Line 801: | Line 846: | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_event_practitioner_id FOREIGN KEY (practitioner_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
Line 807: | Line 852: | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_event_episode_of_care_id FOREIGN KEY (episode_of_care_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES episode_of_care (id) MATCH SIMPLE | | colspan="5" |REFERENCES episode_of_care (id) MATCH SIMPLE | ||
Line 813: | Line 858: | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_encounter_event_service_provider_organization_id FOREIGN KEY (service_provider_organization_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES organization (id) MATCH SIMPLE | | colspan="5" |REFERENCES organization (id) MATCH SIMPLE | ||
Line 820: | Line 865: | ||
|} | |} | ||
== Table: | == Table: episode_of_care == | ||
PRIMARY KEY ( | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 832: | Line 877: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |Unique Id of the episode of care | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | |organization.id | ||
|- | |- | ||
| | |patient_id | ||
|bigint | |||
|NOT NULL | |||
|The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | |||
|patient.id | |||
|- | |||
|person_id | |||
|bigint | |||
|NOT NULL | |||
|Unique individual across all organisations | |||
|person.id | |||
|- | |||
|registration_type_concept_id | |||
|int | |int | ||
| | |DEFAULT NULL | ||
| | |Reference to the registration type of the patient | ||
|registration.type.id | |||
|- | |- | ||
| | |registration_status_concept_id | ||
| | |int | ||
|NULL | |DEFAULT NULL | ||
| | |Reference to the registration status of the patient | ||
| | | | ||
|- | |- | ||
| | |date_registered | ||
| | |date | ||
|NULL | |DEFAULT NULL | ||
| | |The date the registration was started for this episode of care | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | |date_registered_end | ||
|date | |||
|DEFAULT NULL | |||
|The date the registration was ended for this episode of care | |||
| | |||
|- | |||
|usual_gp_practitioner_id | |||
|bigint | |||
|DEFAULT NULL | |||
|Reference to the usual GP for this episode of care | |||
|Practitioner.id | |||
|- | |||
| colspan="5" |CONSTRAINT pk_episode_of_care_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | |||
|- | |||
| colspan="5" |CONSTRAINT fk_episode_of_care_patient_id_organisation_id FOREIGN KEY (patient_id, organization_id) | |||
|- | |||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_episode_of_care_practitioner_id FOREIGN KEY (usual_gp_practitioner_id) | |||
|- | |||
| colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |} | ||
== Table: | == Table: event_log == | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 871: | Line 951: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |dt_change | ||
| | |datetime(3) | ||
|NOT NULL | |NOT NULL | ||
| | |date time the change was made to this DB | ||
| | | | ||
|- | |- | ||
| | |change_type | ||
| | |tinyint | ||
|NOT NULL | |NOT NULL | ||
| | |type of transaction 0=insert, 1=update, 2=delete | ||
| | | | ||
|- | |- | ||
| | |table_id | ||
| | |tinyint | ||
|NOT NULL | |NOT NULL | ||
| | |identifier of the table changed | ||
| | | | ||
|- | |- | ||
| | |record_id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |id of the record changed | ||
| | | | ||
|} | |||
== Table: flag == | |||
PRIMARY KEY (organization_id,person_id,id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |- | ||
| | |id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Unique Id of the flag | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
|bigint | |bigint(20) | ||
| | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
|bigint | |bigint(20) | ||
| | |NOT NULL | ||
| | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
| | |patient.id | ||
|- | |||
|person_id | |||
|bigint(20) | |||
|NOT NULL | |||
|Unique individual across all organisations | |||
|person.id | |||
|- | |- | ||
| | |effective_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The date the | |The date the flag was entered onto the patients record | ||
| | | | ||
|- | |- | ||
Line 922: | Line 1,018: | ||
|int | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | ||
| | | | ||
|- | |- | ||
| | |is_active | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the flag is active or not | ||
| | | | ||
|- | |- | ||
| | |flag_text | ||
| | |text | ||
| | | | ||
| | |This is a warning set by the publisher regarding he patient | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_flag_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_flag_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
| | |} | ||
| | |||
| | == Table: location == | ||
PRIMARY KEY (pk_location_id PRIMARY KEY id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |||
|id | |||
|bigint | |||
|NOT NULL | |||
|Unique Id of the location | |||
| | | | ||
|- | |- | ||
| | |name | ||
|varchar( | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The name of a location set by the publisher. E.g. ward, clinic, domiciliary | ||
| | | | ||
|- | |- | ||
| | |type_code, | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The type of location | ||
| | | | ||
|- | |- | ||
| | |type_desc | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Textual description of the type of location eg GP Practice | ||
| | | | ||
|- | |- | ||
| | |postcode | ||
| | |varchar10) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The postcode of the location | ||
| | | | ||
|- | |- | ||
| | |managing_organization_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the managing organisation of the location | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT pk_location_id PRIMARY KEY (id) | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_location_organisation_id FOREIGN KEY (managing_organization_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES organization (id) | ||
|- | |- | ||
| colspan="5" | | | colspan="5" |MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |||
== Table: medication_order == | |||
PRIMARY KEY (organization_id,person_id,id) | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |||
== Table: | |||
PRIMARY KEY (organization_id,person_id,id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 1,036: | Line 1,110: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the medication order | ||
| | | | ||
|- | |- | ||
Line 1,042: | Line 1,116: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. | |Owning organisation (i.e. publisher) | ||
|organization.id | |organization.id | ||
|- | |- | ||
Line 1,054: | Line 1,128: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique individual across all organisations | |Unique individual across all organisations | ||
|person.id | |person.id | ||
|- | |- | ||
| | |encounter_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the | |Reference to the encounter the medication order was issued in | ||
| | |encounter.id | ||
|- | |- | ||
| | |practitioner_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The clinician the activity is recorded against | ||
| | |practitioner.id | ||
|- | |- | ||
| | |clinical_effective_date | ||
|date | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The date the | |The date the medication order was issued | ||
| | | | ||
|- | |- | ||
| | |date_precision_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | ||
| | | | ||
|- | |- | ||
| | |dose | ||
| | |varchar(1000) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Textual description of the dose | ||
| | | | ||
|- | |- | ||
| | |quantity_value | ||
|real | |||
|DEFAULT NULL | |||
|The value of the medication that was prescribed eg 50 | |||
| | |||
|- | |- | ||
| | |quantity_unit | ||
|varchar(255) | |||
|DEFAULT NULL | |||
|The unit of the medication that was prescribed eg tablets | |||
| | |||
|- | |- | ||
| | |duration_days | ||
|int | |||
|DEFAULT NULL | |||
|How many days the medication is prescribed for | |||
| | |||
| | |||
| | |||
| | | | ||
|- | |- | ||
| | |estimated_cost | ||
| | |real | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The estimated cost of the medication | ||
| | | | ||
|- | |- | ||
| | |medication_statement_id | ||
|bigint | |||
|DEFAULT NULL | |||
|Reference to the medication statement. A medication statement can have many medication orders | |||
|medication.statement.id | |||
| | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | |core_concept_id | ||
| | |int | ||
| | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the medication | ||
| | | | ||
|- | |- | ||
| | |non_core_concept_id | ||
| | |int | ||
| | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the medication | ||
| | | | ||
|- | |- | ||
| | |bnf_reference | ||
| | |varchar(6) | ||
| | |DEFAULT NULL | ||
| | |A reference to the drug in the BNF dictionary | ||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
| | |decimal(5,2) | ||
| | |DEFAULT NULL | ||
| | |The age the patient was at the time of this event | ||
| | |||
|- | |||
|issue_method | |||
|text | |||
|DEFAULT NULL | |||
|The issue method of the medication eg hand written | |||
| | | | ||
|- | |||
| colspan="5" |CONSTRAINT pk_medication_order_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | |||
|- | |||
| colspan="5" |CONSTRAINT fk_medication_order_encounter_id FOREIGN KEY (encounter_id) | |||
|- | |||
| colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_medication_order_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | |||
|- | |||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_medication_order_practitioner_id FOREIGN KEY (practitioner_id) | |||
|- | |||
| colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |} | ||
== Table: | == Table: medication_statement == | ||
PRIMARY KEY (organization_id,person_id,id) | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
Line 1,171: | Line 1,254: | ||
|bigint(20) | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the medication | ||
| | | | ||
|- | |- | ||
Line 1,178: | Line 1,261: | ||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. publisher) | |Owning organisation (i.e. publisher) | ||
| | |organization.id | ||
|- | |- | ||
|patient_id | |patient_id | ||
Line 1,192: | Line 1,275: | ||
|person.id | |person.id | ||
|- | |- | ||
| | |encounter_id | ||
|bigint(20) | |||
|DEFAULT NULL | |||
|Reference to the encounter this medication was recorded in | |||
|encounter.id | |||
|- | |||
|practitioner_id | |||
|bigint(20) | |||
|DEFAULT NULL | |||
|The clinician the activity is recorded against | |||
|practitioner.id | |||
|- | |||
|clinical_effective_date | |||
|date | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The date the | |The date the medication was clinical relevant | ||
| | | | ||
|- | |- | ||
|date_precision_concept_id | |date_precision_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) | |Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | ||
| | | | ||
|- | |- | ||
|is_active | |is_active | ||
| | |boolean | ||
| | |DEFAULT NULL | ||
|Whether the | |Whether the medication is active or not | ||
| | | | ||
|- | |- | ||
| | |cancellation_date | ||
| | |date | ||
|DEFAULT NULL | |||
|The date the medication was cancelled | |||
| | | | ||
| | |- | ||
|dose | |||
|varchar(1000) | |||
|DEFAULT NULL | |||
|Texual description of the dose of the medication | |||
| | | | ||
|- | |- | ||
| | |quantity_value | ||
|real | |||
|DEFAULT NULL | |||
|The value of the medication that was prescribed eg 50 | |||
| | |||
| | |||
| | |||
| | | | ||
|- | |- | ||
| | |quantity_unit | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The unit of the medication that was prescribed eg tablets | ||
| | | | ||
|- | |- | ||
| | |authorisation_type_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the authorisation type | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the medication | ||
| | | | ||
|- | |- | ||
| | |non_core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the medication | ||
| | | | ||
|- | |- | ||
| | |bnf_reference | ||
| | |varchar(6) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |A reference to the drug in the BNF dictionary | ||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
|decimal(5,2) | |||
|DEFAULT NULL | |||
|The age the patient was at the time of this event | |||
| | |||
|- | |- | ||
| colspan="5" |CONSTRAINT | |Issue_method | ||
|text | |||
|DEFAULT NULL | |||
|The issue method of the medication eg hand written | |||
| | |||
|- | |||
| colspan="5" |CONSTRAINT pk_medication_statement_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | |||
|- | |||
| colspan="5" |CONSTRAINT fk_medication_statement_encounter_id FOREIGN KEY (encounter_id) | |||
|- | |||
| colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |||
| colspan="5" |CONSTRAINT fk_medication_statement_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | |||
|- | |||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | |||
|- | |- | ||
| colspan="5" | | | colspan="5" |CONSTRAINT fk_medication_statement_practitioner_id FOREIGN KEY (practitioner_id) | ||
|- | |- | ||
| colspan="5" |MATCH SIMPLE | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
== Table: | == Table: observation == | ||
PRIMARY KEY (organization_id,person_id,id) | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
Line 1,291: | Line 1,396: | ||
|- | |- | ||
|id | |id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the observation | ||
| | | | ||
|- | |- | ||
|organization_id | |organization_id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. publisher) | |Owning organisation (i.e. publisher) | ||
|organization.id | |organization.id | ||
|- | |- | ||
|patient_id | |patient_id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
Line 1,309: | Line 1,414: | ||
|- | |- | ||
|person_id | |person_id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|Unique individual across all organisations | |Unique individual across all organisations | ||
Line 1,315: | Line 1,420: | ||
|- | |- | ||
|encounter_id | |encounter_id | ||
|bigint | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the encounter the | |Reference to the encounter the observation was recorded at | ||
|encounter.id | |encounter.id | ||
|- | |- | ||
|practitioner_id | |practitioner_id | ||
|bigint | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The clinician the activity is recorded against | |The clinician the activity is recorded against | ||
Line 1,329: | Line 1,434: | ||
|date | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The date the | |The date the observation was identified by a clinician | ||
| | | | ||
|- | |- | ||
Line 1,338: | Line 1,443: | ||
| | | | ||
|- | |- | ||
| | |result_value | ||
| | |rea | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The value of the result of the observation | ||
| | | | ||
|- | |- | ||
| | |result_value_units | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The units of the result of the observation | ||
| | | | ||
|- | |- | ||
| | |result_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The date of the result | ||
| | | | ||
|- | |- | ||
| | |result_text | ||
| | |text | ||
| | | | ||
| | |Any text associated with the result | ||
| | | | ||
|- | |- | ||
| | |result_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the result | ||
| | | | ||
|- | |- | ||
| | |is_problem | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the observation is marked as a problem | ||
| | | | ||
|- | |- | ||
| | |is_review | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the observation is a review of an existing problem | ||
| | | | ||
|- | |- | ||
| | |problem_end_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The end date of the problem | ||
| | | | ||
|- | |- | ||
| | |parent_observation_id | ||
| | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the parent observation in a complex observation eg systolic and diastolic blood pressures will have a parent observation of Blood pressure | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the observation | ||
| | | | ||
|- | |- | ||
| | |non_core_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the observation | ||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
|decimal (5,2) | |||
|DEFAULT NULL | |||
|The age of the patient at the time of the observation | |||
| | |||
|- | |- | ||
| | |episodicity_concept_id | ||
|int | |||
|DEFAULT NULL | |||
|Reference to the episodicity of the problem eg First, review, flare | |||
| | |||
|- | |- | ||
| colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | |is_primary | ||
|boolean | |||
|DEFAULT NULL | |||
|Whether the observation is a primary observation | |||
| | |||
|- | |||
|date_recorded | |||
|datetime | |||
|DEFAULT NULL | |||
|The date the observation was recorded in the system | |||
| | |||
|- | |||
| colspan="5" |CONSTRAINT pk_observation_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | |||
|- | |||
| colspan="5" |CONSTRAINT fk_observation_encounter_id FOREIGN KEY (encounter_id) | |||
|- | |||
| colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | |||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_observation_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
Line 1,418: | Line 1,547: | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_observation_practitioner_id FOREIGN KEY (practitioner_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
Line 1,425: | Line 1,554: | ||
|} | |} | ||
== Table: | == Table: observation_additional == | ||
PRIMARY KEY ( | PRIMARY KEY (id, property_id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 1,435: | Line 1,564: | ||
|- | |- | ||
|id | |id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |property_id | ||
| | |int | ||
|NOT NULL | |NOT NULL | ||
| | |IM reference (i.e. significance) | ||
| | | | ||
|- | |- | ||
| | |value_id | ||
| | |int | ||
| | |NULL | ||
| | |IM reference (i.e. minor, significant) | ||
|person.id | |person.id | ||
|- | |- | ||
| | |json_value | ||
| | |json | ||
| | |NULL | ||
| | |Where there is no mapped value_id, just raw JSON | ||
| | | | ||
|- | |- | ||
| | |text_value | ||
| | |varchar(255) | ||
| | |NULL | ||
| | |Where there is no mapped value_id or raw JSON, just a basic text value | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_observation_additional_id PRIMARY KEY (id, property_id) | ||
| | |} | ||
| | |||
| | == Table: organization == | ||
PRIMARY KEY (pk_organization_id PRIMARY KEY (id)) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |||
|id | |||
|bigint | |||
|NOT NULL | |||
|Unique Id of the organisation | |||
| | | | ||
|- | |- | ||
| | |ods_code | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |ODS Code of the organisation | ||
| | | | ||
|- | |- | ||
| | |Name | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Name of the organisation | ||
| | | | ||
|- | |- | ||
| | |type_code | ||
|varchar( | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The type of organisation | ||
| | | | ||
|- | |- | ||
| | |type_desc | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Textual description of the type of organisation eg GP Practice | ||
| | | | ||
|- | |- | ||
| | |Postcode | ||
| | |varchar(10) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The postcode of the organisation | ||
| | | | ||
|- | |- | ||
| | |parent_organization_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The id of the parent organisation | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |PRIMARY KEY pk_organization_id PRIMARY KEY (id) | ||
| | |} | ||
| | |||
| | == Table: organization_metadata == | ||
| | PRIMARY KEY (id, publishing_software) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |- | ||
| | |id | ||
|varchar( | |bigint | ||
|NOT NULL | |||
|corresponds to same ID in the organizaton table | |||
| | |||
|- | |||
|publishing_software | |||
|varchar(50) | |||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |software name of publishing system | ||
| | | | ||
|- | |- | ||
| | |last_data_to_dds | ||
| | |datetime | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |date time data was last sent to DDS | ||
| | | | ||
|- | |- | ||
| | |last_data_cutoff | ||
| | |datetime | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |cutoff date time of the last extract from the publishing system | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT pk_organization_metadata PRIMARY KEY (id, publishing_software) | ||
|} | |||
== Table: patient == | |||
PRIMARY KEY (organization_id,person_id,id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |- | ||
| | |id | ||
|bigint | |||
|NOT NULL | |||
|Unique Id of the patient | |||
| | |||
|- | |- | ||
| | |organization_id | ||
|bigint | |||
|NOT NULL | |||
|Owning organisation (i.e. publisher) | |||
|organization.id | |||
|- | |- | ||
| | |person_id | ||
|bigint | |||
|NOT NULL | |||
|Unique individual across all organisations | |||
|person.id | |||
|- | |- | ||
| | |title | ||
|varchar(255) | |||
| | |||
|The title of the patient | |||
| | |||
|- | |- | ||
| | |first_names | ||
|varchar(255) | |||
| | |||
|The first names of the patient | |||
| | |||
|- | |- | ||
| | |last_name | ||
|varchar(255) | |||
| | |||
|The last name of the patient | |||
| | |||
|- | |- | ||
| | |gender_concept_id | ||
|int | |||
| | |||
|Reference to the gender of the patient | |||
|patient.gender.id | |||
|- | |- | ||
| | |nhs_number | ||
|varchar(255) | |||
| | |||
|The NHS number of the patient | |||
| | |||
|- | |- | ||
| | |date_of_birth | ||
| | |date | ||
| | |||
|The date of birth of the patient | |||
| | |||
| | | | ||
|- | |- | ||
| | |date_of_death | ||
| | |date | ||
| | | | ||
| | |The date of death of the patient | ||
| | | | ||
|- | |- | ||
| | |current_address_id | ||
|bigint | |bigint | ||
| | | | ||
| | |Reference to the current address of the patient | ||
| | | | ||
|- | |- | ||
| | |ethnic_code_concept_id | ||
| | |int | ||
| | | | ||
| | |Reference to the ethnicity of the patient | ||
| | | | ||
|- | |- | ||
| | |registered_practice_organization_id | ||
|bigint | |bigint | ||
| | | | ||
|Reference to the | |Reference to the organisation the patient is registered at | ||
| | | | ||
|- | |- | ||
| | |birth_year | ||
| | |smallint | ||
| | | | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |birth_month | ||
| | |tinyint | ||
| | | | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |birth_week | ||
| | |tinyint | ||
| | | | ||
| | | | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_patient_id_organization_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | ||
| | |- | ||
| | | colspan="5" |CONSTRAINT fk_patient_organization_id FOREIGN KEY (organization_id) | ||
| | |- | ||
| | | colspan="5" |REFERENCES organization (id) MATCH SIMPLE | ||
|} | |||
== Table: patient_additional == | |||
PRIMARY KEY (id, property_id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |- | ||
| | |id | ||
| | |bigint | ||
| | |NOT NULL | ||
| | |Unique Id of the patient | ||
| | | | ||
|- | |- | ||
| | |property_id | ||
| | |int | ||
| | |NOT NULL | ||
| | |IM reference (e.g. cause of death) | ||
| | | | ||
|- | |- | ||
| | |value_id | ||
| | |int | ||
| | |NULL | ||
| | |IM reference (e.g. COVID) | ||
| | |person.id | ||
|- | |- | ||
| | |json_value | ||
| | |json | ||
| | |NULL | ||
| | |Where there is no mapped value_id, just raw JSON | ||
| | | | ||
|- | |- | ||
| | |text_value | ||
| | |varchar(255) | ||
| | |NULL | ||
| | |Where there is no mapped value_id or raw JSON, just a basic text value | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_patient_additional_id PRIMARY KEY (id, property_id) | ||
| | |} | ||
| | |||
| | == Table: patient_address == | ||
| | PRIMARY KEY (organization_id,id,patient_id,person_id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |- | ||
| | |Id | ||
|bigint | |bigint | ||
| | |NOT NULL | ||
| | |Unique Id of the address | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint | ||
| | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | |organisation.id | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint | ||
|NOT NULL | |||
|The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | |||
|patient.id | |||
|- | |||
|person_id | |||
|bigint | |||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Unique individual across all organisations | ||
| | |person.id | ||
|- | |- | ||
| | |address_line_1 | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The first line of the address | ||
| | | | ||
|- | |- | ||
| | |address_line_2 | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The second line of the address | ||
| | | | ||
|- | |- | ||
| | |address_line_3 | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The third line of the address | ||
| | | | ||
|- | |- | ||
| | |address_line_4 | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The fourth line of the address | ||
| | | | ||
|- | |- | ||
| | |city | ||
|varchar(255) | |||
|DEFAULT NULL | |||
|The city | |||
| | |||
|- | |- | ||
| | |postcode | ||
|varchar(255) | |||
|DEFAULT NULL | |||
|The postcode | |||
| | |||
|- | |- | ||
| | |use_concept_id | ||
|int | |||
|NOT NULL | |||
|use of address (e.g. home, temporary) | |||
| | |||
|- | |- | ||
| | |start_date | ||
|date | |||
|NOT NULL | |||
|The start date of this address being relevant | |||
| | |||
|- | |- | ||
| | |end_date | ||
|date | |||
|DEFAULT NULL | |||
|The end date of this address being relevant | |||
| | |||
|- | |- | ||
| | |lsoa_2001_code | ||
|varchar(9) | |||
|DEFAULT NULL | |||
|A reference to the LSOA_2001 code | |||
| | |||
|- | |- | ||
| | |lsoa_2011_code | ||
|varchar(9) | |||
| | |DEFAULT NULL | ||
|A reference to the LSOA_2011 code | |||
| | |||
| | |||
| | | | ||
|- | |- | ||
| | |msoa_2001_code | ||
|varchar( | |varchar(9) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |A reference to the MSOA_2001 code | ||
| | | | ||
|- | |- | ||
| | |msoa_2011_code | ||
|varchar( | |varchar(9) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |A reference to the MSOA_2011 code | ||
| | | | ||
|- | |- | ||
| | |ward_code | ||
|varchar( | |varchar(9) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The ward the address belongs to | ||
| | | | ||
|- | |- | ||
| | |local_authority_code | ||
|varchar( | |varchar(9) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The local authority the address belongs to | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_organization_id_id_patient_id_person_id | ||
| | |- | ||
| | | colspan="5" |PRIMARY KEY (`organization_id`,`id`,`patient_id`,`person_id`) | ||
| | |||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_patient_address_patient_id_organization_id | ||
| | |||
|- | |- | ||
| colspan="5" | | | colspan="5" |FOREIGN KEY (patient_id, organization_id) | ||
|} | |- | ||
| colspan="5" |REFERENCES patient (id, organization_id) | |||
== Table: | |- | ||
PRIMARY KEY ( | | colspan="5" |COMMENT 'stores address details for patients' | ||
|} | |||
== Table: patient_address_match == | |||
PRIMARY KEY(id, uprn) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 1,800: | Line 1,985: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |Id | ||
|bigint | |bigint(50) | ||
|NOT NULL | |NOT NULL | ||
| | |Reference to the patient_address table | ||
| | | | ||
|- | |- | ||
| | |patient_address_id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |Uprn | ||
| | |varchar(255) | ||
|NOT NULL | |NOT NULL | ||
|Unique | |The Unique Propery Reference Number of the address | ||
| | | | ||
|- | |- | ||
| | |uprn_ralf00 | ||
|varchar(255) | |varchar(255) | ||
| | | | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |Status | ||
| | |tinyint(1) | ||
|DEFAULT NULL | |||
|Whether the UPRN is active | |||
| | | | ||
| | |- | ||
|uprn_property_classification | |||
|varchar(45) | |||
|DEFAULT NULL | |||
|Building type eg flat, pub, house etc | |||
| | | | ||
|- | |- | ||
| | |Latitude | ||
| | |double | ||
| | |DEFAULT NULL | ||
|The | |The latitude of the UPRN | ||
| | | | ||
|- | |- | ||
| | |Longitude | ||
| | |double | ||
|DEFAULT NULL | |||
|The longitude of the UPRN | |||
| | | | ||
|- | |- | ||
| | |uprn_xcoordinate | ||
| | |double | ||
| | |DEFAULT NULL | ||
|The | |The x coordinate of the UPRN | ||
| | | | ||
|- | |- | ||
| | |uprn_ycoordinate | ||
| | |double | ||
|DEFAULT NULL | |||
|The y coordinate of the UPRN | |||
| | | | ||
| | |- | ||
|qualifier | |||
|varchar(50) | |||
|DEFAULT NULL | |||
|How the match is determined eg equivalent match, near match etc | |||
| | | | ||
|- | |- | ||
| | |match_rule | ||
| | |varchar(4096) | ||
|DEFAULT NULL | |||
|Which algorithm was used to match the address to the UPRN | |||
| | | | ||
|The date | |- | ||
|match_date | |||
|datetime | |||
|DEFAULT NULL | |||
|The date the match was made | |||
| | | | ||
|- | |- | ||
| | |abp_address_number | ||
| | |varchar(255) | ||
| | |DEFAULT NULL | ||
| | |The number value of the address in the ABP dictionary | ||
| | | | ||
|- | |- | ||
| | |abp_address_street | ||
| | |varchar(255) | ||
|DEFAULT NULL | |||
|The street value of the address in the ABP dictionary | |||
| | | | ||
| | |- | ||
|abp_address_locality | |||
|varchar(255) | |||
|DEFAULT NULL | |||
|The locality value of the address in the ABP dictionary | |||
| | | | ||
|- | |- | ||
| | |abp_address_town | ||
| | |varchar(255) | ||
|DEFAULT NULL | |||
|The town value of the address in the ABP dictionary | |||
| | | | ||
| | |- | ||
|abp_address_postcode | |||
|varchar(10) | |||
|DEFAULT NULL | |||
|The postcode value of the address in the ABP dictionary | |||
| | | | ||
|- | |- | ||
| | |abp_address_organization | ||
| | |varchar(255) | ||
| | |DEFAULT NULL | ||
| | |The organization value of the address in the ABP dictionary | ||
| | | | ||
|- | |- | ||
| | |match_pattern_postcode | ||
| | |varchar(255) | ||
| | |DEFAULT NULL | ||
| | |The qualifier used to match the postcode | ||
| | | | ||
|- | |- | ||
| | |match_pattern_street | ||
| | |varchar(255) | ||
|DEFAULT NULL | |||
|The qualifier used to match the street | |||
| | |||
|- | |||
|match_pattern_number | |||
|varchar(255) | |||
|DEFAULT NULL | |||
|The qualifier used to match the number | |||
| | | | ||
|- | |||
|match_pattern_building | |||
|varchar(255) | |||
|DEFAULT NULL | |||
|The qualifier used to match the building | |||
| | | | ||
|- | |||
|match_pattern_flat | |||
|varchar(255) | |||
|DEFAULT NULL | |||
|The qualifier used to match the flat | |||
| | | | ||
|- | |- | ||
| | |algorithm_version | ||
|varchar(255) | |||
|DEFAULT NULL | |||
|What version of the algorithm was used to make the match | |||
| | |||
|- | |- | ||
| | |epoc | ||
|varchar(255) | |||
|DEFAULT NULL | |||
|The version of the ABP files the addresses were matched against | |||
| | |||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" | CONSTRAINT `patient_address_uprn_patient_address_id_fk` FOREIGN KEY (`patient_address_id`) REFERENCES `patient_address` (`id`) | ||
|} | |} | ||
== Table: | == Table: patient_address_ralf == | ||
PRIMARY KEY (id, | PRIMARY KEY (id, patient_address_id, patient_address_match_uprn_ralf00) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 1,912: | Line 2,153: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |Id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint | ||
|NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |person_id | ||
| | |bigint | ||
|NULL | |NOT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | |patient_address_id | ||
|bigint | |||
|NOT NULL | |||
| | |||
| | |||
|- | |||
|patient_address_match_uprn_ralf00 | |||
|varchar(255) | |||
|NOT NULL | |||
| | |||
| | |||
|- | |||
|salt_name | |||
|varchar(50) | |||
|NOT NULL | |||
| | |||
| | |||
|- | |||
|ralf | |||
|varchar(255) | |||
|NOT NULL | |||
| | |||
| | |||
|- | |||
| colspan="5" |CONSTRAINT pk_patient_address_ralf PRIMARY KEY (id, patient_address_id, patient_address_match_uprn_ralf00) | |||
|- | |||
| colspan="5" |CONSTRAINT fk_patient_address_ralf_organization_id FOREIGN KEY (organization_id) REFERENCES organization (id) | |||
|- | |||
| colspan="5" |CONSTRAINT fk_patient_address_ralf_patient_id FOREIGN KEY (patient_id) REFERENCES patient (id) | |||
|- | |||
| colspan="5" |CONSTRAINT fk_patient_address_ralf_person_id FOREIGN KEY (person_id) REFERENCES person (id) | |||
|- | |||
| colspan="5" |CONSTRAINT fk_patient_address_ralf_patient_address_id FOREIGN KEY (patient_address_id) REFERENCES patient_address (id) | |||
|} | |} | ||
== Table: | == Table: patient_contact == | ||
PRIMARY KEY (organization_id,id,patient_id,person_id) | PRIMARY KEY (organization_id,id,patient_id,person_id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
Line 1,954: | Line 2,221: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the patient contact | ||
| | | | ||
|- | |- | ||
Line 1,963: | Line 2,230: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. | |Owning organisation (i.e. publisher) | ||
| | | | ||
|- | |- | ||
|patient_id | |patient_id | ||
Line 1,978: | Line 2,245: | ||
|person.id | |person.id | ||
|- | |- | ||
| | |use_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |use of contact (e.g. mobile, home,work | ||
| | | | ||
|- | |- | ||
| | |type_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |type of contact (e.g. phone, email) | ||
| | | | ||
|- | |- | ||
| | |start_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The start date of the contact being valid | ||
| | | | ||
|- | |- | ||
| | |end_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The end date of the contact being valid | ||
| | | | ||
|- | |- | ||
| | |value | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The value of the contact information eg phone number, email address | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_organization_id_id_patient_id_person_id PRIMARY KEY (`organization_id`,`id`,`patient_id`,`person_id`), | ||
| | |- | ||
| | | colspan="5" |CONSTRAINT fk_patient_contact_patient_id_organisation_id FOREIGN KEY (patient_id, organization_id) | ||
| | |- | ||
| colspan="5" |REFERENCES patient (id, organization_id) | |||
|- | |||
| colspan="5" |COMMENT 'stores contact details (e.g. phone) for patients' | |||
|} | |||
== Table: patient_pseudo_id == | |||
PRIMARY KEY(organization_id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |||
|Id | |||
|bigint(20) | |||
|NOT NULL | |||
|Unique Id of the patient pseudo id | |||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Reference to the patient this registration status history belongs to | ||
| | | | ||
|- | |- | ||
| | |person_id | ||
| | |bigint(20) | ||
| | |NOT NULL | ||
| | |Reference to the person this registration status history belongs to | ||
| | | | ||
|- | |- | ||
| | |salt_name | ||
|varchar( | |varchar(50) | ||
| | |NOT NULL | ||
| | |The name of the salt used to create the pseudo id | ||
| | | | ||
|- | |- | ||
| | |Skid | ||
|varchar( | |varchar(255) | ||
| | |NOT NULL | ||
| | |"Secure Key IDentifier" - the pseudonymised ID generated for this patient using the salt specified in the salt_name column. Typically generated from patient NHS number, but is configurable on a case by case basis (e.g. may include date of birth) | ||
| | | | ||
|- | |- | ||
| | |is_nhs_number_valid | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the nhs number is valid | ||
| | | | ||
|- | |- | ||
| | |is_nhs_number_verified_by_publisher | ||
| | |boolean | ||
| | |NOT NULL | ||
| | |Whether the nhs number has been verified by the publisher | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT PRIMARY KEY (organization_id) | |||
| colspan="5" |CONSTRAINT | |||
|- | |- | ||
| colspan="5" |CONSTRAINT fk_patient_pseudo_id FOREIGN KEY (patient_id, organization_id) | |||
| colspan="5" |CONSTRAINT | |||
|- | |- | ||
| colspan="5" |REFERENCES patient (id, organization_id) | | colspan="5" |REFERENCES patient (id, organization_id) | ||
|} | |} | ||
== Table: | == Table: patient_uprn == | ||
PRIMARY KEY(id | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 2,090: | Line 2,357: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |patient_id | ||
|bigint(20) | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
| | |patient.id | ||
|- | |||
|organization_id | |||
|bigint(20) | |||
|NOT NULL | |||
|Owning organisation (i.e. publisher) | |||
|organisation.id | |||
|- | |- | ||
| | |person_id | ||
| | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Unique individual across all organisations | ||
| | |person.id | ||
|- | |- | ||
| | |Uprn | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |qualifier | ||
|varchar( | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |algorithm | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |match | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |no_address | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |invalid_address | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |missing_postcode | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |invalid_postcode | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_patient_id_organization_id PRIMARY KEY (`organization_id`,`person_id`,`patient_id`), | ||
|- | |||
| colspan="5" |CONSTRAINT fk_patient_uprn_patient_id_organisation_id FOREIGN KEY (patient_id, organization_id) | |||
|- | |||
| colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | |||
|- | |||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | |||
|} | |||
== Table: person == | |||
PRIMARY KEY (id) | |||
{| class="wikitable sortable mw-collapsible mw-collapsed" | |||
|'''Column name''' | |||
|'''Data type''' | |||
|'''Constraint''' | |||
|'''Comments''' | |||
|'''References''' | |||
|- | |||
|id | |||
|bigint | |||
|NOT NULL | |||
|Unique Id of the person | |||
| | |||
|- | |||
|organization_id | |||
|bigint | |||
|NOT NULL | |||
|Owning organisation (i.e. publisher) | |||
| | |||
|- | |||
|title | |||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The title of the person | ||
| | | | ||
|- | |- | ||
| | |first_names | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The first names of the person | ||
| | | | ||
|- | |- | ||
| | |last_name | ||
|varchar( | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The last name of the person | ||
| | | | ||
|- | |- | ||
| | |gender_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the gender of the person | ||
| | | | ||
|- | |- | ||
| | |nhs_number | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The NHS number of the person | ||
| | | | ||
|- | |- | ||
| | |date_of_birth date, | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The date of birth of the person | ||
| | | | ||
|- | |- | ||
| | |date_of_death date, | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The date of death of the person | ||
| | | | ||
|- | |- | ||
| | |current_address_id, | ||
| | |bigint | ||
|NOT NULL | |||
|Reference to the current address of the person | |||
| | |||
|- | |||
|ethnic_code_concept_id | |||
|int | |||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the ethnicity of the person | ||
| | | | ||
|- | |- | ||
| | |registered_practice_organization_id | ||
| | |bigint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the organisation the person is registered at | ||
| | | | ||
|- | |- | ||
| | |birth_year | ||
| | |smallint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |birth_month | ||
| | |tinyint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| | |birth_week | ||
| | |tinyint | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | | | ||
| | | | ||
|- | |- | ||
| colspan="5" |CONSTRAINT PRIMARY KEY (id | | colspan="5" |CONSTRAINT pk_person_id PRIMARY KEY (id) | ||
|} | |} | ||
== Table: | == Table: practitioner == | ||
PRIMARY KEY ( | PRIMARY KEY (id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 2,249: | Line 2,546: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the practitioner | ||
| | | | ||
|- | |- | ||
Line 2,255: | Line 2,552: | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. publisher) | |Owning organisation (i.e. publisher) | ||
| | |organisation.id | ||
|- | |- | ||
| | |name | ||
| | |varchar(1024) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Name of the practitioner | ||
| | | | ||
|- | |- | ||
| | |role_code | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The code representing the role of the practitioner | ||
| | | | ||
|- | |- | ||
| | |role_desc | ||
| | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Textual description of the role of the practitioner eg General Medical Practitioner | ||
| | | | ||
|- | |- | ||
| | |gmc_code | ||
| | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The GMC code of the practitioner | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_practitioner_id PRIMARY KEY (id), | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_practitioner_organisation_id FOREIGN KEY (organization_id) | ||
| | |||
|- | |- | ||
| colspan="5" | | | colspan="5" |REFERENCES organization (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" | | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
== Table: | == Table: procedure_request == | ||
PRIMARY KEY(id) | PRIMARY KEY (organization_id,person_id,id) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 2,318: | Line 2,597: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |id | ||
| | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the procedure | ||
| | | | ||
|- | |- | ||
|organization_id | |||
|bigint(20) | |||
|organization_id | |||
|bigint(20) | |||
|NOT NULL | |NOT NULL | ||
|Owning organisation (i.e. publisher) | |Owning organisation (i.e. publisher) | ||
| | |organization.id | ||
|- | |- | ||
|patient_id | |patient_id | ||
|bigint(20) | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
| | |patient.id | ||
|- | |- | ||
|person_id | |person_id | ||
|bigint(20) | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Unique individual across all organisations | ||
| | |person.id | ||
|- | |- | ||
| | |encounter_id | ||
| | |bigint(20) | ||
| | |DEFAULT NULL | ||
|The | |Reference to the encounter the procedure was administered at | ||
| | |encounter.id | ||
|- | |||
|practitioner_id | |||
|bigint(20) | |||
|DEFAULT NULL | |||
|The clinician the activity is recorded against | |||
|practitioner.id | |||
|- | |- | ||
| | |clinical_effective_date | ||
| | |date | ||
| | |DEFAULT NULL | ||
| | |The date the procedure was administered by a clinician | ||
| | | | ||
|- | |- | ||
| | |date_precision_concept_id | ||
| | |int | ||
| | |DEFAULT NULL | ||
| | |Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | ||
| | | | ||
|- | |- | ||
| | |status_concept_id | ||
| | |int | ||
| | |DEFAULT NULL | ||
| | |Reference to the status of the procedure | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
|int | |||
|DEFAULT NULL | |||
|Reference to the clinical coding of the procedure | |||
| | |||
| | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | |non_core_concept_id | ||
| | |int | ||
| | |DEFAULT NULL | ||
| | |Reference to the clinical coding of the procedure | ||
| | | | ||
|- | |- | ||
| | |age_at_event | ||
| | |decimal(5,2) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The age of the patient at the time of the procedure | ||
| | | | ||
|- | |- | ||
| | |date_recorded | ||
| | |datetime | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date the procedure was recorded in the source system | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_procedure_request_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | ||
| | |||
|- | |- | ||
| | | colspan="5" |/*got an Emis procedure request referring to a confidential encounter, so can't enforce this | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_procedure_request_encounter_id FOREIGN KEY (encounter_id) | ||
| | |- | ||
| | | colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | ||
| | |||
| | |||
|- | |- | ||
| | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION,*/ | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_procedure_request_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| colspan="5" | | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_procedure_request_practitioner_id FOREIGN KEY (practitioner_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
== Table: | == Table: pseudo_id == | ||
PRIMARY KEY ( | PRIMARY KEY (patient_id, salt_key_name) | ||
{| class="wikitable sortable mw-collapsible mw-collapsed" | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
|'''Column name''' | |'''Column name''' | ||
Line 2,486: | Line 2,707: | ||
|'''References''' | |'''References''' | ||
|- | |- | ||
| | |Id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
|Unique Id of the | |Unique Id of the pseudo Id | ||
| | | | ||
|- | |- | ||
| | |patient_id | ||
|bigint | |bigint | ||
|NOT NULL | |NOT NULL | ||
| | |Reference to the patient the pseudo Id belongs to | ||
| | | | ||
|- | |- | ||
| | |salt_key_name | ||
|varchar( | |varchar(50) | ||
| | |NOT NULL | ||
|The | |The name of the salt key used to create the pseudo id | ||
| | | | ||
|- | |- | ||
| | |pseudo_id | ||
|varchar(255) | |varchar(255) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The pseudo id | ||
| | | | ||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_pseudo_id PRIMARY KEY (patient_id, salt_key_name) | ||
| | |} | ||
| | |||
== Table: referral_request == | |||
PRIMARY KEY (organization_id,person_id,id) | |||
|- | {| class="wikitable sortable mw-collapsible mw-collapsed" | ||
| | |'''Column name''' | ||
| | |'''Data type''' | ||
| | |'''Constraint''' | ||
| | |'''Comments''' | ||
| | |'''References''' | ||
|- | |- | ||
| | |id | ||
| | |bigint(20) | ||
| | |NOT NULL | ||
| | |Unique Id of the referral | ||
| | | | ||
|- | |- | ||
| | |organization_id | ||
| | |bigint(20) | ||
| | |NOT NULL | ||
| | |Owning organisation (i.e. publisher) | ||
| | |organization.id | ||
|- | |- | ||
| | |patient_id | ||
| | |bigint(20) | ||
| | |NOT NULL | ||
|The | |The organisations record for this person’s registration. Patients may have multiple records across clinical systems and may have registered at an organisation multiple times | ||
| | |patient.id | ||
|- | |- | ||
| | |person_id | ||
|bigint | |bigint(20) | ||
|NOT NULL | |NOT NULL | ||
| | |Unique individual across all organisations | ||
| | |person.id | ||
|- | |- | ||
| | |encounter_id | ||
| | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Reference to the | |Reference to the encounter the referral was made in | ||
| | |encounter.id | ||
|- | |- | ||
| | |practitioner_id | ||
|bigint | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The clinician the activity is recorded against | ||
| | |practitioner.id | ||
|- | |- | ||
| | |clinical_effective_date | ||
| | |date | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |The date the referral was made | ||
| | | | ||
|- | |- | ||
| | |date_precision_concept_id | ||
| | |smallint(6) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|Identifies the precision of the clinical effectiveness date to either year (1) month (2) day (5) minute (12) second (13) millisecond (14) | |||
| | | | ||
|- | |||
|requester_organization_id | |||
|bigint(20) | |||
|DEFAULT NULL | |||
|Reference to the organisation that made the refereral request | |||
| | | | ||
|- | |- | ||
| | |recipient_organization_id | ||
| | |bigint(20) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the organization receiving the referral | ||
| | | | ||
|- | |- | ||
| | |referral_request_priority_concept_id | ||
| | |smallint(6) | ||
|DEFAULT NULL | |||
|Reference to the priority of the referral | |||
|referral.request.priority | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | |referral_request_type_concept_id | ||
| | |int | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Reference to the type of referral request | ||
| | |referral.request.type | ||
|- | |- | ||
| | |Mode | ||
|varchar(50) | |varchar(50) | ||
|DEFAULT NULL | |DEFAULT NULL | ||
|The | |The mode of the referral | ||
| | | | ||
|- | |- | ||
| | |outgoing_referral | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Whether this is an outgoing referral | ||
| | | | ||
|- | |- | ||
| | |is_review | ||
| | |boolean | ||
|DEFAULT NULL | |DEFAULT NULL | ||
| | |Whether this referral is a review | ||
| | | | ||
|- | |- | ||
| | |core_concept_id | ||
|int | |||
|DEFAULT NULL | |||
|Reference to the clinical coding of the referral | |||
| | |||
|- | |- | ||
| | |non_core_concept_id | ||
|int | |||
|DEFAULT NULL | |||
|Reference to the clinical coding of the referral | |||
| | |||
|- | |- | ||
| | |age_at_event | ||
|decimal(5,2) | |||
|DEFAULT NULL | |||
|The age of the patient at the time of the referral | |||
| | |||
|- | |- | ||
| | |date_recorded | ||
|datetime | |||
|DEFAULT NULL | |||
|The date the referral request was added to the source system | |||
| | |||
| | |||
| | |||
| | |||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT pk_referral_request_id PRIMARY KEY (`organization_id`,`person_id`,`id`), | ||
| | |- | ||
| | | colspan="5" |/*got an Emis referral request referring to a confidential encounter, so can't enforce this | ||
| | |||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_referral_request_encounter_id FOREIGN KEY (encounter_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES encounter (id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION,*/ | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_referral_request_patient_id_organization_id FOREIGN KEY (patient_id, organization_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES patient (id, organization_id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_referral_request_practitioner_id FOREIGN KEY (practitioner_id) | ||
| | |||
|- | |- | ||
| | | colspan="5" |REFERENCES practitioner (id) MATCH SIMPLE | ||
| | |||
|- | |- | ||
| | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
| | |||
|- | |- | ||
| | | colspan="5" |CONSTRAINT fk_referral_request_recipient_organization_id FOREIGN KEY (recipient_organization_id) | ||
| | |||
|- | |- | ||
| colspan="5" |REFERENCES organization (id) MATCH SIMPLE | |||
| colspan="5" |REFERENCES | |||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION, | ||
|- | |- | ||
| colspan="5" |CONSTRAINT | | colspan="5" |CONSTRAINT fk_referral_request_requester_organization_id FOREIGN KEY (requester_organization_id) | ||
|- | |- | ||
| colspan="5" |REFERENCES | | colspan="5" |REFERENCES organization (id) MATCH SIMPLE | ||
|- | |- | ||
| colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | | colspan="5" |ON UPDATE NO ACTION ON DELETE NO ACTION | ||
|} | |} | ||
Latest revision as of 08:51, 18 May 2021
Table: allergy_intolerance
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: appointment
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: concept
PRIMARY KEY (dbid)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: concept_map
PRIMARY KEY (id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: diagnostic_order
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: encounter
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: encounter_additional
PRIMARY KEY (id, property_id, value_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: encounter_event
PRIMARY KEY (organization_id, person_id, id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: episode_of_care
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: event_log
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: flag
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: location
PRIMARY KEY (pk_location_id PRIMARY KEY id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: medication_order
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: medication_statement
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: observation
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: observation_additional
PRIMARY KEY (id, property_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: organization
PRIMARY KEY (pk_organization_id PRIMARY KEY (id))
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: organization_metadata
PRIMARY KEY (id, publishing_software)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_additional
PRIMARY KEY (id, property_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_address
PRIMARY KEY (organization_id,id,patient_id,person_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_address_match
PRIMARY KEY(id, uprn)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_address_ralf
PRIMARY KEY (id, patient_address_id, patient_address_match_uprn_ralf00)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_contact
PRIMARY KEY (organization_id,id,patient_id,person_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_pseudo_id
PRIMARY KEY(organization_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: patient_uprn
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: person
PRIMARY KEY (id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: practitioner
PRIMARY KEY (id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: procedure_request
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: pseudo_id
PRIMARY KEY (patient_id, salt_key_name)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: referral_request
PRIMARY KEY (organization_id,person_id,id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: registration_status_history
PRIMARY KEY(organization_id,id,patient_id,person_id)
Column name | Data type | Constraint | Comments | ExpandReferences |
Table: schedule
PRIMARY KEY (organization_id, id)
Column name | Data type | Constraint | Comments | ExpandReferences |