Unstructured secondary care data FHIR mapping: Difference between revisions
Jump to navigation
Jump to search
| Line 1,163: | Line 1,163: | ||
|} | |} | ||
=== Immunisation*** === | === Immunisation<span style="color:red;"> ***</span> === | ||
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top; width:100%;" | {| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top; width:100%;" | ||
! colspan="4" style="color:#90A4AE" |'''Publisher''' | ! colspan="4" style="color:#90A4AE" |'''Publisher''' | ||
Revision as of 12:13, 15 November 2023
Organisation
Organisation
| Publisher | DDS Core | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass 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 | 0 | - | - | |
Patient Relationships
| Publisher | DDS Core | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass 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 | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Procedure
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Observation
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Drug Sensitivity **
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Immunisation ***
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Diagnosis
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Registration
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Coding
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
Prescribing
| Publisher | DDS Core | CollapseCompass V2 | ||||
|---|---|---|---|---|---|---|
| Organisation Data Files * | File field Name | Field | Data/Coding Type | FHIR | Table | Field |
* Example organisation data files only. File names can differ across different systems.