ADT Feed Specifications

Photon does not make use of every data element in the typical ADT message. Since our focus is on acute care scenarios we require a subset of the total data.

ADT Message Header

Field Name
Description
Location
Format

Event Date

This marks the date and time of the HL7 message. We use this date to prevent older messages from updating current data.

MSH.7.1

YYYYMMDDHHMMSS

Hospital Indicator

This is a code used to identify the source hospital.

MSH.4.1

string

Event Type

This is usually just the value "ADT"

MSH.9.1

string

Event Code

This is the ADT event code, typically somewhere in the range of A01 to A44

MSH.9.2

string

ADT Message Body

Field Name
Description
Location
Format
Optional?

Date of Birth

The birthdate of the patient.

PID.7.1

YYYYMMDD

Patient First Name

The patient's given name.

PID.5.2

string

Patient Middle Name

The patient's middle name.

PID.5.3

string

Patient Last Name

The patient's family name.

PID.5.1

string

Patient Suffix

(optional) The patients name suffix (ex: MD, PhD, Jr)

PID.5.4

string

Patient Gender

Gender code. It is typically 'M' for male, 'F' for female, with additional codes as needed. A lookup table is required so Photon can display the proper text per code provided.

PID.8.1

string

Patient Race

Race code. This indicates the race of the patient. A lookup table is required so Photon can display the proper text per code provided.

PID.10.1

string

Patient Marital Status

Marital Status code. A lookup table is required so Photon can display the proper text per code provided.

PID.16.1

string

Patient Religion

Religion code. A lookup table is required so Photon can display the proper text per code provided.

PID.17.1

string

Patient Address Type

Code that indicates the type of address for cases of multiple PID.11 segments. Default is "Home".

PID.11.7

string

Patient Address Street

The first line of the address.

PID.11.1

string

Patient Address Line 2

Second line of the address, such as apartment number, or PO box.

PID.11.2

string

Patient Address City

The city of the address.

PID.11.3

string

Patient Address Province / State

The state or province of the address.

PID.11.4

string

Patient Address Postal Code

The postal code. Either 5 or 9 digit variations are acceptable.

PID.11.5

ddddd or ddddd-dddd

Patient Address Country

The name or code of the address country. USA is the default.

PID.11.6

string

Patient Home Phone

The patient's home phone number. All non-numeric characters are removed by Photon before storage.

PID.13.1

string

Patient Work Phone

The patient's work phone number. All non-numeric characters are removed by Photon before storage.

PID.14.1

string

Patient Medical Record Number

If you support multiple medical record numbers in your ADT (multiple PID.3 segments), we typically filter to one based on the value of the PID.3.5 field

PID.3.1

string

Patient Account Number

This is the encounter or account code for the patient's visit.

PID.18.1

string

Admission Date

This is the date-time of admission for this encounter.

PV1.44.1

YYYYMMDDHHMMSS

Discharge Date

This is the date-time of discharge for the patient encounter.

PV1.45.1

YYYYMMDDHHMMSS

Point of Care

Location in the hospital system where care is being administered.

PV1.3.1

string

Room

The room number for the patient

PV1.3.2

string

Bed

The bed number in the room

PV1.3.3

string

Primary Care Code

The internal user ID of the primary care doctor assigned to the patient.

PV1.8.1

string

Primary Care First Name

The first name of the primary care doctor assigned to the patient.

PV1.8.3

string

Primary Care Last Name

The last name of the primary care doctor assigned to the patient.

PV1.8.2

string

Admitting Code

The internal user ID of the admitting doctor assigned to the patient.

PV1.17.1

string

Admitting First Name

The first name of the admitting doctor assigned to the patient.

PV1.17.3

string

Admitting Last Name

The last name of the admitting doctor assigned to the patient.

PV1.17.2

string

Attending Code

The internal user ID of the attending doctor assigned to the patient.

PV1.7.1

string

Attending First Name

The first name of the attending doctor assigned to the patient.

PV1.7.3

string

Attending Last Name

The last name of the attending doctor assigned to the patient.

PV1.7.2

string

Consulting Code

The internal user ID of the consulting doctor assigned to the patient.

PV1.9.1

string

Consulting First Name

The first name of the consulting doctor assigned to the patient.

PV1.9.3

string

Consulting Last Name

The last name of the consulting doctor assigned to the patient.

PV1.9.2

string

Diagnosis

A set of diagnosis codes

DG1

Procedures

A set of procedures

PR1

Next of Kin

The listed next of kin of the patient (emergency contacts)

NK1

Insurance

The insurance coverage of the patient

IN1

Allergies

The list of known allergies of the patient.

AL1 or IAM

Read more

Last updated