emsdocs
This document is commercial-in-confidence. The recipient of this document agrees to hold all information presented within as confidential and agree not to use or disclose, or allow to use or disclosure of the said information to unauthorized parties, directly or indirectly, irrespective of the acceptance or rejection of the presentation or at any time before, during or after an agreement has been reached, without prior written consent.
EMS Integration - Default Reference Data
Document History
| Version | Date | Who | Comments |
|---|---|---|---|
| v0.1 - Draft | 15th July 2021 | Lee Dyson | First draft. |
| v0.2 - Draft | 16th Jul 2021 | Robert McNaught | Disclaimer |
| v0.3 - Draft | 24th August 2021 | Lee Dyson | Default appointment type of “ROUTINE” |
| v1.0 - Release | 29th Sept 2021 | Robert McNaught | Formatting and fixes |
| v1.1 - Release | 30 Sept 2021 | Lee Dyson | Additional detail |
| v1.11 - Release | 25 October 2021 | Lee Dyson | Comment Re: CAPSULE procedures |
Contents
- EMS Integration - Default Reference Data
Introduction
For standard EMS cloud implementations, a default set of reference data tables are pre-loaded into the system. Customers can choose to use these data-sets, or indeed to augment them with their own local code-sets. As far as possible, the EMS integration tries to “pass-through” these values. i.e. the value in the message passed from the integration engine is the value which is passed into EMS.
Standard HL7v2.4 messages from a customer’s TIE are mapped into FHIR R4 format before being sent into EMS by the EMS integration server. In doing so, certain “fixed” reference values from the FHIR R4 specification are imposed upon the message content. Where appropriate, this will be reflected in this document.
Data Sets
Patient Gender
Usual passed in PID-8, these are mapped into FHIR-R4 Enumerations.AdministrativeGender values.
Default Values
| HL7 Value | EMS Value |
|---|---|
| M | MALE |
| MALE | MALE |
| F | FEMALE |
| FEMALE | FEMALE |
| U | NotKnown |
| UNKNOWN | NotKnown |
| O | OTHER |
| OTHER | OTHER |
| default | NULL |
Patient Category
This is used to indicate whether the patient in context needs to pay for their treatment, e.g. is the patient an NHS patient, or a PRIVATE patient. In messaging terms, Patient Category is an attribute of the Patient rather than the Appointment or Order.
EMS acceptable values are based on the NHS UK FHIR Dataset
Typically this value is harvested from PV1-18 of the incoming HL7 messages.
Default Values
| Incoming Value | Sent to EMS | Mapped in EMS |
|---|---|---|
| NHS | 1, Exempt from payment - subject to reciprocal health agreement | NHS |
| PRIVATE | 4, To Pay All Fees | Self-Payer |
| 1 | 1, Exempt from payment - subject to reciprocal health agreement | NHS |
| 2 | 2, Exempt from payment - Other | Private |
| 3 | 3, To pay hotel fees only | Unknown |
| 4 | 4, To Pay All Fees | Self-Payer |
| 9 | 9, Charging rate unknown | Unknown |
| 8 | 8, Not applicable | Unknown |
Note:
- In practice, most sites will use the
NHSorPRIVATEstandard values. - Only
NHS,Self-Payer,PrivateandUnknownare available in EMS. - These are output on PDF reports alongside Patient Management & Appointment Type e.g. “NHS / DC / Routine”
Patient Management
Used to indicate the intended management of a patient’s episode. e.g. INPATIENT, OUTPATIENT etc. This coded-value is normally harvested from field PV1-2 of the incoming message
Default Values
EMS is pre-loaded with the following dataset
| Code | Meaning |
|---|---|
| IP | Inpatient |
| DC | Day Case |
| OP | Outpatient |
| UKN | Unknown |
Note:
- If other values are used, the interface will pass them through to EMS untouched. For EMS to recognise these additional values, they must also be added to the EMS reference data tables.
Contact Details
Typically used as qualifiers to telephone numbers in PID-13pr PID-14. HL7 ContactPoints have both a system and a use
e.g. 07775811234^HOME^PHONE
Where HOME is the Use and PHONE is the System. A more formal definition of these fields can be found at Caristix.
The actual values used by EMS are shown in the tables below.
Contact Use Code
This is parsed from PID-13.2 (or PID-14.2)
| Code | Meaning |
|---|---|
| HOME | Patient’s HOME number |
| MOBILE | Patient’s personal MOBILE |
| WORK | A work number |
| BUSINESS | A work number |
In the absence of a value, the interface will return a NULL value.
Contact System Code
This is typically used to indicate the method of transport of a message (e.g. Internet, Fax etc.).
The values used in EMS are:
| Code | Meaning |
|---|---|
| PHONE | This is a phone number |
| MOBILE | This is a mobile pbone number |
| This is an email address | |
| FAX | This is a fax machine |
in the absence of a value, the default value of PHONE will be returned.
Appointment Type
This value is use to indicate the appointment type or priority of an incoming referral / appointment or order.
Default Values
The following default values are pre-loaded into EMS. These values can be sent un-coded, and will be passed through to EMS untouched.
| Plain Text |
|---|
| Urgent |
| Routine |
| USC - 2 Week Wait |
| Bowel Cancer Screening |
Note:
- This field is harvested from different locations depending upon the type of HL7 message being employed (e.g.
REF,SIU,ORM) - Please see the relevant documentation for the specific message type.
Coded Values
In addition to the plain text values described above, the following coded values can also be sent These will be mapped into their expansion by the interface prior to being sent to EMS.
A default value of Routine is applied if no value is provided.
| Coded Value | Expansion |
|---|---|
| [BLANK] | Routine |
| ROU | Routine |
| SA | Surveillance |
| USC | Cancer - 2 Week Wait |
| UR | Urgent |
| BCS | Bowel Cancer Screening |
| PP | Private Patient |
| EMG | Emergency |
| IP | Inpatient |
Source Of Referral
Default Values
The following default values are pre-loaded into EMS. These values can be sent un-coded, and will be passed through to EMS untouched.
| Plain Text |
|---|
| In Patients |
| Out Patients |
| GP |
| Tertiary |
| Repeat |
| Surveillance |
Note:
- This field is harvested from a different location depending upon the type of HL7 message being employed (e.g.
REF,SIU,ORM) - Please see the relevant documentation for the specific message type.
Coded Values
| Coded Value | Expansion |
|---|---|
| G | GP |
| CONS | In Patients |
| OP | Out Patients |
| T | Tertiary |
| REP | Repeat |
| SURV | Surveillance |
Note:
- In addition to the plain text values described above, the following coded values can also be sent These will be mapped into their expansion by the interface prior to being sent to EMS.
Procedure Codes
The procedure code field is used to indicate the specific endoscopy procedure being ordered, booked, or referred-for by the requesting system. EMS itself supports only a small number of specific clinical procedures. The EMS interface can be configured to use any of the following procedure code sets.
Default Codes
The following default procedure codes are EMS’ own internal procedure codes.
| Accepted Code | Meaning |
|---|---|
| BRONCH | Bronchoscopy |
| CAPSULE* | Capsule Endoscopy |
| COLON | Colonoscopy |
| CYSTO | Cystoscopy |
| ENTERO | Enteroscopy |
| ERCP | ERCP |
| EUS | EUS |
| FLEXISIG | Flexible Sigmoidoscopy |
| OGD | Upper GI Endoscopy |
| OGD_COLON | Upper GI and Colonoscopy |
| OGD_FLEXISIG | Upper GI and Flexible Sigmoidoscopy |
OPCS Codes
| OPCS Code | EMS Code |
|---|---|
| G459 | OGD |
| G445 | OGD |
| G809 | OGD |
| H229 | Colon |
| H259 | FlexiSig |
| G452 | EUS |
| J439 | ERCP |
| G802* | CAPSULE |
| E632 | Bronch |
| E456 | Bronch |
| T119 | Bronch |
| T123 | Bronch |
| E449 | Bronch |
| E492 | Bronch |
| E499 | Bronch |
| M459 | Cysto |
CCSD Codes
| CCSD Code | EMS Code |
|---|---|
| G6500 | OGD |
| G4530 | OGD |
| G4430 | OGD |
| G4440 | OGD |
| G3490 | OGD |
| H2002 | Colon |
| H2003 | Colon |
| H2350 | Colon |
| H2502 | FlexiSig |
| H2503 | FlexiSig |
| G8082 | OGD_Colon |
| G8083 | OGD_Colon |
| G8084 | OGD_FlexiSig |
| G8085 | OGD_FlexiSig |
| H2220 | EUS |
| J6730 | EUS |
| E6310 | Bronch |
| E5180 | Bronch |
| E5100 | Bronch |
Note:
- EMS allows for a small set of combined procedures (e.g.
OGD_FlexiSig) as shown above - Capsule procedures are currently ONLY supported in NHS Scotland implementations of EMS. Customers outside of NHS Scotland SHOULD NOT order capsule procedures. Should you wish to use EMS for capsule endoscopy please contact sales@medilogik.co.uk.
Practitioner Identifiers
EMS can be configured to handle Practitioner (e.g. GP, Consultant) codes in a number of different ways to accommodate UK “national” or “local” codes as used in NHS Trusts, private health organisations, or other countries.
Please see Notes on Processing XCN DataTypes for further details on EMS’ processing of GP / Practitioner codes.