Skip to content
Partner Developer Portal

Schema

The core schema represents the Referral schema derived from EMIS source system.

Column NameData TypeDescriptionExample
is_deletedbooleanIndicates if this record should be considered soft deletedFALSE
load_datetimetimestamp(6) with time zoneThe datetime that the record was last upserted into the EXA data lake from EMIS source system with a relevant change from source system.‘2023-05-12 14:30:15.000000 UTC’
_ingest_timevarcharThe load_datetime formatted as yyyyMMddHHmmss. This column is provided only for backward compatibility.‘20230512143015’
referral_observation_idbigintThe unique internal identifier for the referral record within an organisation.12345
referral_observation_guidvarcharThe GUID for the referral record within an organisation‘a1b2c3d4-e5f6-7890-abcd-ef1234567890’
referral_observation_uuidvarcharThe UUID derived from referral_observation_id and organisation, providing a stable unique identifier.‘f47ac10b-58cc-4372-a567-0e02b2c3d479’
patient_idbigintThe unique internal identifier for the patient record within the organisation for whom the referral was recorded.67890
patient_guidvarcharThe GUID for the patient record within an organisation‘b2c3d4e5-f6a7-8901-bcde-f12345678901’
patient_uuidvarcharThe UUID derived from patient_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
patient_organisation_idbigintThe unique internal identifier for the organisation where the patient is registered12345
patient_organisation_guidvarcharThe GUID of the organisation where the patient is registered‘c3d4e5f6-a7b8-9012-cdef-123456789012’
patient_organisation_uuidvarcharThe UUID derived from patient_organisation_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
unique_booking_reference_numbervarcharUnique Booking Reference Number (UBRN) for the referral allowing for tracking and management of the referral process. Only available for inbound referrals.‘000280834589’
consultation_idbigintThe unique internal identifier for the consultation record within an organisation in which the referral was recorded.12345
consultation_guidvarcharThe GUID for the consultation record within an organisation‘d4e5f6a7-b8c9-0123-defa-234567890123’
consultation_uuidvarcharThe UUID derived from consultation_id and organisation, providing a stable unique identifier.‘e5f6a7b8-c9d0-1234-efab-345678901234’
consultation_section_idbigintThe unique internal identifier for the consultation section within an organisation.12345
consultation_section_uuidvarcharThe UUID derived from consultation_section_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
consultation_source_code_idbigintThe identifier of the code describing the consultation source (e.g. GP Surgery, Telephone)1672851000006116
consultation_source_original_termvarcharThe EMIS term for the consultation source code‘GP Surgery’
urgencybigintNumeric urgency code: 0=Routine, 1=Soon, 2=Urgent, 3=Dated, 4=2 Week Wait2
urgency_descriptionvarcharUrgency description derived from urgency code‘Urgent’
directionvarcharDirection of the referral: ‘out’ (outgoing) or ‘in’ (incoming)‘out’
service_type_idbigintEMIS code ID for the requested service type(e.g., 1775591000006112 - Referred to School Nursing Service,1775311000006113 - Referred to Cardiac Service)1775591000006112
service_type_requestedbigintThe identifier that maps to a service type requested9
service_type_display_textvarcharDisplay text for the requested service type(e.g., 1 - Investigation, 2- Treatment, 7 - Self referral , 9 - Admission)‘Treatment’
referral_mode_idbigintThe identifier that maps to a referral mode4
referral_mode_descriptionvarcharReferral mode description mapped to the referral mode id(e.g., 0 - NHS e-Referral, 1 - Telephone, 3 - Written, 4 - Managed)‘Written’
problem_observation_idbigintThe unique internal identifier for the first problem observation within an organisation linked to this problem across all episodes (Associated and Episode Follow On). The records are prioritised by effective_datetime, availability_datetime and observation_id.12345
problem_observation_guidvarcharThe GUID for the first problem observation within an organisation linked to this referral‘b8c9d0e1-f2a3-1b2c-6d7e-8f9a0b1c2d3e’
problem_observation_uuidvarcharThe UUID derived from problem_observation_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
authorising_user_in_role_idbigintThe unique identifier of the clinician who authorised or authored the referral record11223
authorising_user_in_role_uuidvarcharThe UUID derived from authorising_user_in_role_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
entered_by_user_in_role_idbigintThe unique identifier of the user who entered the referral record33445
entered_by_user_in_role_uuidvarcharThe UUID derived from entered_by_user_in_role_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
observation_organisation_idbigintThe unique internal identifier of the organisation where the referral was recorded12345
observation_organisation_guidvarcharThe GUID of the organisation where the referral was recorded‘a7b8c9d0-e1f2-0a1b-5c6d-7e8f9a0b1c2d’
observation_organisation_uuidvarcharThe UUID derived from observation_organisation_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
target_organisation_idbigintThe unique internal identifier for the target organisation the patient is referred to12345
target_organisation_guidvarcharThe GUID of the target organisation the patient is referred to‘f1e2d3c4-b5a6-7890-abcd-ef0123456789’
target_organisation_uuidvarcharThe UUID derived from from target_organisation_id and organisation, providing a stable unique identifier.organisation‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
code_idbigintThe unique EMIS code identifier for the clinical code associated with the referral8085301000006112
original_termvarcharThe EMIS term used to record the referral. Will be set to NULL for uncoded referrals.‘Referral to cardiology’
qualifiersvarcharRaw XML qualifier data associated with the referral. Qualifiers are extended data fields attached to a specific clinical or vaccination code that allow users to record highly detailed, granular information without needing to create separate, standalone clinical codes. Will be set to NULL for uncoded referrals.‘Urgent’
effective_datetimetimestamp(6) with time zoneThe date and time when the referral came into effect‘2023-01-10 09:00:00.000000 UTC’
effective_datetime_precisionvarcharPrecision of the effective datetime; set to ‘YMDT’.‘YMDT’
availability_datetimetimestamp(6) with time zoneThe date and time the referral was recorded in the source system‘2023-01-10 09:00:00.000000 UTC’
referral_made_datetimetimestamp(6) with time zoneThe datetime the inbound referral was originally made‘2023-01-09 16:45:00.000000 UTC’
ended_datetimetimestamp(6) with time zoneThe datetime the referral was resolved or ended‘2023-06-30 00:00:00.000000 UTC’
is_sensitivebooleanIndicates whether the referral record is flagged as sensitive. The sensitive reference set codes are 999004351000000109( gender related issues), 999004371000000100(assisted fertilisation), 999004361000000107(termination of pregnancy) and 999004381000000103 (sexually transmitted disease)FALSE
is_confidentialbooleanIndicates whether the referral record is confidential. This is based on confidentiality set against the patient/consultation/parent observation/referral record.FALSE
organisationvarcharAn identifier for the source of data (an organisation) relating to a given GP practice‘CDB-12345’
transform_datetimetimestamp(6) with time zoneThe timestamp indicating when the record was last processed and updated in the data model.‘2023-05-12 14:30:15.000000 UTC’
_execution_datevarcharThe transform_datetime formatted as yyyyMMddHHmmss. This column is provided only for backward compatibility.‘20230512143015’

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✗✓
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
problem_observation_idbigint✗✓
emis_problem_observation_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
observation_organisation_idbigint✗✓
emis_observation_organisation_guidvarchar✓✓observation_organisation_guid
observation_organisation_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_code_idbigint✓✓code_id
emis_original_termvarchar✓✓original_term
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrnvarchar✓✓unique_booking_reference_number
consultation_source_emis_code_idbigint✓✓consultation_source_code_id
consultation_source_emis_original_termvarchar✓✓consultation_source_original_term
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
referral_end_datetimestamp(6) with time zone✓✓ended_datetime
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
received_datedate✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
referral_made_datetimetimestamp(6) with time zone✗✓
qualifiersvarchar✓✓
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
nhs_sourcevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_direction_descriptionvarchar✓✓direction
emis_urgencybigint✓✓urgency
emis_urgency_descriptionvarchar✓✓urgency_description
nhs_priorityvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
nhs_priority_descriptionvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
service_type_emis_code_idbigint✓✓service_type_id
service_type_requestedbigint✗✓
service_type_requested_descriptionvarchar✓✓
confidential_flagboolean✓✓is_confidential
sensitive_flagboolean✓✓is_sensitive
action_datetimestamp(3)✓✗
confidential_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
dummy_patient_flagboolean✓✗
service_type_snomed_concept_idbigint✓✗
service_type_termvarchar✓✗
regular_patient_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
opt_out_93c1_flagboolean✓✗
opt_out_9nd19nu09nu4_flagboolean✓✗
opt_out_9nd19nu0_flagboolean✓✗
opt_out_9nu0_flagboolean✓✗
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
readv2_codevarchar✓✗
other_codevarchar✓✗
other_code_systemvarchar✓✗
other_displayvarchar✓✗
emis_referral_termvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓
_record_versionvarchar✓✗
_update_datevarchar✓✗
_update_hourvarchar✓✗

Not used in this schema

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✗✓
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
observation_organisation_idbigint✗✓
emis_observation_organisation_guidvarchar✓✓observation_organisation_guid
observation_organisation_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
emis_code_idbigint✓✓code_id
emis_original_termvarchar✓✓original_term
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrnvarchar✓✓unique_booking_reference_number
consultation_source_emis_code_idbigint✓✓consultation_source_code_id
consultation_source_emis_original_termvarchar✓✓consultation_source_original_term
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
received_datedate✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
referral_made_datetimetimestamp(6) with time zone✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
referral_end_datetimestamp(6) with time zone✓✓ended_datetime
qualifiersvarchar✓✓
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
nhs_sourcevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_direction_descriptionvarchar✓✓direction
nhs_priorityvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
nhs_priority_descriptionvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_urgencybigint✓✓urgency
emis_urgency_descriptionvarchar✓✓urgency_description
service_type_emis_code_idbigint✓✓service_type_id
service_type_requested_descriptionvarchar✓✓
confidential_flagboolean✓✓is_confidential
sensitive_flagboolean✓✓is_sensitive
action_datetimestamp(3)✓✗
confidential_patient_flagboolean✓✗
sensitive_patient_flagbigint✓✗
dummy_patient_flagboolean✓✗
emis_referral_termvarchar✓✗
regular_patient_flagboolean✓✗
service_type_snomed_concept_idbigint✓✗
service_type_termvarchar✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
opt_out_93c1_flagboolean✓✗
opt_out_9nd19nu09nu4_flagboolean✓✗
opt_out_9nd19nu0_flagboolean✓✗
opt_out_9nu0_flagboolean✓✗
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
readv2_codevarchar✓✗
other_codevarchar✓✗
other_code_systemvarchar✓✗
other_displayvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓
_record_versionvarchar✓✗
_update_datevarchar✓✗
_update_hourvarchar✓✗

The table below presents the flavour specific schema.

Column NameData TypeCore Mapping
is_deletedboolean
pseudo_referral_observation_uuidvarcharreferral_observation_uuid
pseudo_patient_uuidvarcharpatient_uuid
pseudo_patient_organisation_uuidvarcharpatient_organisation_uuid
pseudo_consultation_uuidvarcharconsultation_uuid
pseudo_consultation_section_uuidvarcharconsultation_section_uuid
pseudo_problem_observation_uuidvarcharproblem_observation_uuid
pseudo_observation_organisation_uuidvarcharobservation_organisation_uuid
pseudo_target_organisation_uuidvarchartarget_organisation_uuid
unique_booking_reference_numbervarchar
effective_datetimetimestamp(6) with time zone
effective_datetime_precisionvarchar
availability_datetimetimestamp(6) with time zone
referral_made_datetimetimestamp(6) with time zone
ended_datetimetimestamp(6) with time zone
code_idbigint
consultation_source_code_idbigint
consultation_source_original_termvarchar
original_termvarchar
urgencybigint
urgency_descriptionvarchar
directionvarchar
service_type_idbigint
service_type_requestedbigint
service_type_display_textvarchar
referral_mode_idbigint
referral_mode_descriptionvarchar
is_confidentialboolean
is_sensitiveboolean
organisationvarchar
transform_datetimetimestamp(6) with time zone

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✗✓
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
observation_organisation_idbigint✗✓
emis_observation_organisation_guidvarchar✓✓observation_organisation_guid
observation_organisation_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_code_idbigint✓✓code_id
emis_original_termvarchar✓✓original_term
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrnvarchar✓✓unique_booking_reference_number
consultation_source_emis_code_idbigint✓✓consultation_source_code_id
consultation_source_emis_original_termvarchar✓✓consultation_source_original_term
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
received_datedate✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
referral_made_datetimetimestamp(6) with time zone✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
referral_end_datetimestamp(6) with time zone✓✓ended_datetime
qualifiersvarchar✓✓
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
nhs_sourcevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_direction_descriptionvarchar✓✓direction
nhs_priorityvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
nhs_priority_descriptionvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_urgencybigint✓✓urgency
emis_urgency_descriptionvarchar✓✓urgency_description
service_type_emis_code_idbigint✓✓service_type_id
service_type_requested_descriptionvarchar✓✓
confidential_flagboolean✓✓is_confidential
sensitive_flagboolean✓✓is_sensitive
confidential_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
regular_patient_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
service_type_snomed_concept_idbigint✓✗
readv2_codevarchar✓✗
other_codevarchar✓✗
emis_referral_termvarchar✓✗
service_type_termvarchar✓✗
other_code_systemvarchar✓✗
other_displayvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✓✓Renamed from deletedin V1
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
consultation_idbigint✗✓
emis_consultation_guidvarchar✓✓consultation_guid
exa_consultation_guidvarchar✓✓consultation_uuid
problem_observation_idbigint✗✓
emis_problem_observation_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
emis_code_idbigint✓✓code_id
pseudo_registration_guidvarchar✓✓patient_guid
pseudo_patient_uuidvarchar✗✓patient_uuid
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
observation_organisation_idbigint✗✓
observation_organisation_guidvarchar✗✓
observation_organisation_uuidvarchar✗✓
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
effective_datedate✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
entered_datedate✓✓availability_datetime
entered_timevarchar✓✓availability_datetime
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
emis_urgency_descriptionvarchar✓✓urgency_description
urgencybigint✗✓
service_type_requested_descriptionvarchar✓✓
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrn_flagboolean✓✓unique_booking_reference_number
observation_typevarchar✓✓Set as ‘Referral’
confidential_flagboolean✓✓is_confidential
processing_idinteger✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✓✓Renamed from deletedin V1
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
consultation_idbigint✗✓
emis_consultation_guidvarchar✓✓consultation_guid
exa_consultation_guidvarchar✓✓consultation_uuid
problem_observation_idbigint✗✓
emis_problem_observation_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
emis_code_idbigint✓✓code_id
pseudo_registration_guidvarchar✓✓patient_guid
pseudo_patient_uuidvarchar✗✓patient_uuid
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
observation_organisation_idbigint✗✓
observation_organisation_guidvarchar✗✓
observation_organisation_uuidvarchar✗✓
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_uuidvarchar✗✓
effective_datedate✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
entered_datedate✓✓availability_datetime
entered_timevarchar✓✓availability_datetime
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
emis_urgency_descriptionvarchar✓✓urgency_description
urgencybigint✗✓
service_type_requested_descriptionvarchar✓✓
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrn_flagboolean✓✓unique_booking_reference_number
confidential_flagboolean✓✓is_confidential
processing_idinteger✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarcharexecution_date✓

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✓✓Renamed from deletedin V1
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
observation_guidvarchar✓✓referral_observation_guid
id_type5varchar✓✓referral_observation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
consultation_idbigint✗✓
consultation_guidvarchar✓✓
consultation_uuidvarchar✗✓
problem_observation_idbigint✗✓
problem_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
patient_guidvarchar✓✓
patient_uuidvarchar✗✓
patient_organisation_idbigint✗✓
patient_organisation_guidvarchar✗✓
patient_organisation_uuidvarchar✗✓
organisation_guidvarchar✓✗
observation_organisation_idbigint✗✓
observation_organisation_guidvarchar✗✓
observation_organisation_uuidvarchar✗✓
code_idbigint✓✓
referral_source_organisation_guidvarchar✓✗
clinician_user_in_role_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
document_guidvarchar✓✗
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
effective_datedate✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
entered_datedate✓✓availability_datetime
entered_timevarchar✓✓availability_datetime
referral_modevarchar✓✓referral_mode_description
referral_urgencybigint✓✓urgency
referral_service_typevarchar✓✓service_type_requested_description
target_organisation_idbigint✗✓
referral_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
observation_typevarchar✓✓Set as ‘Referral’
valuevarchar✓✗
numeric_unitvarchar✓✗
numeric_range_lowdouble✓✗
numeric_range_highdouble✓✗
is_confidentialboolean✓✓
processing_idinteger✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarcharexecution_date✓

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✗✓
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
problem_observation_idbigint✗✓
emis_problem_observation_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
observation_organisation_idbigint✗✓
emis_observation_organisation_guidvarchar✓✓observation_organisation_guid
observation_organisation_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
emis_code_idbigint✓✓code_id
emis_original_termvarchar✓✓original_term
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrnvarchar✓✓unique_booking_reference_number
consultation_source_emis_code_idbigint✓✓consultation_source_code_id
consultation_source_emis_original_termvarchar✓✓consultation_source_original_term
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_enteredby_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
emis_authorising_userinrole_guidvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
received_datedate✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
referral_made_datetimetimestamp(6) with time zone✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
referral_end_datetimestamp(6) with time zone✓✓ended_datetime
qualifiersvarchar✓✓
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
nhs_sourcevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_direction_descriptionvarchar✓✓direction
nhs_priorityvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
nhs_priority_descriptionvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_urgencybigint✓✓urgency
emis_urgency_descriptionvarchar✓✓urgency_description
service_type_emis_code_idbigint✓✓service_type_id
service_type_requested_descriptionvarchar✓✓
confidential_flagboolean✓✓is_confidential
sensitive_flagboolean✓✓is_sensitive
action_datetimestamp(3)✓✗
confidential_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
service_type_snomed_concept_idbigint✓✗
service_type_termvarchar✓✗
dummy_patient_flagboolean✓✗
emis_referral_termvarchar✓✗
regular_patient_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
opt_out_93c1_flagboolean✓✗
opt_out_9nd19nu09nu4_flagboolean✓✗
opt_out_9nd19nu0_flagboolean✓✗
opt_out_9nu0_flagboolean✓✗
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
readv2_codevarchar✓✗
other_codevarchar✓✗
other_code_systemvarchar✓✗
other_displayvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓
_record_versionvarchar✓✗
_update_datevarchar✓✗
_update_hourvarchar✓✗

The table below presents the flavour specific schema and maps columns between core, V1, and V2. Refer to Changes in iPCV V2 for more information.

Column NameData TypeData in V1Data in V2Core MappingComments
_ingest_timevarchar✓✓
is_deletedboolean✗✓
load_datetimetimestamp(6) with time zone✗✓
referral_observation_idbigint✗✓
emis_observation_guidvarchar✓✓referral_observation_guid
exa_observation_guidvarchar✓✓referral_observation_uuid
consultation_section_idbigint✗✓
consultation_section_uuidvarchar✗✓
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
problem_observation_idbigint✗✓
emis_problem_observation_guidvarchar✓✓problem_observation_guid
problem_observation_uuidvarchar✗✓
observation_organisation_idbigint✗✓
emis_observation_organisation_guidvarchar✓✓observation_organisation_guid
observation_organisation_uuidvarchar✗✓
emis_patient_idbigint✓✗patient_id
pseudo_patient_uuidvarchar✗✓patient_uuid
pseudo_registration_guid_oureavarchar✓✓patient_guid
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_code_idbigint✓✓code_id
emis_original_termvarchar✓✓original_term
target_organisation_idbigint✗✓
emis_target_organisation_guidvarchar✓✓target_organisation_guid
target_organisation_uuidvarchar✗✓
ubrnvarchar✓✓unique_booking_reference_number
consultation_source_emis_code_idbigint✓✓consultation_source_code_id
consultation_source_emis_original_termvarchar✓✓consultation_source_original_term
emis_enteredby_userinrole_guidvarchar✓✗
emis_referral_termvarchar✓✗Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_authorising_userinrole_guidvarchar✓✗Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓effective_datetime_precision
received_datedate✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
referral_made_datetimetimestamp(6) with time zone✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
referral_end_datetimestamp(6) with time zone✓✓ended_datetime
qualifiersvarchar✓✓
referral_mode_idbigint✗✓
referral_mode_descriptionvarchar✓✓
nhs_sourcevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_direction_descriptionvarchar✓✓direction
nhs_priorityvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
nhs_priority_descriptionvarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
emis_urgencybigint✓✓urgency
emis_urgency_descriptionvarchar✓✓urgency_description
service_type_emis_code_idbigint✓✓service_type_id
service_type_requested_descriptionvarchar✓✓
sensitive_flagboolean✓✓is_sensitive
action_datetimestamp(3)✓✗
confidential_flagboolean✓✓is_confidential
data_filterbigint✓✗
confidential_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
service_type_snomed_concept_idbigint✓✗
service_type_termvarchar✓✗
dummy_patient_flagboolean✓✗
regular_patient_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
opt_out_93c1_flagboolean✓✗
opt_out_9nd19nu09nu4_flagboolean✓✗
opt_out_9nd19nu0_flagboolean✓✗
opt_out_9nu0_flagboolean✓✗
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
readv2_codevarchar✓✗
other_codevarchar✓✗
other_code_systemvarchar✓✗
other_displayvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓