Skip to content
Partner Developer Portal

Schema

The core schema represents the Consultation Section schema derived from EMIS source system.

Column NameData TypeDescriptionExample
consultation_section_idbigintThe unique internal identifier for the consultation section within an organisation.67890
organisationvarcharAn identifier for the source of data (an organisation) relating to a given GP practice‘CDB-001’
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’
consultation_section_guidvarcharThe GUID for the consultation section within an organisation‘B2C3D4E5-F6G7-8H9I-0J1K-L2M3N4O5P6Q7’
consultation_section_uuidvarcharThe UUID derived from consultation_section_id and organisation, providing a stable unique identifier.‘660e8400-e29b-41d4-a716-446655440000’
consultation_section_category_codevarcharThe code indicating the category of consultation section.‘OBS’
event_idbigintThe unique internal identifier for the linked clinical event12345
event_guidvarcharThe GUID for the linked clinical event within an organisation‘C3D4E5F6-G7H8-9I0J-1K2L-M3N4O5P6Q7R8’
event_uuidvarcharThe UUID derived from event_id and organisation, providing a stable unique identifier.‘770e8400-e29b-41d4-a716-446655440000’
consultation_idbigintThe unique internal identifier for the consultation record within an organisation.12345
consultation_guidvarcharThe GUID for the consultation record within an organisation‘A1B2C3D4-E5F6-7G8H-9I0J-K1L2M3N4O5P6’
consultation_uuidvarcharThe UUID derived from consultation_id and organisation, providing a stable unique identifier.‘550e8400-e29b-41d4-a716-446655440000’
patient_idbigintThe unique internal identifier for the patient record within the organisation for whom the consultation was recorded.12345
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‘c9d0e1f2-a3b4-2c3d-7e8f-9a0b1c2d3e4f’
patient_organisation_uuidvarcharThe UUID derived from patient_organisation_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
consultation_organisation_idbigintThe unique internal identifier of the organisation where the consultation took place12345
consultation_organisation_guidvarcharThe GUID of the organisation where the consultation was recorded‘c9d0e1f2-a3b4-2c3d-7e8f-9a0b1c2d3e4f’
consultation_organisation_uuidvarcharThe UUID derived from consultation_organisation_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
effective_date_precisionvarcharPrecision indicator for effective date (hardcoded as YMDT)‘YMDT’
consultation_section_heading_code_idbigintThe unique EMIS code identifier for consultation section heading.87901000000115
consultation_section_original_headingvarcharThe original heading for the consultation section.‘Examination’
consultation_source_original_termvarcharThe EMIS term for the consultation source code‘GP Surgery’
consultation_source_code_idbigintThe identifier of the code describing the consultation source (e.g. GP Surgery, Telephone)1672871000006114
availability_datetimetimestamp(6) with time zoneThe date and time the consultation was recorded in the source system‘2025-01-15 14:00:00.000000 UTC’
effective_datetimetimestamp(6) with time zoneThe date and time when the consultation came into effect‘2025-01-15 14:30:00.000000 UTC’
entered_by_user_in_role_idbigintThe unique identifier of the user who entered the consultation record445
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’
authorising_user_in_role_idbigintThe unique identifier of the clinician who authorised or authored the consultation record55
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’
location_idbigintThe unique identifier of the location within an organisation123
location_guidvarcharThe GUID of the location where the consultation was recorded‘c3d4e5f6-a7b8-9012-cdef-123456789012’
location_uuidvarcharThe UUID derived from location_id and organisation, providing a stable unique identifier.‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
location_code_idbigintThe unique EMIS location code identifier1563411000006111
location_type_idbigintThe unique identifier of the location type96
location_type_descriptionvarcharThe description of location type‘GP Surgery’
appointment_slot_idbigintThe unique internal identifier for the appointment slot12345
appointment_slot_guidvarcharThe GUID of the appointment slot in which the consultation was booked‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
appointment_slot_uuidvarcharThe UUID derived from appointment_slot_id and organisation, providing a stable unique identifier‘a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
is_completebooleanIndicates whether the consultation has been completedTRUE
is_confidentialbooleanIndicates whether the consultation record is confidential. This is based on confidentiality set against the patient and consultation.FALSE
is_sensitivebooleanIndicates whether the consultation section record is flagged as sensitive.FALSE
transform_datetimetimestamp(6) with time zoneThe timestamp indicating when the record was last processed and updated in the data model.‘2025-01-15 14:30:22.000000 UTC’
_execution_datevarcharThe transform_datetime formatted as yyyyMMddHHmmss. This column is provided only for backward compatibility.‘20250115143022’

Not used in this schema

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✗✓
consultation_section_idbigint✗✓
emis_consultationsection_guidvarchar✓✓consultation_section_guid
exa_consultationsection_guidvarchar✓✓consultation_section_uuid
hestia_event_typevarchar✓✓consultation_section_category_code
consultation_section_original_headingvarchar✓✓
event_idbigint✗✓
emis_event_guidvarchar✓✓event_guid
exa_event_guidvarchar✓✓event_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
consultation_organisation_idbigint✗✓
emis_consultation_organisation_guidvarchar✓✓consultation_organisation_guid
consultation_organisation_uuidvarchar✗✓
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
location_idbigint✗✓
emis_location_guidvarchar✓✓location_guid
location_uuidvarchar✗✓
location_type_idbigint✗✓
location_type_descriptionvarchar✓✓
location_type_emis_code_idbigint✓✓location_code_id
emis_enteredby_userinrole_guidvarchar✓✓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.
entered_by_user_in_role_idbigint✗✓
entered_by_user_in_role_uuidvarchar✗✓
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓
is_completeboolean✗✓
confidential_flagboolean✓✓is_confidential
confidential_patient_flagboolean✓✗
dummy_patient_flagboolean✓✗
non_regular_and_current_active_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
regular_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
opt_out_93c1_flagboolean✓✗
opt_out_9nd19nu09nu4_flagboolean✓✗
opt_out_9nd19nu0_flagboolean✓✗
opt_out_9nu0_flagboolean✓✗
sensitive_flagboolean✓✓is_sensitive
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓

The table below presents the flavour specific schema.

Column NameData TypeCore Mapping
is_deletedboolean
load_datetimetimestamp(6) with time zone
pseudo_consultation_section_uuidvarcharconsultation_section_uuid
consultation_section_category_codevarchar
pseudo_event_uuidvarcharevent_uuid
pseudo_consultation_uuidvarcharconsultation_uuid
pseudo_patient_uuidvarcharpatient_uuid
pseudo_patient_organisation_uuidvarcharpatient_organisation_uuid
pseudo_consultation_organisation_uuidvarcharconsultation_organisation_uuid
consultation_section_heading_code_idbigint
consultation_section_original_headingvarchar
consultation_source_original_termvarchar
consultation_source_code_idbigint
availability_datetimetimestamp(6) with time zone
effective_datetimetimestamp(6) with time zone
effective_date_precisionvarchar
pseudo_location_uuidvarcharlocation_uuid
location_code_idbigint
location_type_idbigint
location_type_descriptionvarchar
pseudo_appointment_slot_uuidvarcharappointment_slot_uuid
is_completeboolean
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✗✓
consultation_section_idbigint✗✓
emis_consultationsection_guidvarchar✓✓consultation_section_guid
exa_consultationsection_guidvarchar✓✓consultation_section_uuid
hestia_event_typevarchar✓✓consultation_section_category_code
consultation_section_original_headingvarchar✓✓
event_idbigint✗✓
emis_event_guidvarchar✓✓event_guid
exa_event_guidvarchar✓✓event_uuid
consultation_idbigint✗✓
emis_encounter_guidvarchar✓✓consultation_guid
exa_encounter_guidvarchar✓✓consultation_uuid
emis_patient_idbigint✓✓patient_id
registration_guidvarchar✓✓patient_guid
patient_uuidvarchar✗✓
patient_organisation_idbigint✗✓
emis_registration_organisation_guidvarchar✓✓patient_organisation_guid
patient_organisation_uuidvarchar✗✓
consultation_organisation_idbigint✗✓
emis_consultation_organisation_guidvarchar✓✓consultation_organisation_guid
consultation_organisation_uuidvarchar✗✓
registration_ods_codevarchar✓✓Always NULL as it is deprecated in v2. Refer changes in v2 for more details.
location_idbigint✗✓
emis_location_guidvarchar✓✓location_guid
location_uuidvarchar✗✓
location_type_idbigint✗✓
location_type_descriptionvarchar✓✓
location_type_emis_code_idbigint✓✓location_code_id
appointment_slot_idbigint✗✓
emis_appointment_slot_guidvarchar✓✓appointment_slot_guidRenamed from emis_appoinment_slot_guid in V1
appointment_slot_uuidvarchar✗✓
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.
emis_authorising_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✗✓
authorising_user_in_role_idbigint✗✓
authorising_user_in_role_uuidvarchar✗✓
recorded_datetimestamp(6) with time zone✓✓availability_datetime
effective_datetimestamp(6) with time zone✓✓effective_datetime
effective_date_precisionvarchar✓✓
completeboolean✓✓is_complete
confidential_flagboolean✓✓is_confidential
non_regular_and_current_active_flagboolean✓✗
regular_and_current_active_flagboolean✓✗
regular_current_active_and_inactive_flagboolean✓✗
regular_patient_flagboolean✓✗
confidential_patient_flagboolean✓✗
sensitive_patient_flagboolean✓✗
sensitive_flagboolean✓✓is_sensitive
snomed_concept_idbigint✓✗
snomed_description_idbigint✓✗
readv2_codevarchar✓✗
other_code_systemvarchar✓✗
other_codevarchar✓✗
other_displayvarchar✓✗
organisationvarchar✓✓
transform_datetimetimestamp(6) with time zone✗✓
_execution_datevarchar✓✓

Not used in this schema

Not used in this schema

Not used in this schema

Not used in this schema

Not used in this schema