Skip to content
Partner Developer Portal

Schema

Column NameData TypeDescriptionExample
_ingest_timevarcharThe datetime that the record was ingested, format YYYYMMDDHHMMSS’20230512143015’
is_deletedbooleanIndicates if this record should be considered soft deletedFALSE
referral_observation_idbigintInternal EMIS observation identifier for this referral record12345
observation_guidvarcharEMIS observation GUID for the referral’a1b2c3d4-e5f6-7890-abcd-ef1234567890’
referral_observation_uuidvarcharEXA-generated UUID5 derived from referral_observation_id and organisation’f47ac10b-58cc-4372-a567-0e02b2c3d479’
patient_idbigintInternal EMIS patient identifier67890
patient_guidvarcharEMIS patient GUID’b2c3d4e5-f6a7-8901-bcde-f12345678901’
patient_organisation_guidvarcharEMIS GUID of the patient’s registered organisation’c3d4e5f6-a7b8-9012-cdef-123456789012’
unique_booking_reference_numbervarcharUnique Booking Reference Number (UBRN) for the referral; NULL when deleted’REF123456’
effective_datetimetimestamp(6) with time zoneThe clinical effective datetime of the referral; NULL when deleted’2023-01-10 09:00:00.000000 UTC’
effective_datetime_precisionvarcharPrecision of the effective datetime; hardcoded to ‘YMDT’; NULL when deleted’YMDT’
availability_datetimetimestamp(6) with time zoneThe datetime the referral record became available; NULL when deleted’2023-01-10 09:00:00.000000 UTC’
referral_made_datetimetimestamp(6) with time zoneThe datetime the referral was originally made; NULL when deleted’2023-01-09 16:45:00.000000 UTC’
ended_datetimetimestamp(6) with time zoneThe datetime the referral ended or was resolved; NULL when deleted or not ended’2023-06-30 00:00:00.000000 UTC’
consultation_guidvarcharEMIS GUID of the consultation linked to this referral’d4e5f6a7-b8c9-0123-defa-234567890123’
consultation_uuidvarcharEXA-generated UUID5 derived from consultation_id and organisation’e5f6a7b8-c9d0-1234-efab-345678901234’
authorising_user_in_role_idbigintEMIS identifier of the authorising user in role; NULL when deleted11223
entered_by_user_in_role_idbigintEMIS identifier of the user in role who entered the referral; NULL when deleted33445
code_idbigintEMIS internal clinical code identifier; NULL when deleted98765
original_termvarcharOriginal clinical term as recorded in EMIS Web; masked when deleted or code is null’Referral to cardiology’
qualifiersvarcharQualifiers associated with the referral observation; NULL when deleted’Urgent’
consultation_source_code_idbigintEMIS code ID for the consultation source; NULL when deleted45678
consultation_source_original_termvarcharOriginal term for the consultation source code; NULL when deleted’GP Surgery’
urgencyintegerNumeric urgency code: 0=Routine, 1=Soon, 2=Urgent, 3=Dated, 4=2 Week Wait; NULL when deleted2
urgency_descriptionvarcharHuman-readable urgency label derived from urgency code; NULL when deleted’Urgent’
directionvarcharDirection of the referral: ‘out’ (outgoing) or ‘in’ (incoming); NULL when deleted’out’
service_type_idbigintEMIS code ID for the requested service type; NULL when deleted5678
service_type_display_textvarcharDisplay text for the requested service type; NULL when deleted’Cardiology’
referral_mode_descriptionvarcharReferral mode description (e.g., written, telephone); NULL when deleted’Written’
observation_organisation_guidvarcharEMIS GUID of the organisation associated with the observation’a7b8c9d0-e1f2-0a1b-5c6d-7e8f9a0b1c2d’
target_organisation_guidvarcharEMIS GUID of the target organisation the patient is referred to’f1e2d3c4-b5a6-7890-abcd-ef0123456789’
problem_observation_guidvarcharEMIS GUID of the related problem observation, if linked’b8c9d0e1-f2a3-1b2c-6d7e-8f9a0b1c2d3e’
is_confidentialbooleanIndicates if this record is currently marked as confidentialFALSE
was_confidentialbooleanIndicates if this record was previously marked as confidentialFALSE
is_sensitivebooleanIndicates if the referral is currently flagged as sensitiveFALSE
was_sensitivebooleanIndicates if the referral was previously flagged as sensitiveFALSE
organisationvarcharAn identifier for the source of data (an organisation), relates to a given GP practice’CDB-12345’
load_datetimetimestamp(6) with time zoneFormatted ingest time for filtering’2023-05-12 14:30:15.000000 UTC’
transform_datetimetimestamp(6) with time zoneThe datetime that the data was made available in the model with a relevant change’2023-05-12 14:30:15.000000 UTC’
_execution_datevarcharFormatted transform datetime for versioning’20230512143015’

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
emis_observation_guidvarchar
exa_observation_guidvarchar
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idbigint
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_problem_observation_guidvarchar
emis_observation_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
consultation_source_emis_code_idbigint
consultation_source_emis_original_termvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
effective_datetimestamp(6) with time zone
effective_date_precisionvarchar
received_datedateAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
referral_made_datetimetimestamp(6) with time zone
recorded_datetimestamp(6) with time zone
referral_end_datetimestamp(6) with time zone
qualifiersvarchar
referral_mode_descriptionvarchar
emis_direction_descriptionvarchar
emis_urgencybigint
nhs_priority_descriptionvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_urgency_descriptionvarchar
service_type_emis_code_idbigint
service_type_requested_descriptionvarchar
nhs_priorityvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
nhs_sourcevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_original_termvarchar
emis_target_organisation_guidvarchar
ubrnvarchar
confidential_flagboolean
sensitive_flagboolean
action_datetimestamp(3)
non_regular_and_current_active_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
confidential_patient_flagboolean
dummy_patient_flagboolean
service_type_snomed_concept_idbigint
service_type_termvarchar
snomed_concept_idbigint
snomed_description_idbigint
readv2_codevarchar
other_code_systemvarchar
other_codevarchar
other_displayvarchar
emis_referral_termvarchar
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Not used in this schema

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
emis_observation_guidvarchar
exa_observation_guidvarchar
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idbigint
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_observation_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
consultation_source_emis_code_idbigint
consultation_source_emis_original_termvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
effective_datetimestamp(6) with time zone
effective_date_precisionvarchar
received_datedateAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
referral_made_datetimetimestamp(6) with time zone
recorded_datetimestamp(6) with time zone
referral_end_datetimestamp(6) with time zone
qualifiersvarchar
referral_mode_descriptionvarchar
emis_direction_descriptionvarchar
nhs_priority_descriptionvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_urgency_descriptionvarchar
service_type_emis_code_idbigint
service_type_requested_descriptionvarchar
nhs_priorityvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
nhs_sourcevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_original_termvarchar
emis_target_organisation_guidvarchar
ubrnvarchar
confidential_flagboolean
sensitive_flagboolean
action_datetimestamp(3)
confidential_patient_flagboolean
dummy_patient_flagboolean
emis_referral_termvarchar
emis_urgencybigint
non_regular_and_current_active_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
regular_patient_flagboolean
service_type_snomed_concept_idbigint
service_type_termvarchar
snomed_concept_idbigint
snomed_description_idbigint
sensitive_patient_flagbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
emis_observation_guidvarchar
exa_observation_guidvarchar
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idbigint
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_observation_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
consultation_source_emis_code_idbigint
consultation_source_emis_original_termvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
effective_datetimestamp(6) with time zone
effective_date_precisionvarchar
received_datedateAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
referral_made_datetimetimestamp(6) with time zone
recorded_datetimestamp(6) with time zone
referral_end_datetimestamp(6) with time zone
qualifiersvarchar
referral_mode_descriptionvarchar
emis_direction_descriptionvarchar
nhs_priority_descriptionvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_urgencybigint
emis_urgency_descriptionvarchar
service_type_emis_code_idbigint
service_type_requested_descriptionvarchar
nhs_priorityvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
nhs_sourcevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_original_termvarchar
emis_target_organisation_guidvarchar
ubrnvarchar
confidential_flagboolean
sensitive_flagboolean
other_codevarchar
emis_referral_termvarchar
service_type_termvarchar
regular_patient_flagboolean
confidential_patient_flagboolean
snomed_concept_idbigint
readv2_codevarchar
snomed_description_idbigint
service_type_snomed_concept_idbigint
regular_current_active_and_inactive_flagboolean
non_regular_and_current_active_flagboolean
other_code_systemvarchar
other_displayvarchar
regular_and_current_active_flagboolean
sensitive_patient_flagboolean
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
exa_observation_guidvarchar
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_observation_guidvarchar
emis_patient_idbigint
registration_guidvarchar
emis_problem_observation_guidvarchar
emis_observation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_registration_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
consultation_source_emis_code_idbigint
effective_datetimestamp(6) with time zone
effective_date_precisionvarchar
received_datedateAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
referral_made_datetimetimestamp(6) with time zone
recorded_datetimestamp(6) with time zone
referral_end_datetimestamp(6) with time zone
qualifiersvarchar
referral_mode_descriptionvarchar
emis_direction_descriptionvarchar
nhs_priority_descriptionvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_urgencybigint
emis_urgency_descriptionvarchar
service_type_emis_code_idbigint
service_type_requested_descriptionvarchar
nhs_priorityvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
nhs_sourcevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
consultation_source_emis_original_termvarchar
emis_original_termvarchar
emis_target_organisation_guidvarchar
ubrnvarchar
confidential_flagboolean
sensitive_flagboolean
action_datetimestamp(3)
confidential_patient_flagboolean
dummy_patient_flagboolean
emis_referral_termvarchar
non_regular_and_current_active_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
service_type_snomed_concept_idbigint
service_type_termvarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedbooleandeletedExists in v1 with a different name
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
id_type5varchar
consultation_guidvarchar
consultation_uuidvarchar
observation_guidvarchar
patient_idbigint
patient_guidvarchar
problem_guidvarchar
organisation_guidvarchar
entered_by_user_in_role_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
clinician_user_in_role_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timevarchar
referral_modevarchar
referral_urgencybigint
referral_service_typevarchar
referral_target_organisation_guidvarchar
observation_typevarchar(8)
is_confidentialboolean
parent_observation_guidvarchar
document_guidvarchar
code_idbigint
referral_source_organisation_guidvarchar
valuevarchar
numeric_range_lowdouble
numeric_range_highdouble
numeric_unitvarchar
processing_idintegerAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarcharexecution_dateExists in v1 with a different name

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedbooleandeletedExists in v1 with a different name
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
exa_observation_guidvarchar
emis_consultation_guidvarchar
exa_consultation_guidvarchar
emis_observation_guidvarchar
pseudo_registration_guidvarchar
emis_problem_observation_guidvarchar
emis_registration_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timevarchar
referral_mode_descriptionvarchar
emis_urgency_descriptionvarchar
urgencybigint
service_type_requested_descriptionvarchar
emis_target_organisation_guidvarchar
ubrn_flagboolean
confidential_flagboolean
processing_idintegerAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarcharexecution_dateExists in v1 with a different name

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedbooleandeletedExists in v1 with a different name
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
exa_observation_guidvarchar
emis_consultation_guidvarchar
exa_consultation_guidvarchar
emis_observation_guidvarchar
pseudo_registration_guidvarchar
emis_problem_observation_guidvarchar
emis_registration_organisation_guidvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idbigint
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
authorising_user_in_role_idbigint
emis_code_idbigint
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timevarchar
referral_mode_descriptionvarchar
emis_urgency_descriptionvarchar
urgencybigint
service_type_requested_descriptionvarchar
emis_target_organisation_guidvarchar
ubrn_flagboolean
confidential_flagboolean
observation_typevarchar(8)
processing_idintegerAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Refer to the definition / universal-improvements page for detailed differences between v1 and v2 of this model.

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
load_datetimetimestamp(6) with time zone
referral_observation_idbigint
emis_observation_guidvarchar
exa_observation_guidvarchar
emis_encounter_guidvarchar
exa_encounter_guidvarchar
pseudo_registration_guid_oureavarchar
emis_registration_organisation_guidvarchar
emis_problem_observation_guidvarchar
emis_observation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_code_idbigint
consultation_source_emis_code_idbigint
effective_datetimestamp(6) with time zone
effective_date_precisionvarchar
received_datedateAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
referral_made_datetimetimestamp(6) with time zone
recorded_datetimestamp(6) with time zone
referral_end_datetimestamp(6) with time zone
qualifiersvarchar
referral_mode_descriptionvarchar
emis_direction_descriptionvarchar
nhs_priority_descriptionvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_urgencybigint
emis_urgency_descriptionvarchar
service_type_emis_code_idbigint
service_type_requested_descriptionvarchar
nhs_priorityvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
nhs_sourcevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
consultation_source_emis_original_termvarchar
emis_original_termvarchar
emis_target_organisation_guidvarchar
ubrnvarchar
confidential_flagboolean
sensitive_flagboolean
action_datetimestamp(3)
confidential_patient_flagboolean
dummy_patient_flagboolean
emis_authorising_userinrole_guidvarchar
emis_enteredby_userinrole_guidvarchar
emis_referral_termvarchar
non_regular_and_current_active_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
service_type_snomed_concept_idbigint
service_type_termvarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar
data_filterbigint