Unstructured secondary care data FHIR mapping
Jump to navigation
Jump to search
Organisation
Organisation
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| ORGREF
LOREF organisation encounter_location |
ORG_ID | OrganisationGuid | Unique ID | Organization::Id* | organization | id |
| ORG_NAME_TXT | OrganisationName | Name of organisation | Organization::name | organization | Name | |
| NHS_ORG_ALIAS | ODSCode | ODS code | Organization::Identifier::Value (use=official, system=ods-organization-code) | organization | ods_code | |
| PARENT_NHS_ORG_ALIAS | ParentOrganisationGuid | Links to Organisation - Organisation - OrganisationGuid | Organization::PartOf::Reference * | organization | parent_organization_id | |
Location
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| ORGREF
LOREF organisation encounter_location |
ID
FACILITY_SOURCE_ID |
LocationGuid | Unique ID | Location::Id* | location | id |
| NURSE_UNIT_LOC_CD
AMBULATORY_LOC_CD SURGERY_LOC_CD BUILDING_LOC_CD FACILITY_LOC_CD FACILITY |
LocationName | Location name | Location::Name | location | name | |
| END_EFFECTIVE_DT_TM | CloseDate | Close Date | Location::primarycare-activeperiod-extension::ValuePeriod::End | - | - | |
| FAX_NBR_TXT | FaxNumber | Fax number | Location::contactPoint::fax (use=work, system=fax) | - | - | |
| EMAIL_TXT | EmailAddress | Email adress | Location::contactPoint::email (use=work, system=email) | - | - | |
| PHONE_NBR_TXT | PhoneNumber | Phone number | Location::contactPoint::phone (use=work, system=phone) | - | - | |
| ADDR_LINE1_TXT | HouseNameFlatNumber | Address name/flat number | Location::Address::Line | - | - | |
| ADDR_LINE2_TXT | NumberAndStreet | Address street | Location::Address::Line | - | - | |
| ADDR_LINE3_TXT | Village | Address village | Location::Address::Line | - | - | |
| ADDR_LINE4_TXT
CITY_TXT |
Town | Address town | Location::Address::City | - | - | |
| COUNTY_CD | County | Address county | Location::Address::District | - | - | |
| POSTCODE_TXT | Postcode | Postcode | Location::Address::PostalCode | location | Postcode | |
Patient Demographics
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| PPATI
PPNAM PPPHO PPADD person person_address person_alias person_demographics person_name person_given_name person_family_name person_language person_phone |
PERSON_ID
EMPI_ID |
PatientGuid | Unique patient ID | Patient::Id* EpisodeOfCare::Id* | patient | id |
| LOCAL_PATIENT_NHS_ORG_ID | OrganisationGuid | Links to Organisation - Organisation - OrganisationGuid | EpisodeOfCare::ManagingOrganization::Reference * | patient | organization_id | |
| NHS_NBR_IDENT
ALIAS ALIAS_TYPE_DISPLAY |
NHSNumber | NHS number | Patient::Identifier::Value (use=official, system=nhs-number) | patient | nhs_number | |
| LOCAL_PATIENT_IDENT | PatientNumber | Patient number | Patient::Identifier::Value (use=secondary, system=patient-number) | patient | person_id | |
| FULL_NAME
PERSON_NAME_RAW_CODE |
FullName | Full name Text | Patient::Name::Text | - | - | |
| TITLE_TXT
TITLE1 |
Title | Title | Patient::Name::Prefix (use=official) | patient | title | |
| FIRST_NAME_TXT
GIVEN_NAME1 |
GivenName | Forename | Patient::Name::Given | patient | first_names | |
| MIDDLE_NAME_TXT
GIVEN_NAME2 |
MiddleNames | Middle name | Patient::Name::Given | patient | first_names | |
| LAST_NAME_TXT
FAMILY_NAME1 |
Surname | Surname | Patient::Name::Family | patient | last_name | |
| NAME_PREFIX_TXT
PREFIX |
Name Prefix | any titles that will precede the regular person name | Patient::Name::Prefix (Type List) | patient | title | |
| NAME_SUFFIX_TXT
SUFFIX |
Name Suffix | any titles that will follow the regular person name | Patient::Name::Suffix | - | - | |
| BEG_EFFECTIVE_DT_TM | EffectiveFrom | The date/time for which the row became effective. | Patient::Name::Period::start | - | - | |
| END_EFFECTIVE_DT_TM | EndDate | The date/time after which the row is no longer valid as active. | Patient::Name::Period::end | - | - | |
| PERSON_NAME_TYPE_CD
PERSON_NAME_TYPE_CODE |
NameType | Identifies the type of name for the person (i.e. current, previous, maiden, other). | Patient::Name::NameUse (Enum) | - | - | |
| BIRTH_DT_TM
BIRTH_DATE |
DateOfBirth | Date of birth | Patient::BirthDate | patient | date_of_birth | |
| DECEASED_DT_TM | DateOfDeath | Date of death | Patient::Deceased | patient | date_of_death | |
| DECEASED_CD
DECEASED |
Deceased (Yes/No) | The codified value identifying if the person is deceased | Patient::deceased(BooleanType) | - | - | |
| GENDER_CD
GENDER_CODE GENDER_DISPLAY |
Sex (Gender) | Sex of patient / Patients gender | Patient::Gender | patient | gender_concept_id | |
| ADDR_LINE1_TXT
ADDRESS_LINE_1 |
HouseNameFlatNumber | House name, flat no | Patient::Address::Line | patient_address | address_line_1 | |
| ADDR_LINE2_TXT
ADDRESS_LINE_2 |
NumberAndStreet | Number and street | Patient::Address::Line | patient_address | address_line_2 | |
| ADDR_LINE3_TXT
ADDRESS_LINE_3 |
Village | Village | Patient::Address::Line | patient_address | address_line_3 | |
| ADDR_LINE4_TXT
CITY_TXT CITY |
Town | Town | Patient::Address::City | patient_address | city | |
| COUNTY_TXT
COUNTY_DISPLAY |
County | County | Patient::Address::District | patient_address | address_line_4 | |
| POSTCODE_TXT
POSTAL_CD |
Postcode | Postcode | Patient::Address::PostalCode | patient_address | postcode | |
| COUNTRY_TXT | Country | Country | Patient::Address::Line | - | - | |
| ADDRESS_TYPE_CD
ADDRESS_TYPE_DISPLAY |
AddressType | Home, temporary, correspondence only, no fixed abode | Patient::Address::Use (temp, home,old) | patient_address | use_concept_id | |
| BEG_EFFECTIVE_DT_TM | DateEvent | The date the patient registered at the address | Patient::Address::Period.start | patient_address | Start_date | |
| END_EFFECTIVE_DT_TM | DateTo | The date the patient left the address | Patient::Address::Period.end | patient_address | end_date | |
| EXTENSION_TXT
PHONE_NBR_TXT EXTENSION PHONE_NUMBER |
HomePhone | Home phone | Patient::contactPoint::phone (use=home, system=phone) | patient_contact | type_concept_id - value | |
| EXTENSION_TXT
PHONE_NBR_TXT EXTENSION PHONE_NUMBER |
MobilePhone | Mobile phone | Patient::contactPoint::phone (use=mobile, system=phone) | patient_contact | type_concept_id - value | |
| CONTACT_METHOD_CD
PHONE_TYPE_CD PHONE_TYPE_CODE PHONE_TYPE_DISPLAY |
ContactType | Home, Mobile, Work | Patient::Telecom::Value (use=home,mobile, system=phone,email) | patient_contact | type_concept_id | |
| BEG_EFFECTIVE_DT_TM | DateEvent | The date the patient registered the contact | Patient::Telecom::Period.start | patient_contact | Start_date | |
| END_EFFECTIVE_DT_TM | EndDate | The date the contact becomes inactive | Patient::Telecom::Period.end | patient_contact | End_date | |
| ETHNIC_GROUP_CD
ETHNICITY_RAW_CODE |
Ethnicity | Ethnicity of the patient | Patient::primarycare-ethnic-category-extension::CodeableConcept | patient | ethnic_code_concept_id | |
| LANGUAGE_CD
LANG_CODE |
LanguageCode | Primary spoken language | Observation::cerner-code-id::CodeableConcept | observation | concept_id | |
| RELIGION_CD
RELIGION_RAW_CODE |
Religion | Religion of the patient | Observation::cerner-code-id::CodeableConcept | observation | concept_id | |
| MARITAL_STATUS_CD
MARITAL_STATUS_CODE |
Marital Status | Status of the person with regard to being married | Patient::maritalStatus | - | - | |
Patient Relationships
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| PPREL
patient_person_relation |
RELATION_CD
RELATION_TYPE_CD |
RelationshipType | The relationship type (for example husband or key worker) | Patient::contact::codeableConcept::text | - | - |
| BEG_EFFECTIVE_DT_TM | DateStarted | The date and time that the relationship started | Patient::contact::Period.start | - | - | |
| END_EFFECTIVE_DT_TM | DateEnded | The date and time that the relationship was ended | Patient::contact::Period.end | - | - | |
| TITLE_TXT | RelationshipWithTitle | The title of the person the relationship is with | Patient::contact::name::Prefix | - | - | |
| FIRST_NAME_TXT | RelationshipWithFirstName | The first names of the person the relationship is with | Patient::contact::name::Given | - | - | |
| MIDDLE_NAME_TXT | RelationshipWithNameFirstName | The first names of the person the relationship is with | Patient::contact::name::Given | - | - | |
| LAST_NAME_TXT | RelationshipWithSurname | The surname of the person the relationship is with | Patient::contact::name::Family | - | - | |
| HOME_ADDR_LINE1_TXT | RelationshipWithHouseName | The house name part of the address of the person the relationship is with | Patient::contact::Address::Line | - | - | |
| HOME_ADDR_LINE2_TXT | RelationshipWithHouseNumber | The house number part of the address of the person the relationship is with | Patient::contact::Address::Line | - | - | |
| HOME_ADDR_LINE3_TXT | RelationshipWithRoad | The road part of the address of the person the relationship is with | Patient::contact::Address::Line | - | - | |
| HOME_ADDR_LINE4_TXT | RelationshipWithLocality | The locality part of the address of the person the relationship is with | Patient::contact::Address::Line | - | - | |
| HOME_CITY_TXT | RelationshipWithPostTown | The post town part of the address of the person the relationship is with | Patient::contact::Address::City | - | - | |
| HOME_COUNTRY_TXT | RelationshipWithCounty | The county part of the address of the person the relationship is with | Patient::contact::Address::District | - | - | |
| HOME_POSTCODE_TXT | RelationshipWithPostCode | The post code of the person the relationship is with | Patient::contact::Address::PostalCode | - | - | |
| HOME_PHONE_NBR_TXT | RelationshipWithTelephone | The telephone number of the person the relationship is with | Patient::contact::contactPoint::phone (use=home, system=phone) | - | - | |
| WORK_PHONE_NBR_TXT | RelationshipWithWorkTelephone | The work telephone number of the person the relationship is with | Patient::contact::contactPoint::phone (use=work, system=phone) | - | - | |
| MOB_PHONE_NBR_TXT | RelationshipWithMobileTelephone | The mobile telephone number of the person the relationship is with | Patient::contact::contactPoint::phone (use=mobile, system=phone) | - | - | |
| EMAIL_TXT | RelationshipWithEmailAddress | The email address of the person the relationship is with | Patient::contact::contactPoint::email (system=email) | - | - | |
Registration
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| PPAGP | PERSON_ID | PatientGuid | Unique patient ID | Patient::Id*
EpisodeOfCare::Id* |
episode_of_care
registration_status_history |
patient_id
patient_id |
| GP_PRSNL_ID | ExternalUsualGPGuid | Unique ID for External Usual GP | Patient::CareProvider::Reference * | - | - | |
| GP_PRAC_ORG_ID | ExternalUsualGPOrganisation | Link to Organisation - Organisation - OrganisationGuid | EpisodeOfCare ::ManagingOrganization::Reference * | patient | registered_practice_organization_id | |
| ACTIVE_IND | Active (Yes/No) | Indicator if the record is active | Patient::careProvider::active | - | - | |
User
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| PRSNLREF
personnel |
PERSONNEL_ID | UserInRoleGuid (IDStaffMember) | Unique ID | Practitioner::Id* | practitioner | id |
| NAME_FULL_TXT | Name | Full name | Practitioner::Name::Text | - | - | |
| TITLE_TXT | Title | Title | Practitioner::Name::Prefix | practitioner | name | |
| NAME_FIRST_TXT
NAME_MIDDLE_TXT |
GivenName | Forename | Practitioner::Name::Given | practitioner | name | |
| NAME_LAST_TXT | Surname | Surname | Practitioner::Name::Family | practitioner | name | |
| POSITION_CD | JobCategoryCode | Job category code | Practitioner::Role::Role::Code | practitioner | role_code | |
| MAIN_SPECIALTY_CD | JobCategoryName (StaffRole) | Job category name | Practitioner::Role::Role::Display | practitioner | role_desc | |
| HCP_NHS_CD_ALIAS_IDENT | IDNational | The ODS code of the staff member, related to the NationalIDType | Practitioner::Identifier::Value (system=gmc-number) | practitioner | gmc_code | |
| GMP_NHS_IDENT | GmpID | The GMP ID associated with this staff member profile | Practitioner::Identifier::Value (system=gmp-ppd-code) | - | - | |
| ACTIVE_IND | Active (Yes/No) | Indicator if the record is active | Practitioner::Active | - | - | |
| BUS_ADDR_LINE1_TXT | Business Address Line 1 | Address associated with the employees business | Practitioner::Address::Line | - | - | |
| BUS_ADDR_LINE2_TXT | Business Address Line 2 | Address associated with the employees business | Practitioner::Address::Line | - | - | |
| BUS_ADDR_LINE3_TXT | Business Address Line 3 | Address associated with the employees business | Practitioner::Address::Line | - | - | |
| BUS_ADDR_LINE4_TXT | Business Address Line 4 | Address associated with the employees business | Practitioner::Address::Line | - | - | |
| BUS_POSTCODE_TXT | Business Postal Code | Address associated with the employees business | Practitioner::Address::PostalCode | - | - | |
| BUS_CITY_TXT | Business City | Address associated with the employees business | Practitioner::Address::City | - | - | |
| BUS_EMAIL_TXT | Business Email Address | Email address associated with the employees business | Practitioner::Telecom::Value (use=work, system=email) | - | - | |
| BUS_FAX_NBR_TXT | Business Fax Number | Fax number associated with the employees business | Practitioner::Telecom::Value (use=work, system=fax) | - | - | |
| BUS_PHONE_NBR_TXT | Business Phone Number | Phone number associated with the employees business | Practitioner::Telecom::Value (use=work, system=phone) | - | - | |
Appointments
Appointment Session
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| appointment | APPOINTMENT_ID | AppointmentSessionGuid | Unique ID | Schedule::Id* | schedule | id |
| REASON_DISPLAY | Description | Name of session | Schedule::Comment | schedule | name | |
| LOCATION_SOURCE_ID | LocationGuid | Link to Organisation - Location - LocationGuid | Schedule::primarycare-location-extension::ReferenceValue * | schedule | location | |
| TYPE_DISPLAY | SessionTypeDescription | Session type | Schedule::Type::Text | schedule | type | |
| START_DT_TM | StartDate | Start date | Schedule::PlanningHorizon::Start | schedule | start_date | |
| START_DT_TM | StartTime | Start time | Schedule::PlanningHorizon::Start | - | - | |
| END_DT_TM | EndDate | End date | Schedule::PlanningHorizon::End | - | - | |
| END_DT_TM | EndTime | End time | Schedule::PlanningHorizon::End | - | - | |
Appointment Session User
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| appointment_participant | APPOINTMENT_ID
SLOT_ID |
SessionGuid | Link to Appointment - Appointment_Session - AppointmentSessionGuid | <used to match to the corresponding FHIR Schedule> | appointment | schedule_id |
| ROLE_RAW_CODE | UserInRoleGuid | Link to User - UserInRoleGuid | Actor::Reference * | appointment | practitioner_id | |
Appointment Slot
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| appointment_slot | APPOINTMENT_ID
SLOT_ID |
SlotGuid (IDAppointment) | Unique ID | Appointment::Id *
Slot::Id * |
appointment | id |
| appointment | STATUS_RAW_CODE | AppointmentStatus | The current status for appointment. The list of possible values is provided in a mapping table | Appointment::Status (=Value) | appointment | appointment_status_concept_id |
| appointment_slot | SLOT_START_DT_TM | AppointmentDate | Date of appointment | Appointment::Start
Slot::Start |
appointment | start_date |
| appointment_slot | SLOT_START_DT_TM | AppointmentStartTime | Time of appointment | Appointment::Start
Slot::Start |
appointment | date_time_sent_in |
| appointment
appointment_slot |
EMPI_ID | PatientGuid (IDPatient) | Link to Patient_Demographics - PatientGuid / The unique identifier for the patient record | Appointment::Participant::Reference * | appointment | patient_id |
| appointment_slot | SLOT_END_DT_TM | LeftTime (DatePatientSeen) | Time patient left | Appointment::primarycare-appointment-left-extension::DateTimeValue
Appointment::Status (=Fulfilled) |
appointment | date_time_left
appointment_status_concept_id |
| appointment_slot | SLOT_FREE_BUSY_TYPE | SlotFreeType | Defines if the slot is available | Slot:freeBusyType = BUSY | - | - |
Care Record
Consultation
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| ENCNT
encounter encounter_type |
ENCNTR_ID
ENCOUNTER_ID |
ConsultationGuid (IDEvent) | Unique ID | Encounter::Id | encounter | id |
| PERSON_ID
EMPI_ID |
PatientGuid (IDPatient) | Link to Patient_Demographics - PatientGuid | Encounter::Patient::Reference | encounter | patient_id | |
| CURRENT_LOC_ID
FACILITY_SOURCE_ID BUILDING_SOURCE_ID |
IDBranch | The unique identifier of the branch at which the date was entered | Encounter::Location::ReferenceValue | encounter | institution_location_id | |
| REG_DT_TM
ACTUAL_ARRIVAL_DT_TM BEGIN_DT_TM |
EffectiveDate (DateEvent) | Clinically effective date | Encounter::Period::Start | encounter | clinical_effective_date | |
| CREATE_DT_TM | EnteredDate (DateEventRecorded) | Entered date | Encounter::primarycare-recorded-date-extension::DateValue | encounter | date_recorded | |
| CREATE_DT_TM | EnteredTime (DateEventRecorded) | Entered time | Encounter::primarycare-recorded-date-extension::DateValue | encounter | date_recorded | |
| RESP_HCP_PRSNL_ID | ClinicianUserInRoleGuid (IDDoneBy) | Links to User - UserInRoleGuid | Encounter::Participant::ReferenceValue | encounter | practitioner_id | |
| FACILITY_SOURCE_ID | ContactEventLocation | The location of contact | Encounter::CodeableConcept.Text (derived) | encounter | non_core_concept_id | |
| VISIT_ID | IDVisit | The unique identifier of the visit linked to the event. | Encounter::Id | encounter | id | |
| FIN_NBR_ID | Financial Number | System Financial Number | Encounter::contained.Parameters.parameter.name
Encounter::contained.Parameters.parameter.valueCodeableConcept.coding.code |
encounter_additional | property_id
text_value id | |
| ENC_TYPE_CD
ENCOUNTER_TYPE_RAW_CODE CLASSIFICATION_RAW_CODE |
Encounter type | Type of encounter - (inpatient / outpatient / emergency) | Encounter::contained.Parameters.parameter.name
Encounter::contained.Parameters.parameter.valueCodeableConcept.coding.code |
encounter_additional | property_id
value_id id | |
| ENC_STATUS_CD
STATUS_RAW_CODE |
Status | Current status (derived from provided list) | Encounter::Status (Encounter.EncounterState enum) | encounter_event | finished | |
| TREATMENT_FUNCTION_CD
HOSPITAL_SERVICE_RAW_CODE ADMISSION_TYPE_RAW_CODE |
Speciality | Speciality / Treatment function | Encounter (Inpatient Admission).containedParameters => IM.ADMISSION_SPECIALITY_CODE | encounter_additional | property_id
value_id | |
| REASON_FOR_VISIT_FREE_TEXT | VisitReason | Free text reason for the encounter | Encounter (Emergency).codeableConcept.code.text | - | - | |
| DISCHARGE_DT_TM | DischargeDate | Date of patient discharge | Encounter::period::end
Encounter::location::period::end |
encounter
episode_of_care |
date_registered_end | |
| DISCHARGE_DISPOSITION_RAW_CODE | Discharged | Discharged (Yes/No) | Encounter (Emergency).period.end, status = FINISHED | encounter
encounter_event |
end_date | |
| DISCHARGE_LOCATION_RAW_CODE | DischargeDestination | Destination patient discharged to | Encounter (Emergency Conclusion).containedParameters => IM.DISCHARGE_DESTINATION | encounter_additional | property_id
value_id | |
| ADMISSION_SOURCE_RAW_CODE | AdmissionSource | Patient admitted from | Encounter (Inpatient Admission).containedParameters => IM.ADMISSION_SOURCE_CODE | encounter_additional | property_id
value_id | |
Procedure
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| PROCE
procedure |
PROCEDURE_ID | ProcedureId | Unique ID | ProcedureRequest::Id | procedure_request | id |
| EMPI_ID | PatientGuid | Link to Patient_Demographics - PatientGuid | ProcedureRequest::Patient::Reference | procedure_request | patient_id | |
| PROCEDURE_DT_TM
SERVICE_START_DT_TM |
EffectiveDate | Clinically effective date | ProcedureRequest::Scheduled:DateValue | procedure_request | clinical_effective_date | |
| PROCEDURE_HCP_PRSNL_ID | ClinicianUserInRoleGuid | Links to User - UserInRoleGuid | ProcedureRequest::Performer::ReferenceValue | procedure_request | practitioner_id | |
| SERVICE_END_DATE_ID | EndDate | The date and time when the procedure finished | Procedure::performedPeriod.end | - | - | |
| PROCEDURE_RAW_CODE | CodeId | Links to Coding - CodeId | ProcedureRequest::CodeableConcept::Coding | procedure_request | non_core_concept_id | |
| DESCRIPTION | OriginalTerm | The numeric value for result observations | ProcedureRequest::CodeableConcept::Text | procedure_request | non_core_concept_id | |
| SOURCE_DESCRIPTION | LocationTypeDescription | Location type description | ProcedureRequest::primarycare-procedure-request-location-extension::Text | - | - | |
| ACTIVE_IND | IsActive | Indicates whether the diary entry is currently active | ProcedureRequest::Status | procedure_request | status_concept_id | |
| ENCNTR_ID
ENCOUNTER_ID |
EncounterGuid | Link to CareRecord - Consultation - EncounterGuid | ProcedureRequest::Encounter::ReferenceValue | procedure_request | encounter_id | |
| PROCEDURE_TYPE_CD | ProcedureType | Type of procedure (derived from provided code list) | Category::Coding::System = "http://www.endeavourhealth.org/fhir/cerner-millenium-procedure-code-type"
Category::Coding::Code = PROCEDURE_TYPE_CD category.coding.display => DAL.getCodeFromCodeSet(401, PROCEDURE_TYPE_CD) |
- | - | |
| CONCEPT_CKI_IDENT | Concept | Used to map client values to a standard value | if SNOMED
Code::Coding::System = "http://snomed.info/sct" Code::Coding::Code = Second part ! delimeter of CONCEPT_CKI_IDENT Code::Coding::Display => TerminologyService.lookupSnomedFromConceptId(coding.code) if OPCS4 Code::Coding::System = "http://www.endeavourhealth.org/fhir/opcs4" Code::Coding::Code = Second part ! delimeter of CONCEPT_CKI_IDENT Code::Coding::Display => TerminologyService.lookupOpcs4ProcedureName(coding.code) |
- | - | |
| COMMENT_TEXT | Comment | Free text comment | Procedure::Notes::Text | - | - | |
Observation
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| CLEVE
result result_comment |
EVENT_ID
RESULT_ID |
ObservationGuid (IDEvent) | Unique ID | Observation::Id | observation | id |
| PERSON_ID
EMPI_ID |
PatientGuid (IDPatient) | Link to Patient_Demographics - PatientGuid | Observation::Patient::Reference | observation | patient_id | |
| EVENT_START_DT_TM
EVENT_END_DT_TM CLIN_SIGNIFICANCE_DT_TM SERVICE_DATE |
EffectiveDate (DateEvent) | Clinically effective date | Observation::EffectiveDate:DateTimeValue | observation | clinical_effective_date | |
| EVENT_CLASS_CD | EffectiveDatePrecision | Date accuracy | Observation::EffectiveDate:DateTimeValue | observation | date_precision_concept_id | |
| EVENT_PERFORMED_DT_TM | EnteredDate | Date entry was created | Observation::primarycare-recorded-date-extension::DateTimeValue | observation | date_recorded | |
| EVENT_PERFORMED_PRSNL_ID | ClinicianUserInRoleGuid (IDDoneBy) | Links to User - UserInRoleGuid | Observation::Performer::ReferenceValue | observation | practitioner_id | |
| PARENT_EVENT_ID | ParentObservationGuid | If this observation has a parent code the link to the ParentObservationGuid is provided here | Observation::parent-resource::ReferenceValue | observation | parent_observation_id | |
| ORDER_ID | DiagnosisGuid | Link to CareRecord - Diagnosis - DiagnosisGuid | Observation::Condiiton::ReferenceValue | - | - | |
| ENCNTR_ID
ENCOUNTER_ID |
ConsultationGuid | Link to CareRecord - Consultation - ConsultationGuid | Observation::Encounter::ReferenceValue | observation | encounter_id | |
| EVENT_CD
ACCESSION_NBR_IDENT |
CodeId | Links to Coding - CodeId | Observation::CodeableConcept::Coding | observation | non_core_concept_id | |
| EVENT_RESULT_STATUS_CD
RESULT_RAW_CODE |
SNOMEDCode | The SNOMED concept ID for this entry | Observation::CodeableConcept::Coding | observation | non_core_concept_id | |
| RESULT_PRIMARY_DISPLAY | SNOMEDText | The textual description for the SNOMED concept ID | Observation::CodeableConcept::Coding | observation | non_core_concept_id | |
| EVENT_RESULT_NBR
ORIG_NUMERIC_VALUE |
Value | The numeric value for result observations | Observation::Quantity::Value | observation | result_value | |
| EVENT_RESULT_UNITS_CD
ORIG_UNIT_OF_MEASURE_DISPLAY |
NumericUnit | Unit | Observation::Quantity::Unit | observation | result_value_units | |
| EVENT_RESULT_TXT
ORIG_TEXT_VALUE |
Result text | The text value | Observation::Value (Type String) | observation | result_text | |
| NORMAL_VALUE_LOW_TXT
NORM_REF_RANGE_LOW |
NumericRangeLow | Low Range | Observation::ReferenceRange::Low | observation_additional | property_id, json_value | |
| NORMAL_VALUE_HIGH_TXT
NORM_REF_RANGE_HIGH |
NumericRangeHigh | High Range | Observation::ReferenceRange::High | observation_additional | property_id, json_value | |
| EVENT_TAG_TXT | EvenTitle | Brief text to describe the event | Observation::Comments | - | - | |
| EVENT_TITLE_TXT | Document result title | The title for document results | Observation::CodeableConcept::Text | - | - | |
| COMMENT_TEXT | Comment | Free text comment | Observation::Comments::Text | - | - | |
Drug Sensitivity **
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| allergy
allergy_reaction |
CRITICALITY_RAW_CODE | Severity | Severity of the allergy | AllergyIntollerance::Reaction::Severity | - | - |
| EMPI_ID | PatientGuid | Link to Patient_Demographics - PatientGuid | AllergyIntollerance::Patient::Reference | - | - | |
| ALLERGY_ID | AllergyId | Unique ID | AllergyIntollerance::Id | - | - | |
| UPDATE_DT_TM | DateEventRecorded | The date and time that the event was entered on to the system | AllergyIntollerance::DateRecorded::DateValue | - | - | |
| ONSET_DT_TM | DateStarted | Date the drug sensitivity started | AllergyIntollerance::Onset::DateValue | - | - | |
| RESOLVED_DT_TM | DateEnded | Date the drug sensitivity ended | AllergyIntollerance::LastOccurance::DateValue | - | - | |
| ALLERGEN_CODE | IDMultiLexAction | The drug Multilex action (links to Medication codeset) | AllergyIntollerance::CodeableConcept::Coding | - | - | |
| ENCOUNTER_ID | IDEvent | The unique identifier of the journal event under which this event was performed. | AllergyIntollerance::encounter-associatedEncounter::ReferenceValue | - | - | |
| STATUS_RAW_CODE | Status | Staus of the allergy (active/resolved) | AllergyIntollerance::Status | - | - | |
| DESCRIPTION | NameOfMedication | The name of the medication. | AllergyIntollerance::CodeableConcept::Text | - | - | |
| REACTION_RAW_CODE | ReactionCode | Reaction type code | AllergyIntollerance::Reaction::Manifestation::CodeableConcept | - | - | |
** This can be recorded in the observation as a Observation Type of allergy instead of it's own file.
Immunisation ***
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| immunization | IMMUNIZATION_DATE | DateEvent | The date and time that the event occurred | Immunization::Date::DateValue | - | - |
| IMMUNIZATION_ID | IDImmunisationContent | The unique identifier for the immunisation/vaccination | Immunization::VaccinationProtocol::Series
Immunization::Id |
- | - | |
| DOSE_QUANTITY
DOSE_UNIT_RAW_CODE |
Dose | The dosage recorded for the immunisation | Immunization::Quantity::Value | - | - | |
| ROUTE_RAW_CODE | Method | The method used for performing the immunisation (for example intradermal) | Immunization::CodeableConcept::Text (Route) | - | - | |
| IMMUNIZATION_RAW_CODE
DRUG_RAW_CODE |
ImmsCode | The immunisation clinical code | Immunization::CodeableConcept::Coding | - | - | |
| LOT | VaccBatchNumber | The vaccination batch number | Immunization::LotNumber::Value | - | - | |
| GIVEN_IND | VaccinationStatus | Defines whether the vaccination was given under GMS | if true:
Immunization::Status = COMPLETED Immunization::WasNotGiven = false Immunization::Reported = false if false: Immunization::Status = ON_HOLD Immunization::WasNotGiven = true Immunization::Reported = false |
- | - | |
| ENCOUNTER_ID | IDEvent | The unique identifier of the journal event under which this event was performed. | Immunization::Encounter::ReferenceValue | - | - | |
| EMPI_ID | PatientGuid | Link to Patient_Demographics - PatientGuid | Immunization::Patient::ReferenceValue | - | - | |
| IMMUNIZATION_DISPLAY | Name | The name of the immunisation | immunization.codeableConcept.coding.text | - | - | |
*** This can be recorded in the observation as a Observation Type of immunisation instead of it's own file.
Diagnosis
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| DIAGN
condition condition_comment |
DIAGNOSIS_ID
CONDITION_ID |
DiagnosisGuid | Unique ID | Condition::Id | Observation | id |
| ENCNTR_ID
ENCOUNTER_ID |
EncounterGuid | Link to CareRecord - Consultation - EncounterGuid | Condition::Encounter::Reference * | Observation | encounter_id | |
| ENCNTR_SLICE_ID | EncounterSliceGuid | Unique Identifier of the encounter slice | Condition::Identifier::Value (System: encounter-slice-id Use: SECONDARY) | - | - | |
| DIAGNOSIS_SEQ_NBR | Sequence | Sequence order of the diagnosis as represented in CDS | Condition::Category::CodeableConcept(System:condition-category) | - | - | |
| DIAGNOSIS_DT_TM
EFFECTIVE_DT_TM |
EnteredDate | Date and time recorded from which the diagnosis was first effective | Condition::Onset (dateTime) | Observation | clinical_effective_date | |
| DIAG_HCP_PRSNL_ID | ClinicianUserInRoleGuid (IDDoneBy) | Personnel Identifier of the Diagnosing Health Care Professional | Condition::Asserter::Reference * | Observation | practitioner_id | |
| DIAGNOSIS_TYPE_CD
CONDITION_TYPE_CODE |
Type | Code Value of the Diagnosis Type | Condition::category::CodeableConcept | - | - | |
| CONCEPT_CKI_IDENT
CONDITION_RAW_CODE |
Concept | Used to map client values to a standard value | Condition::code::CodeableConcept | Observation | non_core_concept_id | |
| DIAGNOSIS_TXT
COMMENT_TEXT |
Text | Free text Diagnosis Text | Condition::notes (String) | - | - | |
| EMPI_ID | PatientGuid | Link to Patient_Demographics - PatientGuid | Condition::Patient::Reference | - | - | |
| CONFIRMATION_STATUS_RAW_CODE
STATUS_DISPLAY |
Status | Current status (derived from provided list) | Condition::VerificationStatus | - | - | |
Prescribing
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| Medication | MEDICATION_ID | DrugRecordGuid | Unique ID | MedicationStatement::Id * | medication_statement | id |
| EMPI_ID | PatientGuid | Link to Patient_Demographics - PatientGuid | MedicationStatement::Patient::Reference * | medication_statement | patient_id | |
| START_DT_TM | EffectiveDate | Clinically effective date | MedicationStatement::DateAsserted | medication_statement | clinical_effective_date | |
| DRUG_CODE
DRUG_RAW_CODE |
CodeId | Link to Coding - CodeId | MedicationStatement::CodeableConcept::Coding | medication_statement | core_concept_id | |
| DOSE | Dosage | Dosage | MedicationStatement::Dosage::Text | medication_statement | dose | |
| DOSE_QUANTITY | Quantity | Quantity | MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Value | medication_statement | quantity_value | |
| DOSE_UNIT_DISPLAY | QuantityUnit | Unit | MedicationStatement::primarycare-medication-authorisation-quantity-extension::Quantity::Unit | medication_statement | quantity_unit | |
| ENCOUNTER_ID | EncounterGuid | Link to CareRecord - Consultation - EncounterGuid | MedicationStatement::Reason::Reference * | - | - | |
| STATUS_DISPLAY | IsActive | Is this still active | MedicationStatement::Status | medication_statement | is_active | |
| STOP_DT_TM | CancellationDate (DateMedicationEnd) | Date of Cancellation | MedicationStatement::primarycare-medication-authorisation-cancellation-extension::DateValue | medication_statement | cancellation_date | |
| DISPLAY_NAME | NameOfMedication | The name of the medication. | MedicationStatement::CodeableConcept::Coding::Text | medication_statement | core_concept_id | |
Coding
A reference file containing the coded entries used by the clinical system is to be provided as a separate file within the extract.
| Publisher | DDS Core | Compass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File Field Name* | Field | Data/Coding Type | FHIR | Table | Field |
| - | CodeId | Unique ID | SCTID:BIGINT | - | - | - |
| Term | Code term | Variable text | - | - | - | |
| Type | SNOMED, Read, Ctv3, DM&D ID, Local code, etc. | Variable text or NumericINT | - | - | - | |
| ParentCodeID | Unique ID | SCTID:BIGINT | - | - | - | |
* Example organisation data files and file field names only. File and field names can differ across different systems.