Skip to content
Partner Developer Portal

Schema

The raw consultation schema represents the core consultation data extracted from the serving layer of the iPCV pipeline:

Column NameData TypeDescriptionExample
consultation_idbigintUnique identifier for the consultation12345
organisationvarcharOrganisation identifier where consultation occurred’CDB-001’
is_deletedbooleanSoft deletion flagfalse
_ingest_timevarcharData ingestion timestamp’2025-01-15 14:30:22.123456’
consultation_guidvarcharEMIS consultation GUID’A1B2C3D4-E5F6-7G8H-9I0J-K1L2M3N4O5P6’
consultation_uuidvarcharDeterministic UUID5 generated from consultation_id + organisation’550e8400-e29b-41d4-a716-446655440000’
patient_idbigintPatient identifier12345
patient_guidvarcharPatient GUID’PAT-GUID-001’
patient_uuidvarcharDeterministic UUID5 generated from patient_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
patient_organisation_idbigintPatient’s organisation internal identifier12345
patient_organisation_guidvarcharPatient’s organisation GUID’ORG-GUID-001’
patient_organisation_uuidvarcharDeterministic UUID5 generated from patient_organisation_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
consultation_organisation_idbigintConsultation organisation internal identifier12345
consultation_organisation_guidvarcharConsultation organisation GUID’CONS-ORG-GUID-001’
consultation_organisation_uuidvarcharDeterministic UUID5 generated from consultation_organisation_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
effective_date_precisionvarcharPrecision indicator for effective date (hardcoded as YMDT)‘YMDT’
consultation_source_original_termvarcharOriginal term for consultation source’GP Surgery’
consultation_source_code_idbigintCode for consultation source location1572871000006117
availability_datetimetimestampWhen consultation slot became available’2025-01-15 14:00:00’
effective_datetimetimestampWhen consultation occurred’2025-01-15 14:30:00’
entered_by_user_in_role_idbigintUser who entered the consultation44556677
entered_by_user_in_role_uuidvarcharDeterministic UUID5 generated from entered_by_user_in_role_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
authorising_user_in_role_idbigintUser who authorised the consultation55667788
authorising_user_in_role_uuidvarcharDeterministic UUID5 generated from authorising_user_in_role_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
location_idbigintInternal identifier for the location12345
location_guidvarcharPhysical location identifier’LOC001’
location_uuidvarcharDeterministic UUID5 generated from location_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
location_code_idbigintLocation code identifier123456
location_type_idbigintInternal identifier for the location type12345
location_type_descriptionvarcharDescription of location type’GP Surgery’
appointment_slot_idbigintInternal identifier for the appointment slot12345
appointment_slot_guidvarcharReference to scheduled appointment slot’SLOT001’
appointment_slot_uuidvarcharDeterministic UUID5 generated from appointment_slot_id + organisation’a1b2c3d4-e5f6-4a5b-9c8d-0e1f2a3b4c5d’
is_completebooleanWhether consultation is completetrue
has_consultation_sectionsbooleanWhether consultation has sectionstrue
is_confidentialbooleanCurrent confidentiality statusfalse
was_confidentialbooleanHistorical confidentiality state for tracking transitionsfalse
transform_datetimetimestamp(6) with time zoneTransform processing timestamp’2025-01-15 14:30:22’
_execution_datevarcharPipeline execution date (yyyyMMdd format)‘20250115’
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
consultation_organisation_idbigint
emis_consultation_organisation_guidvarchar
consultation_organisation_uuidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
location_idbigint
emis_location_guidvarchar
location_uuidvarchar
location_type_idbigint
location_type_descriptionvarchar
location_type_emis_code_idbigint
appointment_slot_idbigint
emis_appointment_slot_guidvarchar
appointment_slot_uuidvarchar
consultation_source_emis_code_idbigint
emis_original_termvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
recorded_datetimestamp
effective_datedate
effective_date_precisionvarchar
completeboolean
confidential_flagboolean
has_sections_flagboolean
confidential_patient_flagboolean
dummy_patient_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
non_regular_and_current_active_flagboolean
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
sensitive_flagbooleanAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Not used in this schema

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
consultation_organisation_idbigint
emis_consultation_organisation_guidvarchar
consultation_organisation_uuidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
location_idbigint
emis_location_guidvarchar
location_uuidvarchar
location_type_idbigint
location_type_descriptionvarchar
location_type_emis_code_idbigint
appointment_slot_idbigint
emis_appointment_slot_guidvarchar
appointment_slot_uuidvarchar
consultation_source_emis_code_idbigint
emis_original_termvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
recorded_datetimestamp
effective_datedate
effective_date_precisionvarchar
completeboolean
confidential_flagboolean
has_sections_flagboolean
confidential_patient_flagboolean
dummy_patient_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
non_regular_and_current_active_flagboolean
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
sensitive_flagbooleanAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
emis_encounter_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
consultation_organisation_idbigint
emis_consultation_organisation_guidvarchar
consultation_organisation_uuidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
location_idbigint
emis_location_guidvarchar
location_uuidvarchar
location_type_idbigint
location_type_descriptionvarchar
location_type_emis_code_idbigint
appointment_slot_idbigint
emis_appointment_slot_guidvarcharemis_appoinment_slot_guid
appointment_slot_uuidvarchar
consultation_source_emis_code_idbigint
consultation_source_emis_original_termvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
recorded_datetimestamp
effective_datedate
effective_date_precisionvarchar
completeboolean
confidential_flagboolean
has_sections_flagboolean
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_flagbooleanAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
consultation_organisation_idbigint
emis_consultation_organisation_guidvarchar
consultation_organisation_uuidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
location_idbigint
emis_location_guidvarchar
location_uuidvarchar
location_type_idbigint
location_type_descriptionvarchar
location_type_emis_code_idbigint
appointment_slot_idbigint
emis_appointment_slot_guidvarchar
appointment_slot_uuidvarchar
consultation_source_emis_code_idbigint
emis_original_termvarchar
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
recorded_datetimestamp
effective_datedate
effective_date_precisionvarchar
completeboolean
confidential_flagboolean
has_sections_flagboolean
confidential_patient_flagboolean
dummy_patient_flagboolean
opt_out_93c1_flagboolean
opt_out_9nd19nu09nu4_flagboolean
opt_out_9nd19nu0_flagboolean
opt_out_9nu0_flagboolean
non_regular_and_current_active_flagboolean
regular_and_current_active_flagboolean
regular_current_active_and_inactive_flagboolean
regular_patient_flagboolean
sensitive_patient_flagboolean
sensitive_flagbooleanAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
other_codevarchar
other_code_systemvarchar
other_displayvarchar
readv2_codevarchar
snomed_concept_idbigint
snomed_description_idbigint
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedbooleandeletedExists in v1 with a different name
consultation_idbigint
consultation_guidvarchar
id_type5varchar
patient_idbigint
patient_guidvarchar
patient_uuidvarchar
patient_organisation_idbigint
organisation_guidvarchar
patient_organisation_uuidvarchar
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timetime
clinician_user_in_role_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
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_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
appointment_slot_idbigint
appointment_slot_guidvarchar
appointment_slot_uuidvarchar
consultation_source_termvarchar
consultation_source_code_idbigint
completeboolean
deletedboolean
is_confidentialboolean
processing_idbigintAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
execution_datevarchar
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedbooleandeletedExists in v1 with a different name
emis_consultation_idbigint
emis_consultation_guidvarchar
exa_consultation_guidvarchar
pseudo_registration_guidvarcharAnonymised using SECRET_HASHER
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timetime
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
appointment_slot_idbigint
emis_appointment_slot_guidvarchar
appointment_slot_uuidvarchar
emis_original_termvarchar
consultation_source_emis_code_idbigint
completeboolean
deletedboolean
confidential_flagboolean
processing_idbigintAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
execution_datevarchar
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timevarchar
is_deletedboolean
emis_consultation_idbigint
emis_consultation_guidvarchar
exa_consultation_guidvarchar
pseudo_registration_guidvarcharAnonymised using SECRET_HASHER
patient_uuidvarchar
patient_organisation_idbigint
emis_registration_organisation_guidvarchar
patient_organisation_uuidvarchar
effective_datedate
effective_date_precisionvarchar
entered_datedate
entered_timetime
emis_authorising_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_enteredby_userinrole_guidvarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
entered_by_user_in_role_idvarchar
entered_by_user_in_role_uuidvarchar
authorising_user_in_role_idvarchar
authorising_user_in_role_uuidvarchar
appointment_slot_idbigint
emis_appointment_slot_guidvarchar
appointment_slot_uuidvarchar
emis_original_termvarchar
consultation_source_emis_code_idbigint
completeboolean
deletedboolean
confidential_flagboolean
processing_idbigintAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
organisationvarchar
transform_datetimetimestamp(6) with time zone
_execution_datevarchar

Not used in this schema