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_timetimestampData ingestion timestamp’2025-01-15 14:30:22.123456’
consultation_guidvarcharEMIS consultation GUID’A1B2C3D4-E5F6-7G8H-9I0J-K1L2M3N4O5P6’
consultation_uuidvarcharGlobally unique identifier (UUID5 from consultation_id + organisation)‘550e8400-e29b-41d4-a716-446655440000’
patient_idvarcharPatient identifier’P001’
patient_guidvarcharPatient GUID’PAT-GUID-001’
patient_organisation_guidvarcharPatient’s organisation GUID’ORG-GUID-001’
consultation_organisation_guidvarcharConsultation organisation GUID’CONS-ORG-GUID-001’
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_idvarcharUser who entered the consultation’USER001’
authorising_user_in_role_idvarcharUser who authorised the consultation’USER002’
location_guidvarcharPhysical location identifier’LOC001’
location_code_idbigintLocation code identifier123456
location_type_descriptionvarcharDescription of location type’GP Surgery’
appointment_slot_guidvarcharReference to scheduled appointment slot’SLOT001’
is_completebooleanWhether consultation is completetrue
has_consultation_sectionsbooleanWhether consultation has sectionstrue
is_confidentialbooleanCurrent confidentiality statusfalse
was_confidentialbooleanHistorical confidentiality state for tracking transitionsfalse
transform_datetimetimestampTransform 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_timetimestamp
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_consultation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_location_guidvarchar
location_type_descriptionvarchar
location_type_emis_code_idbigint
emis_appointment_slot_guidvarchar
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
authorising_user_in_role_idvarchar
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_datetimevarchar
_execution_datedate

Not used in this schema

Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_consultation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_location_guidvarchar
location_type_descriptionvarchar
location_type_emis_code_idbigint
emis_appointment_slot_guidvarchar
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
authorising_user_in_role_idvarchar
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_datetimevarchar
_execution_datedate
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedboolean
emis_encounter_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_consultation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_location_guidvarchar
location_type_descriptionvarchar
location_type_emis_code_idbigint
emis_appointment_slot_guidvarchar
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
authorising_user_in_role_idvarchar
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_datetimevarchar
_execution_datedate
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedboolean
emis_consultation_idbigint
emis_encounter_guidvarchar
exa_encounter_guidvarchar
emis_patient_idvarchar
registration_guidvarchar
emis_registration_organisation_guidvarchar
emis_consultation_organisation_guidvarchar
registration_ods_codevarcharAlways NULL as it is deprecated in v2. Refer definitions/universal improvements for more details.
emis_location_guidvarchar
location_type_descriptionvarchar
location_type_emis_code_idbigint
emis_appointment_slot_guidvarchar
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
authorising_user_in_role_idvarchar
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_datetimevarchar
_execution_datedate
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedbooleandeletedExists in v1 with a different name
consultation_idbigint
consultation_guidvarchar
id_type5varchar
patient_guidvarchar
organisation_guidvarchar
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
authorising_user_in_role_idvarchar
appointment_slot_guidvarchar
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_datetimevarchar
execution_datedate
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedbooleandeletedExists in v1 with a different name
emis_consultation_idbigint
emis_consultation_guidvarchar
exa_consultation_guidvarchar
pseudo_registration_guidvarcharAnonymised using SECRET_HASHER
emis_registration_organisation_guidvarchar
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
authorising_user_in_role_idvarchar
emis_appointment_slot_guidvarchar
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_datetimevarchar
execution_datedate
Column NameData TypeData Exists in v1Data Exists in v2Comments
_ingest_timetimestamp
is_deletedboolean
emis_consultation_idbigint
emis_consultation_guidvarchar
exa_consultation_guidvarchar
pseudo_registration_guidvarcharAnonymised using SECRET_HASHER
emis_registration_organisation_guidvarchar
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
authorising_user_in_role_idvarchar
emis_appointment_slot_guidvarchar
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_datetimevarchar
_execution_datedate

Not used in this schema