BHRUT Medway Extract FHIR Mapping: Difference between revisions

From Endeavour Knowledge Base
No edit summary
m (JoshuA moved page BHRUT Extract FHIR Mapping to BHRUT Medway Extract FHIR Mapping without leaving a redirect)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
BHRUT
{{DISPLAYTITLE:BHRUT Medway Extract FHIR Mapping}}
== Case ==
 
This file contains details of patient out of hours case data.<br />
== Demographics ==
{| class="wikitable"
 
=== PMI ===
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+
|+
FHIR Resource: EpisodeOfCare
'''FHIR Resource: Patient'''
!FieldName
|-
!FHIR Mapping
|PAS_ID
|patient.id
patient.identifier
|-
|FORENAME
|patient.givenName
|-
|SURNAME
|patient.familyName
|-
|NHS_NUMBER
|patient.identifier
|-
|GENDER_CODE
|patient.gender
|-
|BIRTH_DTTM
|patient.birthDate
|-
|DEATH_DTTM
|patient.deceasedDateTime
|-
|CAUSEOFDEATH
|patient.containedParameters  => IM.CAUSEOFDEATH
|-
|CAUSEOFDEATH_1B
|patient.containedParameters  => IM.CAUSEOFDEATH_1B
|-
|CAUSEOFDEATH_1C
|patient.containedParameters  => IM.CAUSEOFDEATH_1C
|-
|CAUSEOFDEATH_2
|patient.containedParameters  => IM.CAUSEOFDEATH_2
|-
|INFECTION_STATUS
|patient.containedParameters  => IM.INFECTION_STATUS
|-
|-
|PatientRef
|ADDRESS1
|Patient reference
|patient.address.line, use = HOME
|-
|-
|PriorityName
|ADDRESS2
|priority extension
|patient.address.line, use = HOME
|-
|-
|CaseRef
|ADDRESS3
|id
|patient.address.town,  use = HOME
|-
|-
|CaseNo
|ADDRESS4
|identifier
|patient.address.line,  use = HOME
|-
|-
|StartDateTime
|ADDRESS5
|period.start
|patient.address.line,  use = HOME
|-
|-
|EndDateTime
|POSTCODE
|period.end
|patient.address.postcode,  use = HOME
|-
|-
|LocationName
|SENSITIVE_PDS_FLAG
|n/a
|patient spine  sensitive extension (true/false)
|-
|-
|CaseTagName
|HPHONE_NUMBER
|identifier
|patient.contact.telecom,  use = HOME
|-
|-
|ArrivedPCC
|MPHONE_NUMBER
|arrival extension
|patient.contact.telecom, use = MOBILE
|-
|-
|UserRef
|ETHNICITY_CODE
|practitioner reference
|patient enthnicity extension
|-
|-
|ODSCode
|REGISTERED_GP_PRACTICE
|organisation reference
|patient.serviceProvider (reference -> Organization (GP) resource)
|}
|}


== Case Questions ==
=== Alerts ===
This file contains defined questions and answers linked to a case.  It is treated like a questionnaire associated with a case encounter.<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
{| class="wikitable"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+
|+
FHIR Resource: QuestionnaireResponse
'''FHIR Resource: Flag'''
!FieldName
|-
!FHIR Mapping
|EXTERNAL_ID
|flag.id
|-
|-
|CaseRef
|PAS_ID
|identifier also used to derive the linked Encounter reference from a pre- transform
|flag.patient  (reference -> Patient resource)
|-
|-
|QuestionSetName
|ALERT_TYPE_DESCRIPTION
|group.title
|flag.category
|-
|-
|Question
|APPLIED_DTTM
|group.question.text
|flag recorded  date extension
|-
|-
|Answer
|START_DTTM
|group.question.answer.value
|flag.period.start,  status = ACTIVE
|-
|ALERT_DESCRIPTION
|flag.code.text
|-
|ALERT_COMMENTS
|flag.code.text
|-
|CLOSED_DTTM
|flag.period.end,  status = INACTIVE
|}
|}


== Outcomes ==
== Activity ==
This files list the outcomes(s) of the case.<br />
 
{| class="wikitable"
=== A&E Attendances ===
|+FHIR Resource: EpisodeOfCare
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
!FieldName
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
!FHIR Mapping
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+
'''FHIR Resource: EpisodeOfCare'''
|-
|EXTERNAL_ID
|episodeofcare.id
|-
|-
|CaseRef
|PAS_ID
|id
|episodeofcare.patient (reference -> Patient resource)
|-
|-
|OutcomeName
|ARRIVAL_DTTM
|outcome extension
|episodeofcare.period.start,.status = ACTIVE
|-
|DISCHARGED_DTTM
|episodeofcare.period.end,.status = FINISHED
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+'''FHIR Resource: Encounter'''
|-
|EXTERNAL_ID
|encounter (Emergency).id
encounter (Emergency Arrival).id:01:EM
encounter (Emergency Assessment).id:02:EM
encounter (Emergency Treatment).id:03:EM
encounter (Emergency Conclusion).id:04:EM
|-
|PAS_ID
|encounter  (Emergency).patient (reference -> Patient resource)
encounter (Emergency Arrival).patient (reference -> Patient  resource)
encounter (Emergency Assessment).patient (reference -> Patient  resource)
encounter (Emergency Treatment).patient (reference -> Patient  resource)
encounter (Emergency Conclusion).patient (reference -> Patient  resource)
|-
|HOSPITAL_CODE
|encounter  (Emergency).serviceProvider (reference -> Organization resource)
encounter (Emergency Arrival).serviceProvider (reference -> Organization  resource)
encounter (Emergency Assessment).serviceProvider (reference ->  Organization resource)
encounter (Emergency Treatment).serviceProvider (reference ->  Organization resource)
encounter (Emergency Conclusion).serviceProvider (reference ->  Organization resource)
|-
|ATTENDANCE_TYPE
|encounter  (Emergency Arrival).containedParameters => IM.ATTENDANCE_TYPE
|-
|ARRIVAL_MODE
|encounter  (Emergency Arrival).containedParameters => IM.ARRIVAL_MODE
|-
|REFERRAL_SOURCE
|encounter  (Emergency Arrival).containedParameters => IM.REFERRAL_SOURCE
|-
|ARRIVAL_DTTM
|encounter  (Emergency).period.start, status = INPROGRESS
encounter (Emergency Arrival).period.start, status = INPROGRESS
|-
|TRIAGE_DTTM
|encounter  (Emergency Arrival).period.end, status = FINISHED
encounter (Emergency Assessment).period.start, status = INPROGRESS
|-
|SEEN_BY_AE_DOCTOR_DTTM
|encounter  (Emergency Assessment).period.end, status = FINISHED
encounter (Emergency Treatment).period.start, status = INPROGRESS
|-
|COMPLAINT
|encounter  (Emergency).codeableConcept.code.text
|-
|DISCHARGED_DTTM
|encounter  (Emergency).period.end, status = FINISHED
encounter (Emergency Treatment).period.end, status = FINISHED
encounter (Emergency Conclusion).period.start, status = INPROGRESS
episodeofcare.period.end,.status = FINISHED
|-
|LEFT_DEPARTMENT_DTTM
|encounter  (Emergency Conclusion).period.end, status = FINISHED
|-
|DISCHARGE_DESTINATION
|encounter  (Emergency Conclusion).containedParameters => IM.DISCHARGE_DESTINATION
|-
|RECORDED_OUTCOME
|encounter  (Emergency).hospitalization.dischargeDisposition
encounter (Emergency Conclusion).containedParameters => IM.RECORDED_OUTCOME
|}
|}


== Notes ==
=== Spells ===
This file lists all patient notes linked to a case.
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
{| class="wikitable"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|+FHIR Resource: Flag
! scope="col" width="30%" |FieldName
!FieldName
! scope="col" width="70%" |FHIR Mapping
!FHIR Mapping
|-
|-
|CaseRef
|+'''FHIR Resource: Encounter'''
|id  together with patientId and ReviewDateTime
|-
|-
|PatientRef
|EXTERNAL_ID
|subject  patient reference
|encounter (Inpatient).id
|-
|-
|ReviewDateTime
|PAS_ID
|period.start
|encounter (Inpatient).patient (reference -> Patient resource)
 
encounter (Inpatient Admission).patient (reference -> Patient resource)
 
encounter (Inpatient Discharge).patient (reference -> Patient resource)
|-
|-
|NoteText
|ADMISSION_DTTM
|code  as text only
|encounter (Inpatient).period.start, status = INPROGRESS
 
encounter (Inpatient Admission).period.start, status = INPROGRESS
|-
|-
|Obsolete
|ADMISSION_CONSULTANT_CODE
|n/a - ignored where equals true
|encounter (Inpatient).participant (reference -> Practitioner resource)
 
encounter (Inpatient Admission).participant (reference -> Practitioner resource)
|-
|-
|Active
|ADMISSION_HOSPITAL_CODE
|status
|encounter (Inpatient).serviceProvider (reference -> Organization resource)
 
encounter (Inpatient Admission).serviceProvider (reference -> Organization resource)
 
encounter (Inpatient Discharge).serviceProvider (reference -> Organization resource)
|-
|-
|UserRef
|ADMISSION_METHOD_CODE
|author reference
|encounter (Inpatient Admission).containedParameters => IM.ADMISSION_METHOD_CODE
|}
|-
|ADMISSION_SOURCE_CODE
|encounter (Inpatient  Admission).containedParameters => IM.ADMISSION_SOURCE_CODE
|-
|ADMISSION_WARD_CODE
|encounter (Inpatient  Admission).containedParameters => JSON_ADMISSION_WARD_CODE
|-
|PATIENT_CLASS_CODE
|encounter (Inpatient  Admission).containedParameters => IM.PATIENT_CLASS
|-
|DISCHARGE_DTTM
|encounter (Inpatient).period.end, status = FINISHED


== Patient ==
NOTE: encounter (Inpatient Admission).period.end, status = FINISHED when linked Inpatient Episode encounter starts (See EPISODES)
Details all the patients seen as part of the OOH service linked to a case.
|-
{| class="wikitable"
|DISCHARGE_METHOD_CODE
|+FHIR Resource: Patient
|encounter (Inpatient  Discharge).containedParameters => IM.DISCHARGE_METHOD_CODE
!FieldName
|-
!FHIR Mapping
|DISCHARGE_DESTINATION_CODE
|encounter  (Inpatient Discharge).containedParameters => IM.DISCHARGE_DEST_CODE
|-
|DISCHARGE_CONSULTANT_CODE
|encounter  (Inpatient Discharge).participant (reference -> Practitioner resource)
|-
|DISCHARGE_WARD_CODE
|encounter (Inpatient  Discharge).containedParameters => JSON_DISCHARGE_WARD_CODE
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+'''FHIR Resource: EpisodeOfCare'''
|-
|EXTERNAL_ID
|episodeofcare.id
|-
|PAS_ID
|episodeofcare.patient (reference -> Patient resource)
|-
|-
|PatientRef
|ADMISSION_DTTM
|id
|episodeofcare.period.start, status = ACTIVE
|-
|-
|Forename
|ADMISSION_CONSULTANT_CODE
|givenName
|episodeofcare.caremanager (reference -> Practitioner resource)
|-
|-
|Surname
|ADMISSION_HOSPITAL_CODE
|familyName
|episodeofcare.managingOrganization (reference -> Organization resource)
|-
|-
|DOB
|DISCHARGE_DTTM
|birthDate
|episodeofcare.period.start, status = FINISHED
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|-
|NHSNumber
|+'''FHIR Resource: Condition'''
|identifier
|-
|-
|NHSNoTraceStatus
|EXTERNAL_ID
|identifier
|condition.encounter (reference -> encounter(Inpatient) resource)
|-
|-
|Language
|PAS_ID
|communicationComponent.language CodableConcept
|condition.patient (reference -> Patient resource)
speaks English extension if language = English
|-
|-
|Ethnicity
|ADMISSION_DTTM
|enthnicity extension (only attempt match if field 27 blank)
|condition.onset
|-
|-
|Gender
|ADMISSION_CONSULTANT_CODE
|gender
|condition.clinician (reference -> Practitioner resource)
|-
|-
|RegistrationType
|PRIMARY_DIAGNOSIS
|episode of care registration type extension
|condition.codeableConcept.code.text
|-
|-
|HomeAddressBuilding
|PRIMARY_DIAGNOSIS_CODE
|address.line, use = HOME
|condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|-
|HomeAddressStreet
|+'''FHIR Resource: Procedure'''
|address.line, use = HOME
|-
|-
|HomeAddressTown
|EXTERNAL_ID
|address.town, use = HOME
|procedure.encounter (reference -> encounter(Inpatient) resource)
|-
|-
|HomeAddressLocality
|PAS_ID
|address.line, use = HOME
|procedure.patient (reference -> Patient resource)
|-
|-
|HomeAddressPostcode
|ADMISSION_DTTM
|address.postcode, use = HOME
|procedure.performed
|-
|-
|MobilePhone
|ADMISSION_CONSULTANT_CODE
|contactPoint, use = MOBILE
|procedure.performer (reference -> Practitioner resource)
|-
|-
|HomePhone
|PRIMARY_PROCEDURE
|contactPoint, use = HOME
|procedure.codeableConcept.code.text
|-
|-
|EthnicCode
|PRIMARY_PROCEDURE_CODE
|enthnicity extension
|procedure.codeableConcept.code,  procedure.codeableConcept.code.display (via lookup)
|}
|}


== Consultation ==
=== Episodes ===
This file details the patient consultations associated with a case.
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
{| class="wikitable"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|+FHIR Resource: Encounter
! scope="col" width="30%" |FieldName
!FieldName
! scope="col" width="70%" |FHIR Mapping
!FHIR Mapping
|-
|+'''FHIR Resource: Encounter'''
|-
|EXTERNAL_ID
|encounter (Inpatient Episode).id:epi_num:IP:Episode
|-
|IP_SPELL_EXTERNAL_ID
|encounter (Inpatient Episode).partOf (reference -> Encounter (Inpatient) resource)
 
encounter (Inpatient Episode).episodeOfCare (reference -> EpisodOfCare resource)
|-
|PAS_ID
|encounter (Inpatient Episode).patient (reference -> Patient resource)
|-
|EPI_NUM
|encounter (Inpatient Episode).id:epi_num:IP:Episode
|-
|EPISODE_CONSULTANT_CODE
|encounter (Inpatient Episode).participant (reference -> Practitioner resource)
|-
|EPISODE_START_WARD_CODE
|encounter  (Inpatient Episode).containedParameters => JSON_EPISODE_START_WARD_CODE
|-
|EPISODE_END_WARD_CODE
|encounter  (Inpatient Episode).containedParameters => JSON_EPISODE_END_WARD_CODE
|-
|EPISODE_START_DTTM
|encounter  (Inpatient Admission).period.end    (created during SPELLS)
encounter (Inpatient Episode).period.start
|-
|EPISODE_END_DTTM
|encounter  (Inpatient Episode).period.end
|-
|ADMINISTRATIVE_CATEGORY_CODE
|encounter  (Inpatient Admission).containedParameters =>  IM.ADMINISTRATIVE_CATEGORY_CODE
|-
|ADMISSION_METHOD_CODE
|encounter (Inpatient  Admission).containedParameters => IM.ADMISSION_METHOD_CODE
|-
|ADMISSION_SOURCE_CODE
|encounter (Inpatient  Admission).containedParameters => IM.ADMISSION_SOURCE_CODE
|-
|PATIENT_CLASS_CODE
|encounter (Inpatient  Admission).containedParameters => IM.PATIENT_CLASS
|-
|DISCHARGE_METHOD_CODE
|encounter (Inpatient  Discharge).containedParameters => IM.DISCHARGE_METHOD_CODE
|-
|DISCHARGE_DESTINATION_CODE
|encounter  (Inpatient Discharge).containedParameters => IM.DISCHARGE_DEST_CODE
|-
|ADMISSION_HOSPITAL_CODE
|encounter  (Inpatient Episode).serviceProvider (reference -> Organization resource)
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+'''FHIR Resource: Condition'''
|-
|EXTERNAL_ID
|condition.encounter (reference -> encounter(Inpatient Episode) resource)
|-
|PAS_ID
|condition.patient (reference -> Patient resource)
|-
|-
|CaseRef
|EPISODE_CONSULTANT_CODE
|EpisodeOfCare  reference
|condition.clinician (reference -> Practitioner resource)
Used to derive Patient reference
|-
|-
|ConsultationRef
|PRIMARY_DIAGNOSIS_CODE
|id
|condition.codeableConcept.code,  condition.codeableConcept.code.display (via lookup)
condition.isprimary = true
|-
|-
|StartDateTime
|PRIMDIAG_DTTM
|period.start
|condition.onset
|-
|-
|EndDateTime
|DIAG_01 - DIAG_12
|period.end
|condition.codeableConcept.code,  condition.codeableConcept.code.display (via lookup)
condition.isprimary = false
|-
|-
|CaseType
|DIAG1_DTTM - DIAG12_DTTM
|CodableConcept encounter_source
|condition.onset
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left; vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|-
|History
|+'''FHIR Resource: Procedure'''
|Observation.comments  linked to Encounter
|-
|-
|Examination
|EXTERNAL_ID
|Observation.comments  linked to Encounter
|procedure.encounter (reference -> encounter(Inpatient Episode) resource)
|-
|-
|Diagnosis
|PAS_ID
|Observation.comments  linked to Encounter
|procedure.patient (reference -> Patient resource)
|-
|-
|TreatmentPlan
|EPISODE_CONSULTANT_CODE
|Observation.comments  linked to Encounter
|procedure.performer (reference -> Practitioner resource)
|-
|-
|PatientName
|PRIMARY_PROCEDURE_CODE
|n/a - Patient reference used
|procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)
procedure.isprimary = true
|-
|-
|PatientForename
|PRIMARY_PROCEDURE_DATE
|n/a -  Patient reference used
|procedure.performed
|-
|-
|PatientSurname
|PRIMARY_PROCEDURE
|n/a -  Patient reference used
|procedure.codeableConcept.code.text
|-
|-
|UserRef
|PROC_01 - PROC_12
|Participant Primary Performer reference
|procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)
procedure.isprimary = false
|-
|PROC_01_DESC - PROC_12_DESC
|procedure.codeableConcept.code.text
|}
|}


== Prescriptions ==
=== Outpatients ===
Details the drug items given during the Consultation which links back to a case. 
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+'''FHIR Resource: Encounter'''
|-
|EXTERNAL_ID
|encounter (Outpatient).id


{{Note|These will be Snomed DM&D coded as part of phase 2.}}
encounter (Outpatient).setAppointment (reference -> appointment resource)
{| class="wikitable"
|+FHIR Resource: MedicationStatement
!FieldName
!FHIR Mapping
|-
|-
|CaseRef
|PAS_ID
|id = CaseRef + ConsulationRef + PatientId
|encounter.patient (reference -> Patient resource)
Used to  derive Patient reference
|-
|-
|ConsultationRef
|ADMIN_CATEGORY_CODE
|Used to derive effectiveDate, i.e. same as consultation date and  practitioner from
|encounter (Outpatient).containedParameters => IM.ADMIN_CATEGORY_CODE
Consultation UserRef
Encounter reference
|-
|-
|DrugName
|APPOINTMENT_STATUS_CODE
|CodableConcept.code.text
|encounter (Outpatient).containedParameters => IM.APPOINTMENT_STATUS_CODE
|-
|-
|Preparation
|APPOINTMENT_DTTM
|units extension
|encounter (Outpatient).period.start (if APPT_SEEN_DTM blank)
|-
|-
|Dosage
|APPT_SEEN_DTTM
|dosage
|encounter (Outpatient).period.start
|-
|-
|Quantity
|APPT_DEPARTURE_DTTM
|quanity extension
|encounter (Outpatient).period.end
|-
|-
|DMDCode
|HOSPITAL_CODE
|CodableConcept.code
|encounter (Outpatient).serviceProvider (reference -> Organization resource)
|-
|-
|Issue
|CONSULTANT_CODE
|if (not N) then creates linked MedicationOrder resource
|encounter (Outpatient).participant (reference -> Practitioner resource)
|}
|}<br />
<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
 
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
== Clinical codes ==
! scope="col" width="30%" |FieldName
Details all the clinical codes added during a Consultation which links back to a case.<br />
! scope="col" width="70%" |FHIR Mapping
{| class="wikitable"
|-
|+FHIR Resource: Observation
|+'''FHIR Resource: EpisodeOfCare'''
!FieldName
|-
!FHIR Mapping
|EXTERNAL_ID
|episodeofcare.id
|-
|PAS_ID
|episodeofcare.patient (reference -> Patient resource)
|-
|APPOINTMENT_PRIORITY
|episodeofcare.priority  extension
|-
|APPOINTMENT_DTTM
|episodeofcare.period.start (if APPT_SEEN_DTM blank)
|-
|APPT_SEEN_DTTM
|episodeofcare.period.start
|-
|APPT_DEPARTURE_DTTM
|episodeofcare.period.end
|-
|HOSPITAL_CODE
|episodeofcare.managingOrganization (reference -> Organization resource)
|-
|CONSULTANT_CODE
|episodeofcare.careManager (reference -> Practitioner resource)
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"  
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|+'''FHIR Resource: Appointment'''
|-
|EXTERNAL_ID
|appointment.id:Appointment
|-
|PAS_ID
|appointment.participant (reference -> Patient resource)
|-
|APPT_TYPE
|appointment.type.text
|-
|APPOINTMENT_OUTCOME
|appointment.comments
|-
|APPOINTMENT_STATUS
|appointment.status
|-
|APPOINTMENT_DTTM
|appointment.start
|-
|APPT_ARRIVAL_DTTM
|appointment.minutesDuration
|-
|APPT_CALL_DTTM
|appointment.minutesDuration
|-
|APPT_SEEN_DTTM
|appointment.end
|-
|BOOKED_DTTM
|appointment  booking date extension
|-
|CANCEL_DTTM
|appointment cancellation date extension
|-
|CONSULTANT_CODE
|appointment.participant (reference -> Practitioner resource)
|}<br />
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="30%" |FieldName
! scope="col" width="70%" |FHIR Mapping
|-
|-
|CaseRef
|+'''FHIR Resource: Condition'''
|id = CaseRef + ConsulationRef + ClinicalCode
Used to  derive Patient reference
|-
|-
|ConsultationRef
|EXTERNAL_ID
|Used to derive effectiveDate, i.e. same as consultation date and  the UserRef of the consultation for the Observation clinician
|condition.encounter (reference -> encounter(Outpatient) resource)
Encounter reference
|-
|-
|ClinicalCode
|PAS_ID
|CodableConcept.code  as Read2.  Also mapped to Snomed.
|condition.patient (reference -> Patient resource)
|-
|-
|Term
|PRIMARY_DIAGNOSIS_CODE
|CodableConcept.code.text as Read2.  Also mapped to Snomed.
|condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)
|}
condition.isprimary = true
 
== Provider ==
Details the patient GP practice and locations.
{| class="wikitable"
|+FHIR Resource: Organization.
Linked to the Patient resource Care Provider
!FieldName
!FHIR Mapping
|-
|-
|GPPracticeNatCode
|SECONDARY_DIAGNOSIS_CODE_1
|Organization.identifier.value
|condition.codeableConcept.code,  condition.codeableConcept.code.display (via lookup)
condition.isprimary = false
|-
|-
|GPPracitceName
|SECONDARY_DIAGNOSIS_CODE_2
|Organization.name
|condition.codeableConcept.code,  condition.codeableConcept.code.display (via lookup)
condition.isprimary = false
|-
|-
|GPPracticePostcode
|SECONDARY_DIAGNOSIS_CODE_3
|Organization.address.postcode
|condition.codeableConcept.code,  condition.codeableConcept.code.display (via lookup)
|}
condition.isprimary = false
 
|}<br />
== Users ==
{| border="1" style="border-collapse:collapse; text-align: left;  vertical-align:top; width:60%;"
Details the clinical users/practitioners, linking into all UserRef references in other resources.
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
{| class="wikitable"
! scope="col" width="30%" |FieldName
|+FHIR Resource: Practitioner
! scope="col" width="70%" |FHIR Mapping
!FieldName
!FHIR Mapping
|-
|-
|UserRef
|+'''FHIR Resource: Procedure'''
|id
|-
|-
|Forename
|EXTERNAL_ID
|HumanName.given
|procedure.encounter (reference -> encounter(Outpatient) resource)
|-
|-
|Surname
|PAS_ID
|HumanName.family
|procedure.patient (reference -> Patient resource)
|-
|-
|FullName
|PRIMARY_PROCEDURE_CODE
|HumanName.text
|procedure.codeableConcept.code,procedure.codeableConcept.code.display  (via lookup)
procedure.isprimary = true
|-
|-
|ProviderGMC
|SECONDARY_PROCEDURE_CODE_1
|if a  GP, create an <nowiki>http://endeavourhealth.org/fhir/Identifier/gmc-number</nowiki> identifier
|procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)
procedure.isprimary = false
|-
|-
|ProviderNMC
|SECONDARY_PROCEDURE_CODE_2 - 11
|if a  Nurse, create an <nowiki>http://endeavourhealth.org/fhir/Identifier/nmc-number</nowiki> identifier
|procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)
procedure.isprimary = false
|}
|}

Latest revision as of 15:50, 22 March 2021


Demographics

PMI

FieldName FHIR Mapping
FHIR Resource: Patient
PAS_ID patient.id

patient.identifier

FORENAME patient.givenName
SURNAME patient.familyName
NHS_NUMBER patient.identifier
GENDER_CODE patient.gender
BIRTH_DTTM patient.birthDate
DEATH_DTTM patient.deceasedDateTime
CAUSEOFDEATH patient.containedParameters => IM.CAUSEOFDEATH
CAUSEOFDEATH_1B patient.containedParameters => IM.CAUSEOFDEATH_1B
CAUSEOFDEATH_1C patient.containedParameters => IM.CAUSEOFDEATH_1C
CAUSEOFDEATH_2 patient.containedParameters => IM.CAUSEOFDEATH_2
INFECTION_STATUS patient.containedParameters => IM.INFECTION_STATUS
ADDRESS1 patient.address.line, use = HOME
ADDRESS2 patient.address.line, use = HOME
ADDRESS3 patient.address.town, use = HOME
ADDRESS4 patient.address.line, use = HOME
ADDRESS5 patient.address.line, use = HOME
POSTCODE patient.address.postcode, use = HOME
SENSITIVE_PDS_FLAG patient spine sensitive extension (true/false)
HPHONE_NUMBER patient.contact.telecom, use = HOME
MPHONE_NUMBER patient.contact.telecom, use = MOBILE
ETHNICITY_CODE patient enthnicity extension
REGISTERED_GP_PRACTICE patient.serviceProvider (reference -> Organization (GP) resource)

Alerts

FieldName FHIR Mapping
FHIR Resource: Flag
EXTERNAL_ID flag.id
PAS_ID flag.patient (reference -> Patient resource)
ALERT_TYPE_DESCRIPTION flag.category
APPLIED_DTTM flag recorded date extension
START_DTTM flag.period.start, status = ACTIVE
ALERT_DESCRIPTION flag.code.text
ALERT_COMMENTS flag.code.text
CLOSED_DTTM flag.period.end, status = INACTIVE

Activity

A&E Attendances

FieldName FHIR Mapping
FHIR Resource: EpisodeOfCare
EXTERNAL_ID episodeofcare.id
PAS_ID episodeofcare.patient (reference -> Patient resource)
ARRIVAL_DTTM episodeofcare.period.start,.status = ACTIVE
DISCHARGED_DTTM episodeofcare.period.end,.status = FINISHED


FieldName FHIR Mapping
FHIR Resource: Encounter
EXTERNAL_ID encounter (Emergency).id

encounter (Emergency Arrival).id:01:EM encounter (Emergency Assessment).id:02:EM encounter (Emergency Treatment).id:03:EM encounter (Emergency Conclusion).id:04:EM

PAS_ID encounter (Emergency).patient (reference -> Patient resource)

encounter (Emergency Arrival).patient (reference -> Patient resource) encounter (Emergency Assessment).patient (reference -> Patient resource) encounter (Emergency Treatment).patient (reference -> Patient resource) encounter (Emergency Conclusion).patient (reference -> Patient resource)

HOSPITAL_CODE encounter (Emergency).serviceProvider (reference -> Organization resource)

encounter (Emergency Arrival).serviceProvider (reference -> Organization resource) encounter (Emergency Assessment).serviceProvider (reference -> Organization resource) encounter (Emergency Treatment).serviceProvider (reference -> Organization resource) encounter (Emergency Conclusion).serviceProvider (reference -> Organization resource)

ATTENDANCE_TYPE encounter (Emergency Arrival).containedParameters => IM.ATTENDANCE_TYPE
ARRIVAL_MODE encounter (Emergency Arrival).containedParameters => IM.ARRIVAL_MODE
REFERRAL_SOURCE encounter (Emergency Arrival).containedParameters => IM.REFERRAL_SOURCE
ARRIVAL_DTTM encounter (Emergency).period.start, status = INPROGRESS

encounter (Emergency Arrival).period.start, status = INPROGRESS

TRIAGE_DTTM encounter (Emergency Arrival).period.end, status = FINISHED

encounter (Emergency Assessment).period.start, status = INPROGRESS

SEEN_BY_AE_DOCTOR_DTTM encounter (Emergency Assessment).period.end, status = FINISHED

encounter (Emergency Treatment).period.start, status = INPROGRESS

COMPLAINT encounter (Emergency).codeableConcept.code.text
DISCHARGED_DTTM encounter (Emergency).period.end, status = FINISHED

encounter (Emergency Treatment).period.end, status = FINISHED encounter (Emergency Conclusion).period.start, status = INPROGRESS episodeofcare.period.end,.status = FINISHED

LEFT_DEPARTMENT_DTTM encounter (Emergency Conclusion).period.end, status = FINISHED
DISCHARGE_DESTINATION encounter (Emergency Conclusion).containedParameters => IM.DISCHARGE_DESTINATION
RECORDED_OUTCOME encounter (Emergency).hospitalization.dischargeDisposition

encounter (Emergency Conclusion).containedParameters => IM.RECORDED_OUTCOME

Spells

FieldName FHIR Mapping
FHIR Resource: Encounter
EXTERNAL_ID encounter (Inpatient).id
PAS_ID encounter (Inpatient).patient (reference -> Patient resource)

encounter (Inpatient Admission).patient (reference -> Patient resource)

encounter (Inpatient Discharge).patient (reference -> Patient resource)

ADMISSION_DTTM encounter (Inpatient).period.start, status = INPROGRESS

encounter (Inpatient Admission).period.start, status = INPROGRESS

ADMISSION_CONSULTANT_CODE encounter (Inpatient).participant (reference -> Practitioner resource)

encounter (Inpatient Admission).participant (reference -> Practitioner resource)

ADMISSION_HOSPITAL_CODE encounter (Inpatient).serviceProvider (reference -> Organization resource)

encounter (Inpatient Admission).serviceProvider (reference -> Organization resource)

encounter (Inpatient Discharge).serviceProvider (reference -> Organization resource)

ADMISSION_METHOD_CODE encounter (Inpatient Admission).containedParameters => IM.ADMISSION_METHOD_CODE
ADMISSION_SOURCE_CODE encounter (Inpatient Admission).containedParameters => IM.ADMISSION_SOURCE_CODE
ADMISSION_WARD_CODE encounter (Inpatient Admission).containedParameters => JSON_ADMISSION_WARD_CODE
PATIENT_CLASS_CODE encounter (Inpatient Admission).containedParameters => IM.PATIENT_CLASS
DISCHARGE_DTTM encounter (Inpatient).period.end, status = FINISHED

NOTE: encounter (Inpatient Admission).period.end, status = FINISHED when linked Inpatient Episode encounter starts (See EPISODES)

DISCHARGE_METHOD_CODE encounter (Inpatient Discharge).containedParameters => IM.DISCHARGE_METHOD_CODE
DISCHARGE_DESTINATION_CODE encounter (Inpatient Discharge).containedParameters => IM.DISCHARGE_DEST_CODE
DISCHARGE_CONSULTANT_CODE encounter (Inpatient Discharge).participant (reference -> Practitioner resource)
DISCHARGE_WARD_CODE encounter (Inpatient Discharge).containedParameters => JSON_DISCHARGE_WARD_CODE


FieldName FHIR Mapping
FHIR Resource: EpisodeOfCare
EXTERNAL_ID episodeofcare.id
PAS_ID episodeofcare.patient (reference -> Patient resource)
ADMISSION_DTTM episodeofcare.period.start, status = ACTIVE
ADMISSION_CONSULTANT_CODE episodeofcare.caremanager (reference -> Practitioner resource)
ADMISSION_HOSPITAL_CODE episodeofcare.managingOrganization (reference -> Organization resource)
DISCHARGE_DTTM episodeofcare.period.start, status = FINISHED


FieldName FHIR Mapping
FHIR Resource: Condition
EXTERNAL_ID condition.encounter (reference -> encounter(Inpatient) resource)
PAS_ID condition.patient (reference -> Patient resource)
ADMISSION_DTTM condition.onset
ADMISSION_CONSULTANT_CODE condition.clinician (reference -> Practitioner resource)
PRIMARY_DIAGNOSIS condition.codeableConcept.code.text
PRIMARY_DIAGNOSIS_CODE condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)


FieldName FHIR Mapping
FHIR Resource: Procedure
EXTERNAL_ID procedure.encounter (reference -> encounter(Inpatient) resource)
PAS_ID procedure.patient (reference -> Patient resource)
ADMISSION_DTTM procedure.performed
ADMISSION_CONSULTANT_CODE procedure.performer (reference -> Practitioner resource)
PRIMARY_PROCEDURE procedure.codeableConcept.code.text
PRIMARY_PROCEDURE_CODE procedure.codeableConcept.code, procedure.codeableConcept.code.display (via lookup)

Episodes

FieldName FHIR Mapping
FHIR Resource: Encounter
EXTERNAL_ID encounter (Inpatient Episode).id:epi_num:IP:Episode
IP_SPELL_EXTERNAL_ID encounter (Inpatient Episode).partOf (reference -> Encounter (Inpatient) resource)

encounter (Inpatient Episode).episodeOfCare (reference -> EpisodOfCare resource)

PAS_ID encounter (Inpatient Episode).patient (reference -> Patient resource)
EPI_NUM encounter (Inpatient Episode).id:epi_num:IP:Episode
EPISODE_CONSULTANT_CODE encounter (Inpatient Episode).participant (reference -> Practitioner resource)
EPISODE_START_WARD_CODE encounter (Inpatient Episode).containedParameters => JSON_EPISODE_START_WARD_CODE
EPISODE_END_WARD_CODE encounter (Inpatient Episode).containedParameters => JSON_EPISODE_END_WARD_CODE
EPISODE_START_DTTM encounter (Inpatient Admission).period.end   (created during SPELLS)

encounter (Inpatient Episode).period.start

EPISODE_END_DTTM encounter (Inpatient Episode).period.end
ADMINISTRATIVE_CATEGORY_CODE encounter (Inpatient Admission).containedParameters => IM.ADMINISTRATIVE_CATEGORY_CODE
ADMISSION_METHOD_CODE encounter (Inpatient Admission).containedParameters => IM.ADMISSION_METHOD_CODE
ADMISSION_SOURCE_CODE encounter (Inpatient Admission).containedParameters => IM.ADMISSION_SOURCE_CODE
PATIENT_CLASS_CODE encounter (Inpatient Admission).containedParameters => IM.PATIENT_CLASS
DISCHARGE_METHOD_CODE encounter (Inpatient Discharge).containedParameters => IM.DISCHARGE_METHOD_CODE
DISCHARGE_DESTINATION_CODE encounter (Inpatient Discharge).containedParameters => IM.DISCHARGE_DEST_CODE
ADMISSION_HOSPITAL_CODE encounter (Inpatient Episode).serviceProvider (reference -> Organization resource)


FieldName FHIR Mapping
FHIR Resource: Condition
EXTERNAL_ID condition.encounter (reference -> encounter(Inpatient Episode) resource)
PAS_ID condition.patient (reference -> Patient resource)
EPISODE_CONSULTANT_CODE condition.clinician (reference -> Practitioner resource)
PRIMARY_DIAGNOSIS_CODE condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = true

PRIMDIAG_DTTM condition.onset
DIAG_01 - DIAG_12 condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = false

DIAG1_DTTM - DIAG12_DTTM condition.onset


FieldName FHIR Mapping
FHIR Resource: Procedure
EXTERNAL_ID procedure.encounter (reference -> encounter(Inpatient Episode) resource)
PAS_ID procedure.patient (reference -> Patient resource)
EPISODE_CONSULTANT_CODE procedure.performer (reference -> Practitioner resource)
PRIMARY_PROCEDURE_CODE procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)

procedure.isprimary = true

PRIMARY_PROCEDURE_DATE procedure.performed
PRIMARY_PROCEDURE procedure.codeableConcept.code.text
PROC_01 - PROC_12 procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)

procedure.isprimary = false

PROC_01_DESC - PROC_12_DESC procedure.codeableConcept.code.text

Outpatients

FieldName FHIR Mapping
FHIR Resource: Encounter
EXTERNAL_ID encounter (Outpatient).id

encounter (Outpatient).setAppointment (reference -> appointment resource)

PAS_ID encounter.patient (reference -> Patient resource)
ADMIN_CATEGORY_CODE encounter (Outpatient).containedParameters => IM.ADMIN_CATEGORY_CODE
APPOINTMENT_STATUS_CODE encounter (Outpatient).containedParameters => IM.APPOINTMENT_STATUS_CODE
APPOINTMENT_DTTM encounter (Outpatient).period.start (if APPT_SEEN_DTM blank)
APPT_SEEN_DTTM encounter (Outpatient).period.start
APPT_DEPARTURE_DTTM encounter (Outpatient).period.end
HOSPITAL_CODE encounter (Outpatient).serviceProvider (reference -> Organization resource)
CONSULTANT_CODE encounter (Outpatient).participant (reference -> Practitioner resource)


FieldName FHIR Mapping
FHIR Resource: EpisodeOfCare
EXTERNAL_ID episodeofcare.id
PAS_ID episodeofcare.patient (reference -> Patient resource)
APPOINTMENT_PRIORITY episodeofcare.priority extension
APPOINTMENT_DTTM episodeofcare.period.start (if APPT_SEEN_DTM blank)
APPT_SEEN_DTTM episodeofcare.period.start
APPT_DEPARTURE_DTTM episodeofcare.period.end
HOSPITAL_CODE episodeofcare.managingOrganization (reference -> Organization resource)
CONSULTANT_CODE episodeofcare.careManager (reference -> Practitioner resource)


FieldName FHIR Mapping
FHIR Resource: Appointment
EXTERNAL_ID appointment.id:Appointment
PAS_ID appointment.participant (reference -> Patient resource)
APPT_TYPE appointment.type.text
APPOINTMENT_OUTCOME appointment.comments
APPOINTMENT_STATUS appointment.status
APPOINTMENT_DTTM appointment.start
APPT_ARRIVAL_DTTM appointment.minutesDuration
APPT_CALL_DTTM appointment.minutesDuration
APPT_SEEN_DTTM appointment.end
BOOKED_DTTM appointment booking date extension
CANCEL_DTTM appointment cancellation date extension
CONSULTANT_CODE appointment.participant (reference -> Practitioner resource)


FieldName FHIR Mapping
FHIR Resource: Condition
EXTERNAL_ID condition.encounter (reference -> encounter(Outpatient) resource)
PAS_ID condition.patient (reference -> Patient resource)
PRIMARY_DIAGNOSIS_CODE condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = true

SECONDARY_DIAGNOSIS_CODE_1 condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = false

SECONDARY_DIAGNOSIS_CODE_2 condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = false

SECONDARY_DIAGNOSIS_CODE_3 condition.codeableConcept.code, condition.codeableConcept.code.display (via lookup)

condition.isprimary = false


FieldName FHIR Mapping
FHIR Resource: Procedure
EXTERNAL_ID procedure.encounter (reference -> encounter(Outpatient) resource)
PAS_ID procedure.patient (reference -> Patient resource)
PRIMARY_PROCEDURE_CODE procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)

procedure.isprimary = true

SECONDARY_PROCEDURE_CODE_1 procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)

procedure.isprimary = false

SECONDARY_PROCEDURE_CODE_2 - 11 procedure.codeableConcept.code,procedure.codeableConcept.code.display (via lookup)

procedure.isprimary = false

Retrieved from ‘https://wiki.endeavourhealth.org/index.php?title=BHRUT_Medway_Extract_FHIR_Mapping&oldid=4140’
Last modified
This page was last modified on 22 March 2021, at 15:50.