Homerton ADT FHIR Mapping: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
To see the latest Compass V2 schema, please see [[Discovery Remote Subscriber Database Familiarisation#Data_Mapping]]
== Segment - PID - Patient Identification  ==
== Segment - PID - Patient Identification  ==
<br />
{| class="wikitable"
{| class="wikitable"
|+
|+
FHIR Resource:  
FHIR Resource: Patient
!Field#
!Field#
!FieldName
!FieldName
!FHIR Mapping
!FHIR Mapping
!Extension
|-
|-
|PID.2
|PID.2
|Patient ID
|Patient ID
|Patient.identifier
|Patient.identifier
|
|-
|-
|PID.3
|PID.3
|Patient Identifier List
|Patient Identifier List
|Patient.identifier
|Patient.identifier
|
|-
|-
|PID.4
|PID.4
|Alternate PatientIidentifier
|Alternate PatientIidentifier
|Patient.identifier
|Patient.identifier
|
|-
|-
|PID.5
|PID.5
|Patient Name
|Patient Name
|Patient.name
|Patient.name
|
|-
|-
|PID.7
|PID.7
|Date/Time Of Birth
|Date/Time Of Birth
|Patient.birthDate & Patient.extension
|Patient.birthDate & Patient.extension
|primarycare-contact-birth-time-extension
|-
|-
|PID.8
|PID.8
|Sex
|Sex
|Patient.gender
|Patient.gender
|
|-
|-
|PID.9
|PID.9
|Patient Alias
|Patient Alias
|Patient.name
|Patient.name
|
|-
|-
|PID.11
|PID.11
|Patient Address
|Patient Address
|Patient.address
|Patient.address
|
|-
|-
|PID.13
|PID.13
|Phone Number - Home
|Phone Number - Home
|Patient.telecom
|Patient.telecom
|
|-
|-
|PID.14
|PID.14
|Phone Number - Business
|Phone Number - Business
|Patient.telecom
|Patient.telecom
|
|-
|-
|PID.15
|PID.15
|Primary Language
|Primary Language
|Patient.communication.language
|Patient.communication.language
|
|-
|-
|PID.16
|PID.16
|Marital Status
|Marital Status
|Patient.maritalStatus
|Patient.maritalStatus
|
|-
|-
|PID.17
|PID.17
|Religion
|Religion
|Patient.extension
|Patient.extension
|primarycare-religion-category-extension
|-
|-
|PID.18
|PID.18
|Patient Account Number
|Patient Account Number
|Patient.identifier
|Patient.identifier
|
|-
|-
|PID.22
|PID.22
|Ethnic Group
|Ethnic Group
|Patient.extension
|Patient.extension
|primarycare-ethnic-category-extension
|-
|-
|PID.29
|PID.29
|Patient Death Date and Time
|Patient Death Date and Time
|Patient.deceased
|Patient.deceased
|
|-
|-
|PID.30
|PID.30
|Patient Death Indicator
|Patient Death Indicator
|Patient.deceased
|Patient.deceased
|
|}
|}


== Case Questions ==
== Segment - PD1 - Patient Additional Demographic ==
This file contains defined questions and answers linked to a case.  It is treated like a questionnaire associated with a case encounter.<br />
{| class="wikitable"
{| class="wikitable"
|+
|+
FHIR Resource: QuestionnaireResponse
FHIR Resource: Patient
!Field#
!FieldName
!FieldName
!FHIR Mapping
!FHIR Mapping
!Extension
|-
|-
|CaseRef
|PD1.3
|identifier also used to derive the linked Encounter reference from a pre- transform
|Patient primary  facility
|Patient.careProvider& Organization
|
|-
|-
|QuestionSetName
|PD1.4
|group.title
|Patient primary  care provider
|-
|Patient.careProvider& Practitioner
|Question
|
|group.question.text
|-
|Answer
|group.question.answer.value
|}
|}


== Outcomes ==
== Segment - NK1 - Next of Kin / Associated Parties ==
This files list the outcomes(s) of the case.<br />
{| class="wikitable"
{| class="wikitable"
|+FHIR Resource: EpisodeOfCare
|+FHIR Resource: Patient
!Field#
!FieldName
!FieldName
!FHIR Mapping
!FHIR Mapping
!Extension
|-
|-
|CaseRef
|NK1.2
|id
|Name
|Patient.contact.name
|
|-
|-
|OutcomeName
|NK1.3
|outcome  extension
|Relationship
|}
|Patient.contact.relationship
 
|
== Notes ==
This file lists all patient notes linked to a case.
{| class="wikitable"
|+FHIR Resource: Flag
!FieldName
!FHIR Mapping
|-
|-
|CaseRef
|NK1.4
|id  together with patientId and ReviewDateTime
|Address
|Patient.contact.address
|
|-
|-
|PatientRef
|NK1.5
|subject patient reference
|Phone number
|Patient.contact.telecom.value
|
|-
|-
|ReviewDateTime
|NK1.6
|period.start
|Business  phone number
|Patient.contact.telecom.value
|
|-
|-
|NoteText
|NK1.7
|code  as text only
|Contact  role
|Patient.contact.extension
|primarycare-contact-role-category-extension
|-
|-
|Obsolete
|NK1.20
|n/a - ignored where equals true
|Primary language
|-
|Patient.contact.extension
|Active
|primarycare-contact-main-language-category-extension
|status
|-
|UserRef
|author  reference
|}
|}


== Patient ==
== Segment - PV1 - Patient Visit ==
Details all the patients seen as part of the OOH service linked to a case.
{| class="wikitable"
{| class="wikitable"
|+FHIR Resource: Patient
|+FHIR Resource: Encounter
!Field#
!FieldName
!FieldName
!FHIR Mapping
!FHIR Mapping
!Extension
|-
|-
|PatientRef
|PV1.2
|id
|Patient class
|Encounter.class
|
|-
|-
|Forename
|PV1.4
|givenName
|Admission type
|Encounter.extension
|encounter-admission-type
|-
|-
|Surname
|PV1.6
|familyName
|Prior patient  location
|Encounter.location&  Location
|
|-
|-
|DOB
|PV1.7
|birthDate
|Attending  doctor
|Encounter.participant  & Practitioner
|
|-
|-
|NHSNumber
|PV1.8
|identifier
|Referring  doctor
|Encounter.participant  & Practitioner
|
|-
|-
|NHSNoTraceStatus
|PV1.9
|identifier
|Consulting  doctor
|Encounter.participant&  Practitioner
|
|-
|-
|Language
|PV1.10
|communicationComponent.language CodableConcept
|Hospital  service
speaks English extension if language = English
|Encounter.serviceProvider&  Organization
|
|-
|-
|Ethnicity
|PV1.14
|enthnicity extension (only attempt match if field 27 blank)
|Admit source
|Encounter.hospitalization.origin
|
|-
|-
|Gender
|PV1.17
|gender
|Admitting  doctor
|Encounter.participant  & Practitioner
|
|-
|-
|RegistrationType
|PV1.18
|episode of care registration type extension
|Patient  type
|Encounter.type
|
|-
|-
|HomeAddressBuilding
|PV1.19
|address.line, use = HOME
|Visit  number
|EpisodeOfCare.identifier
|
|-
|-
|HomeAddressStreet
|PV1.36
|address.line, use = HOME
|Discharge  disposition
|Encounter.hospitalization.dischargeDisposition
|
|-
|-
|HomeAddressTown
|PV1.37
|address.town, use = HOME
|Discharged  to location
|Encounter.hospitalization.destination
|
|-
|-
|HomeAddressLocality
|PV1.39
|address.line, use = HOME
|Servicing  facility
|Encounter.managingOrganization
|
|-
|-
|HomeAddressPostcode
|PV1.41
|address.postcode, use = HOME
|Account status
|Encounter.status
|
|-
|-
|MobilePhone
|PV1.44
|contactPoint, use = MOBILE
|Admit date/time
|Encounter.statusHistory.start
|
|-
|-
|HomePhone
|PV1.45
|contactPoint, use = HOME
|Discharge  date/time
|Encounter.statusHistory.end
|
|-
|-
|EthnicCode
|PV1.50
|enthnicity extension
|Alternate visit  ID
|Encounter.identifier
|
|-
|PV1.52
|Other  healthcare provider
|Encounter.participant&  Practitioner
|
|}
|}


== Consultation ==
== Segment - PV2 - Patient Visit - Additional Information ==
This file details the patient consultations associated with a case.
{| class="wikitable"
{| class="wikitable"
|+FHIR Resource: Encounter
|+FHIR Resource: Encounter
!Field#
!FieldName
!FieldName
!FHIR Mapping
!FHIR Mapping
!Extension
|-
|-
|CaseRef
|PV2.3
|EpisodeOfCare  reference
|Admit reason
Used to derive Patient reference
|Encounter.reason
|
|-
|-
|ConsultationRef
|PV2.4
|id
|Transfer  reason
|Encounter.reason
|
|-
|-
|StartDateTime
|PV2.8
|period.start
|Expected admit  date/time
|Encounter.statusHistory.start
|
|}
 
== Segment - EVN - Event Type ==
{| class="wikitable"
!Field#
!FieldName
!FHIR Mapping
!Extension
|-
|-
|EndDateTime
|EVN.2
|period.end
|Recorded  date/time
|Encounter.extension
|primarycare-recorded-date-extension
|-
|-
|CaseType
|EVN.5
|CodableConcept encounter_source
|Operator ID
|MessageHeader.enterer & Practitioner.identifier & Practitioner.name
|
|}
 
== Segment - MSH - Message Header ==
{| class="wikitable"
|+FHIR Resource:
!Field#
!FieldName
!FHIR Mapping
!Extension
|-
|-
|History
|MSH.3
|Observation.comments  linked to Encounter
|Sending application
|MessageHeader.source.software
|
|-
|-
|Examination
|MSH.4
|Observation.comments  linked to Encounter
|Sending facility
|MessageHeader.source.name
|
|-
|-
|Diagnosis
|MSH.5
|Observation.comments  linked to Encounter
|Receiving application
|MessageHeader.destination.extension
|message-header-destination-software-extension
|-
|-
|TreatmentPlan
|MSH.6
|Observation.comments linked to Encounter
|Receiving facility
|MessageHeader.destination.name & MessageHeader.responsible
|
|-
|-
|PatientName
|MSH.7
|n/a -  Patient reference used
|Message date/time
|MessageHeader.timestamp
|
|-
|-
|PatientForename
|MSH.9
|n/a -  Patient reference used
|Message type
|MessageHeader.event.code
|
|-
|-
|PatientSurname
|MSH.10
|n/a - Patient reference used
|Message control id
|MessageHeader.extension
|message-header-message-control-id-extension
|-
|-
|UserRef
|MSH.12
|Participant  Primary Performer reference
|Version ID
|MessageHeader.event.version
|
|-
|MSH.13
|Sequence number
|MessageHeader.extension
|message-header-sequence-number-extension
|}
|}


== Prescriptions ==
== Message Types ==
Details the drug items given during the Consultation which links back to a case. 
 
{{Note|These will be Snomed DM&D coded as part of phase 2.}}
{| class="wikitable"
{| class="wikitable"
|+FHIR Resource: MedicationStatement
!Message Type
!FieldName
!Message Name
!FHIR Mapping
|-
|-
|CaseRef
|ADT^A01
|id = CaseRef + ConsulationRef + PatientId
|Admit / visit notification
Used to  derive Patient reference
|-
|-
|ConsultationRef
|ADT^A02
|Used to derive effectiveDate, i.e. same as consultation date and  practitioner from
|Transfer a patient
Consultation UserRef
Encounter reference
|-
|-
|DrugName
|ADT^A03
|CodableConcept.code.text
|Discharge/end visit
|-
|-
|Preparation
|ADT^A04
|units extension
|Register a patient
|-
|-
|Dosage
|ADT^A05
|dosage
|Pre-admit a patient
|-
|-
|Quantity
|ADT^A06
|quanity extension
|Change an outpatient to an inpatient
|-
|-
|DMDCode
|ADT^A07
|CodableConcept.code
|Change an inpatient to an outpatient
|-
|Issue
|if (not N) then creates linked MedicationOrder resource
|}
<br />
 
== Clinical codes ==
Details all the clinical codes added during a Consultation which links back to a case.<br />
{| class="wikitable"
|+FHIR Resource: Observation
!FieldName
!FHIR Mapping
|-
|-
|CaseRef
|ADT^A08
|id = CaseRef + ConsulationRef + ClinicalCode
|Update patient information
Used to  derive Patient reference
|-
|-
|ConsultationRef
|ADT^A11
|Used to derive effectiveDate, i.e. same as consultation date and  the UserRef of the consultation for the Observation clinician
|Cancel admit/visit notification
Encounter reference
|-
|-
|ClinicalCode
|ADT^A12
|CodableConcept.code  as Read2.  Also mapped to Snomed.
|Cancel transfer
|-
|-
|Term
|ADT^A13
|CodableConcept.code.text  as Read2.  Also mapped to Snomed.
|Cancel discharge/end visit
|}
 
== Provider ==
Details the patient GP practice and locations.
{| class="wikitable"
|+FHIR Resource: Organization.
Linked to the Patient resource Care Provider
!FieldName
!FHIR Mapping
|-
|-
|GPPracticeNatCode
|ADT^A14
|Organization.identifier.value
|Pending admit
|-
|-
|GPPracitceName
|ADT^A17
|Organization.name
|Swap patients
|-
|-
|GPPracticePostcode
|ADT^A23
|Organization.address.postcode
|Delete a patient record
|}
 
== Users ==
Details the clinical users/practitioners, linking into all UserRef references in other resources.
{| class="wikitable"
|+FHIR Resource: Practitioner
!FieldName
!FHIR Mapping
|-
|-
|UserRef
|ADT^A27
|id
|Cancel pending admit
|-
|-
|Forename
|ADT^A28
|HumanName.given
|Add person information
|-
|-
|Surname
|ADT^A31
|HumanName.family
|Update person information
|-
|-
|FullName
|ADT^A34
|HumanName.text
|Merge patient information - patient ID only
|-
|-
|ProviderGMC
|ADT^A35
|if a  GP, create an <nowiki>http://endeavourhealth.org/fhir/Identifier/gmc-number</nowiki>  identifier
|Merge patient information - account number only
|-
|-
|ProviderNMC
|ADT^A44
|if a  Nurse, create an <nowiki>http://endeavourhealth.org/fhir/Identifier/nmc-number</nowiki>  identifier
|Move account information - patient account number
|}
|}
<br />

Latest revision as of 11:00, 3 August 2023

To see the latest Compass V2 schema, please see Discovery Remote Subscriber Database Familiarisation#Data_Mapping

Segment - PID - Patient Identification

FHIR Resource: Patient
Field# FieldName FHIR Mapping Extension
PID.2 Patient ID Patient.identifier
PID.3 Patient Identifier List Patient.identifier
PID.4 Alternate PatientIidentifier Patient.identifier
PID.5 Patient Name Patient.name
PID.7 Date/Time Of Birth Patient.birthDate & Patient.extension primarycare-contact-birth-time-extension
PID.8 Sex Patient.gender
PID.9 Patient Alias Patient.name
PID.11 Patient Address Patient.address
PID.13 Phone Number - Home Patient.telecom
PID.14 Phone Number - Business Patient.telecom
PID.15 Primary Language Patient.communication.language
PID.16 Marital Status Patient.maritalStatus
PID.17 Religion Patient.extension primarycare-religion-category-extension
PID.18 Patient Account Number Patient.identifier
PID.22 Ethnic Group Patient.extension primarycare-ethnic-category-extension
PID.29 Patient Death Date and Time Patient.deceased
PID.30 Patient Death Indicator Patient.deceased

Segment - PD1 - Patient Additional Demographic

FHIR Resource: Patient
Field# FieldName FHIR Mapping Extension
PD1.3 Patient primary facility Patient.careProvider& Organization
PD1.4 Patient primary care provider Patient.careProvider& Practitioner

Segment - NK1 - Next of Kin / Associated Parties

FHIR Resource: Patient
Field# FieldName FHIR Mapping Extension
NK1.2 Name Patient.contact.name
NK1.3 Relationship Patient.contact.relationship
NK1.4 Address Patient.contact.address
NK1.5 Phone number Patient.contact.telecom.value
NK1.6 Business phone number Patient.contact.telecom.value
NK1.7 Contact role Patient.contact.extension primarycare-contact-role-category-extension
NK1.20 Primary language Patient.contact.extension primarycare-contact-main-language-category-extension

Segment - PV1 - Patient Visit

FHIR Resource: Encounter
Field# FieldName FHIR Mapping Extension
PV1.2 Patient class Encounter.class
PV1.4 Admission type Encounter.extension encounter-admission-type
PV1.6 Prior patient location Encounter.location& Location
PV1.7 Attending doctor Encounter.participant & Practitioner
PV1.8 Referring doctor Encounter.participant & Practitioner
PV1.9 Consulting doctor Encounter.participant& Practitioner
PV1.10 Hospital service Encounter.serviceProvider& Organization
PV1.14 Admit source Encounter.hospitalization.origin
PV1.17 Admitting doctor Encounter.participant & Practitioner
PV1.18 Patient type Encounter.type
PV1.19 Visit number EpisodeOfCare.identifier
PV1.36 Discharge disposition Encounter.hospitalization.dischargeDisposition
PV1.37 Discharged to location Encounter.hospitalization.destination
PV1.39 Servicing facility Encounter.managingOrganization
PV1.41 Account status Encounter.status
PV1.44 Admit date/time Encounter.statusHistory.start
PV1.45 Discharge date/time Encounter.statusHistory.end
PV1.50 Alternate visit ID Encounter.identifier
PV1.52 Other healthcare provider Encounter.participant& Practitioner

Segment - PV2 - Patient Visit - Additional Information

FHIR Resource: Encounter
Field# FieldName FHIR Mapping Extension
PV2.3 Admit reason Encounter.reason
PV2.4 Transfer reason Encounter.reason
PV2.8 Expected admit date/time Encounter.statusHistory.start

Segment - EVN - Event Type

Field# FieldName FHIR Mapping Extension
EVN.2 Recorded date/time Encounter.extension primarycare-recorded-date-extension
EVN.5 Operator ID MessageHeader.enterer & Practitioner.identifier & Practitioner.name

Segment - MSH - Message Header

FHIR Resource:
Field# FieldName FHIR Mapping Extension
MSH.3 Sending application MessageHeader.source.software
MSH.4 Sending facility MessageHeader.source.name
MSH.5 Receiving application MessageHeader.destination.extension message-header-destination-software-extension
MSH.6 Receiving facility MessageHeader.destination.name & MessageHeader.responsible
MSH.7 Message date/time MessageHeader.timestamp
MSH.9 Message type MessageHeader.event.code
MSH.10 Message control id MessageHeader.extension message-header-message-control-id-extension
MSH.12 Version ID MessageHeader.event.version
MSH.13 Sequence number MessageHeader.extension message-header-sequence-number-extension

Message Types

Message Type Message Name
ADT^A01 Admit / visit notification
ADT^A02 Transfer a patient
ADT^A03 Discharge/end visit
ADT^A04 Register a patient
ADT^A05 Pre-admit a patient
ADT^A06 Change an outpatient to an inpatient
ADT^A07 Change an inpatient to an outpatient
ADT^A08 Update patient information
ADT^A11 Cancel admit/visit notification
ADT^A12 Cancel transfer
ADT^A13 Cancel discharge/end visit
ADT^A14 Pending admit
ADT^A17 Swap patients
ADT^A23 Delete a patient record
ADT^A27 Cancel pending admit
ADT^A28 Add person information
ADT^A31 Update person information
ADT^A34 Merge patient information - patient ID only
ADT^A35 Merge patient information - account number only
ADT^A44 Move account information - patient account number