TPP Extract FHIR Mapping
Jump to navigation
Jump to search
To see the latest Compass V2 schema, please see Discovery Remote Subscriber Database Familiarisation#Data_Mapping.
The number of extract tables received differs wildly across each of the community organisations, from 20 up to 66 of the total possible SystmOne extract total of 194.
The existing TPP inbound transform processes 36 schema files. Two tables, SRRecall and SRRecordStatus are received and transformed for GP S1 systems, but not Community.
SRAppointment
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Appointment::Id | appointment | id |
| DateStart | Appointment::Start
Slot::Start |
appointment | start_date |
| DateEnd | Appointment::end
Slot::end |
- | - |
| AppointmentStatus | Appointment::Status (=Value) | appointment | appointment_status_concept_id |
| DateAppointmentBooked | Appointment::appointment-booking-date-extension::DateValue* | - | - |
| DatePatientArrival | Appointment::primarycare-appointment-sent-in-extension::DateTimeValue
Appointment::Status (=Arrived) |
appointment | date_time_sent_in
appointment_status_concept_id |
| DatePatientSeen | Appointment::primarycare-appointment-left-extension::DateTimeValue
Appointment::Status (=Fulfilled) |
appointment | date_time_left
appointment_status_concept_id |
| TelephoneAppointment | Appointment::Type::Value | appointment_additional | property_id (type), text |
| IDProfileClinician | Schedule::primarycare-recorded-by-extension::ReferenceValue* | - | - |
| DateAppointmentCancelled | Appointment::appointment-cancellation-date-extension::DateValue* | - | - |
| IDRota | Slot::Schedule::Reference * | appointment | schedule_id |
| IDPatient | Appointment::Participant::Reference * | appointment | patient_id |
| RemovedData | - | - | - |
SRCcg
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Organization::Id* | organization | id |
| Name | Organization::Name | organization | name |
| OdsCode | Organization::Identifier::Value (use=official, system=ods-organization-code) | organization | ods_code |
| HouseName | Organization::Address::Line | - | - |
| HouseNumber | Organization::Address::Line | - | - |
| NameOfRoad | Organization::Address::Line | - | - |
| NameOfLocality | Organization::Address::Line | - | - |
| NameOfTown | Organization::Address::City | - | - |
| NameOfCounty | Organization::Address::District | - | - |
| FullPostCode | Organization::Address::PostalCode | organization | postcode |
| Telephone | Organization::Telecom (use=work, system=phone) | - | - |
| SecondaryTelephone | Organization::Telecom (use=work, system=phone) | - | - |
| Fax | Organization::Telecom (use=work, system=fax) | - | - |
| RemovedData | - | - | - |
SRCode
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | AllergyIntolerance::id
Procedure::id Condition::id Observation::id FamilyMemberHistory::id |
Allergy_Intolerance
Procedure_Request Observation |
id |
| DateEventRecorded | AllergyIntolerance::recordedDate
Procedure::recordedDate Condition::recordedDate Observation::recordedDate FamilyMemberHistory::recordedDate |
Allergy_Intolerance
Procedure_Request Observation |
date_recorded |
| DateEvent | AllergyIntolerance::onset
Procedure::onset Condition::onset Observation::onset FamilyMemberHistory::onset |
Allergy_Intolerance
Procedure_Request Observation |
clinical_effective_date |
| IDProfileEnteredBy | AllergyIntolerance::extension::primarycare-recorded-by-extension Condition::extension::primarycare-recorded-by-extension Procedure::extension::primarycare-recorded-by-extension Observation::extension::primarycare-recorded-by-extension FamilyMemberHistory::extension::primarycare-recorded-by-extension | - | - |
| IDDoneBy | AllergyIntolerance::recorder
Procedure::recorder Condition::asserter Observation::performer FamilyMemberHistory::primarycare-family-member-history-reporter-extension |
Allergy_Intolerance
Procedure_Request Observation |
practitioner_id |
| CTV3Code | AllergyIntolerance::substance::coding::readv2::code FamilyMemberHistory::category::coding::readv2::code Observation::code::coding::readv2::code
Condition::category::coding::code Procedure::code::coding::code |
- | - |
| CTV3Text | AllergyIntolerance::substance::coding::readv2::display FamilyMemberHistory::category::coding::readv2::display Observation::code::coding::readv2::display Condition::category::coding::readv2::display Procedure::code::coding::readv2::display | - | - |
| SNOMEDCode | AllergyIntolerance::substance::coding::sct::code FamilyMemberHistory::category::coding::sct::code Observation::code::coding::sct::code
Condition::category::coding::sct::code Procedure::code::coding::sct::code |
- | - |
| SNOMEDText | AllergyIntolerance::substance::coding::sct::display FamilyMemberHistory::category::coding::sct::display Observation::code::coding::sct::display
Condition::category::coding::sct::display Procedure::code::coding::sct::display |
- | - |
| NumericComparator | Observation::valueNumberComparator | - | - |
| NumericValue | Observation::valueNumber | Observation | result_value |
| NumericUnit | Observation::valueUnits | Observation | result_value_units |
| EpisodeType | Condition::extension::primarycare-problem-episodicity | Observation | episodicity_concept_id |
| IDEvent | Condition::encounter
Observation::encounter AllergyIntolerance::encounter Procedure::encounter FamilyMemberHistory::encounter |
AllergyIntolerance
Procedure Condition Observation FamilyMemberHistory |
encounter_id |
| IDPatient | Condition::patient
Procedure::patient AllergyIntolerance::patient Observation::patient FamilyMemberHistory::patient |
AllergyIntolerance
Procedure Condition Observation FamilyMemberHistory |
patient_id |
| RemovedData | - | - | - |
SRDrugSensitivity
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | AllergyIntolerance::id | allergy_intolerance | id |
| DateEventRecorded | AllergyIntolerance::recordedDate | allergy_intolerance | date_recorded |
| IDProfileEnteredBy | AllergyIntolerance::extension::primarycare-recorded-by-extension | - | - |
| IDDoneBy | AllergyIntolerance::recorder | allergy_intolerance | practitioner_id |
| DateStarted | AllergyIntolerance::onset | allergy_intolerance | clinical_effective_date |
| DateEnded | AllergyIntolerance::lastOccurance | - | - |
| IDDrugCode | AllergyIntolerance::allergy_intolerance_main_code::coding::code | allergy_intolerance | non_core_concept_id |
| IDMultiLexAction | AllergyIntolerance::code_system_tpp_drug_action_group::coding::display | allergy_intolerance | core_concept_id |
| IDEvent | AllergyIntolerance::encounter | allergy_intolerance | encounter_id |
| IDPatient | AllergyIntolerance::patient | allergy_intolerance | patient_id |
| NameOfMedication | AllergyIntolerance::code_system_tpp_drug_action_group::text | - | - |
| RemovedData | - | - | - |
SREvent
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Encounter::id | Encounter | id |
| DateEventRecorded | Encounter::extension::primarycare-recorded-date-extension | Encounter | date_recorded |
| DateEvent | Encounter::period::start | Encounter | clinical_effective_date |
| IDProfileEnteredBy | Encounter::extension::primarycare-recorded-by-extension | - | - |
| IDDoneBy | Encounter::participant::individual | Encounter | practitioner_id |
| IDOrganisationDoneAt | Encounter::serviceProvider | Encounter | service_provider_organisation_id |
| ContactEventLocation | Encounter::extension::encounter-location-type-extension::valueCodeableConcept::text | Encounter | core_concept_id |
| ContactMethod | Encounter::extension::primarycare-encounter-source::valueCodeableConcept::text | - | - |
| EventIncomplete | Encounter::extension::primarycare-encounter-incomplete::value | - | - |
| ClinicalEvent | Encounter::extension::primarycare-encounter-source::valueCodeableConcept::text | - | - |
| IDPatient | Encounter::patient | Encounter | patient_id |
| IDOrganisation | Encounter::location::location | Encounter | organization_id |
| IDBranch | Encounter::location::location | - | - |
| RemovedData | - | - | - |
SRImmunisation
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Immunization::id | Observation | id |
| DateEventRecorded | Immunization::extension::primarycare-recorded-date-extension | Observation | date_recorded |
| DateEvent | Immunization::date | Observation | clinical_effective_date |
| IDProfileEnteredBy | Immunization::primarycare-recorded-by-extension::valueReference | - | - |
| IDDoneBy | Immunization::performer::reference | Observation | practitoner_id |
| IDImmunisationContent | Immunization::vaccinationProtocol::series | - | - |
| Dose | Immunization::doseQuantity | - | - |
| Location | Immunization::immunizationSite::text | - | - |
| Method | Immunization::immunizationRoute::text | - | - |
| DateExpiry | Immunization::expirationDate | - | - |
| ImmsReadCode | Immunization::vaccineCode::coding::readv2::code | Observation | core_concept_id
non_core_concept_id |
| ImmsSNOMEDCode | Immunization::vaccineCode::coding::snomed::code | Observation | core_concept_id
non_core_concept_id |
| VaccPart | Immunization::vaccinationProtocol::doseSequence
Immunization::vaccinationProtocol::description |
- | - |
| VaccBatchNumber | Immunization::lotNumber | - | - |
| IDEvent | Immunization::encounter::reference | Observation | encounter_id |
| IDPatient | Immunization::patient::reference | Observation | patient_id |
| RemovedData | - | - | - |
SROrganisation
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Organization::Id* | organization | id |
| Name | Organization::name | organization | Name |
| ID | Organization::Identifier::Value (use=official, system=ods-organization-code) | organization | ods_code |
| HouseName | Organization::Address::Line | - | - |
| HouseNumber | Organization::Address::Line | - | - |
| NameOfRoad | Organization::Address::Line | - | - |
| NameOfLocality | Organization::Address::Line | - | - |
| NameOfTown | Organization::Address::City | - | - |
| NameOfCounty | Organization::Address::District | - | - |
| FullPostCode | Organization::Address::PostalCode | organization | postcode |
| Telephone | Organization::Telecom (use=work, system=phone) | - | - |
| SecondaryTelephone | Organization::Telecom (use=work, system=phone) | - | - |
| Fax | Organization::Telecom (use=work, system=fax) | - | - |
| IDTrust | Organization::PartOf::Reference * | organization | parent_organization_id |
| IDCcg | Organization::PartOf::Reference * | organization | parent_organization_id |
| RemovedData | - | - | - |
SROrganisationBranch
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | location::id | location | id |
| BranchName | location::name | location | name |
| HouseName | location::address::line | location | |
| HouseNumber | location::address::line | location | |
| RoadName | location::address::line | location | |
| Locality | location::address::line | location | |
| Town | location::address::city | location | |
| County | location::address::district | location | |
| PostCode | location::address::postalcode | location | postcode |
| BranchObsolete | location::status | location | |
| IDOrganisation | location::managingOrganization.reference | location | managing_organization |
SRPatient
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Patient::Id* | patient | id |
| Title | Patient::Name::Prefix (use=official) | patient | title |
| FirstName | Patient::Name::Given | patient | first_names |
| MiddleNames | Patient::Name::Given | patient | first_names |
| Surname | Patient::Name::Family | patient | last_name |
| NHSNumber | Patient::Identifier::Value (use=official, system=nhs-number) | patient | nhs_number |
| DateBirth | Patient::BirthDate | patient | date_of_birth |
| DateDeath | Patient::Deceased | patient | date_of_death |
| Gender | Patient::Gender | patient | gender_concept_id |
| SpeaksEnglish | Patient::patient-speaks-english-extension::ValueBoolean (extension is only created if value is true) | - | - |
| EmailAddress | Patient::contactPoint::email (use=home, system=email) | patient_contact | type_concept_id - value |
| TestPatient | Patient::patient-is-test-patient-extension::ValueBoolean (extension is only created if value is true) | - | - |
| SpineMatched | Patient::extension::primarycare-nhs-number-verification-status-extension | - | - |
| RemovedData | - | - | - |
SRPatientAddressHistory
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| IDOrganisationVisibleTo | Patient::managingOrganisation | patient | registered_practice_organization_id |
| DateEvent | Patient::Address::Period.start | patient_address | start_date |
| NameOfBuilding | Patient::Address::Line | patient_address | address_line_1 |
| NumberOfBuilding | Patient::Address::Line | patient_address | address_line_1 |
| NameOfRoad | Patient::Address::Line | patient_address | address_line_2 |
| NameOfLocality | Patient::Address::Line | patient_address | address_line_3 |
| NameOfTown | Patient::Address::City | patient_address | city |
| NameOfCounty | Patient::Address::District | patient_address | address_line_4 |
| FullPostCode | Patient::Address::PostalCode | patient_address | postcode |
| DateTo | Patient::Address::Period.end | patient_address | end_date |
| AddressType | Patient::Address::Use (temp, home,old) | patient_address | use_concept_id |
SRPatientContactDetails
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Patient::id | Patient | id |
| DateEvent | Patient::contact:period.startDate | patient_contact | start_date |
| ContactType | Patient::contact::telecom | patient_contact | |
| ContactNumber | Patient::contact::telecom.value | patient_contact | value |
| IDPatient | Patient::id | Patient | id |
SRPatientRegistration
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | EpisodeOfCare::id | episode_of_care | id |
| IDOrganisationVisibleTo | EpisodeOfCare::managingOrganization.reference | episode_of_care | organisation_id |
| DateRegistration | EpisodeOfCare::period.start | episode_of_care | date_registered |
| DateDeRegistration | EpisodeOfCare::period.end | episode_of_care | date_registered_end |
| RegistrationStatus | EpisodeOfCare::extension | episode_of_care | registration_status_concept_id |
| IDPatient | EpisodeOfCare::patient.reference | episode_of_care | patient_id |
| IDOrganisation | - | - | - |
| RemovedData | - | - | - |
SRPatientRelationship
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Patient::contact::id | n/a | n/a |
| DateEvent | Patient::contact::period.start | n/a | n/a |
| DateEnded | Patient::contact::period.end | n/a | n/a |
| RelationshipType | Patient::contact::relationship | n/a | n/a |
| NextOfKin | Patient::contact::extension::patient-contact-is-next-of-kin | n/a | n/a |
| CaresForPatient | Patient::contact::extension::patient-contact-is-carer | n/a | n/a |
| PrincipalCarerForPatient | Patient::contact::extension::patient-contact-is-carer | n/a | n/a |
| RelationshipWithName | Patient::contact::name | n/a | n/a |
| RelationshipWithHouseName | Patient::contact::address.line | n/a | n/a |
| RelationshipWithHouseNumber | Patient::contact::address.line | n/a | n/a |
| RelationshipWithRoad | Patient::contact::address.line | n/a | n/a |
| RelationshipWithLocality | Patient::contact::address.line | n/a | n/a |
| RelationshipWithPostTown | Patient::contact::address.city | n/a | n/a |
| RelationshipWithCounty | Patient::contact::address.district | n/a | n/a |
| RelationshipWithPostCode | Patient::contact::address.postalcode | n/a | n/a |
| RelationshipWithTelephone | Patient::contact::telecom | n/a | n/a |
| RelationshipWithWorkTelephone | Patient::contact::telecom | n/a | n/a |
| RelationshipWithMobileTelephone | Patient::contact::telecom | n/a | n/a |
| RelationshipWithFax | Patient::contact::telecom | n/a | n/a |
| RelationshipWithEmailAddress | Patient::contact::telecom | n/a | n/a |
| IDPatient | Patient::id | n/a | n/a |
| RemovedData | n/a | n/a | |
SRPersonAtRisk
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | Flag::id | Flag | id |
| DateAdded | Flag::extension::primarycare-recorded-date-time-extension::valueDateTime | Flag | effective_date |
| IDProfileEnteredBy | Flag::author::reference | - | - |
| ProtectionPlan | Flag::status | Flag | is_active |
| DateRemoved | Flag::period::end | - | - |
| IDPatient | Flag::patient::reference | Flag | patient_id |
| ReasonForPlan | Flag::code::text | Flag | flag_text |
| RemovedData | - | - | - |
SRPrimaryCareMedication
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| RowIdentifier | MedicationOrder::id
MedicationStatement::id |
medication_order
medication_statement |
id |
| DateEventRecorded | MedicationOrder::extension::primarycare-recorded-date-extension::valueReference MedicationStatement::extension::primarycare-recorded-date-extension::valueReference | - | - |
| IDProfileEnteredBy | MedicationOrder::extension::primarycare-recorded-by-extension::valueReference MedicationStatement::extension::primarycare-recorded-by-extension::valueReference | - | - |
| IDDoneBy | MedicationOrder::prescriber::reference
MedicationStatement::informationSource::reference |
medication_order
medication_statement |
practitoner_id |
| IDMultiLexDMD | MedicationStatement::medicationCodeableConcept::coding::code MedicationOrder::medicationCodeableConcept::coding:code | - | - |
| NameOfMedication | MedicationStatement::medicationCodeableConcept::coding::display MedicationOrder::medicationCodeableConcept::coding:display | medication_order
medication_statement |
core_concept_id |
| DateMedicationStart | MedicationStatement::dateAsserted
MedicationStatement::dateWritten |
medication_order
medication_statement |
clinical_effective_date |
| DateMedicationEnd | MedicationStatement::extension::primarycare-medication-authorisation-cancellation-extension::valueReference | medication_statement | cancellation_date |
| MedicationDosage | MedicationStatement::dosage::text
MedicationOrder::dosageInstruction::text |
medication_order
medication_statement |
dose |
| MedicationQuantity | MedicationStatement::extension::primarycare-medication-authorisation-quantity-extension::valueQuantity
MedicationOrder::dispenseRequest::quantity |
medication_order
medication_statement |
quantity_value |
| IsRepeatMedication | MedicationStatement::primarycare-medication-autorisation-type-extension::valueCoding::display | - | - |
| IDEvent | MedicationStatement::encounter::reference
MedicationOrder::encounter::reference |
medication_order
medication_statement |
encounter_id |
| IDPatient | MedicationStatement::patient::reference
MedicationOrder::patient::reference |
medication_order
medication_statement |
patient_id |
| RemovedData | - | - | - |
SRProblem
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |
| DateEnd | Condition::abatementDate | Observation | problem_end_date |
| Severity | Condition::extension::primarycare-problem-significance-extension::value | - | - |
SRRecall
| Publisher | DDS Core | Compass V2 | |
|---|---|---|---|
| Field Name | FHIR | Table | Field |