Storing HL7 Admission, Discharge, Transfer (ADT) Data in the Packaged EHR Data Model

The HL7 Admission, Discharge, Transfer (ADT) message handles information such as the identity of the patient, the patient’s next of kin, patient visits, payers, and allergies. Data elements in ADT messages are stored in the Salesforce Account and Contact objects and in Health Cloud custom objects in the packaged EHR data model. Elements are listed here in order of sequence number in the HL7 standard.

ADT Patient Identification (PID)

Patient Identification (PID) elements in ADT messages handle information needed for establishing the identity of the patient.

As the Candidate Patient custom object is being retired, use the Lead object instead of the Candidate Patient object. If you need a Candidate Patient field that Lead doesn't support, create the fields.

Note

SEQ	HL7 Element	Salesforce Object	Field
1	Set ID – Patient ID
2	Patient ID (External ID)	Account	MedicalRecordNumber
3	Patient ID (Internal ID)	Account	SourceSystem; ID
5	Patient Name	Account	Name
		Contact	Name
		EhrPatient	GivenName1; FamilyName1
7	Date/Time of Birth	Contact	DateOfBirth
7	Date/Time of Birth	EhrPatient	BirthDate
8	Sex	EhrPatient	GenderCode;GenderLabel
9	Patient Alias	EhrPatient	GivenName2;Family Name2
		EhrPatient	GivenName3;Family Name3
		EhrPatient	Given Name4; Family Name4
11	Patient Address	Contact	Address Information: MailingStreet, MailingCity, MailingState, MailingZip (PostalCode), MailingCountry
11	Patient Address	EhrPatient	Address1Line1, Address1Line2, Address1City, Address1Country, Address1Postal Code, Address1 StateDate, Address1EndDate
13	Phone Number – Home	Contact	HomePhone
14	Phone Number – Business	Contact	Phone
15	Primary Language	Contact	PrimaryLanguage
		Account	PrimaryLanguage
		EhrPatient	Communication1Code (1 to 5)
16	Marital Status	EhrPatient	MaritalStatusCode, MaritalStatusLabel
30	Patient Death Indicator	EhrPatient	Deceased

ADT Next of Kin (NK1)

The NK1 segment contains information about the patient’s other related parties, and any associated parties.

When you build tooling to connect EHR data with Salesforce Health Cloud objects, use these mappings as a guide.

SEQ	HL7 Element	Salesforce Object	Field
NK1.1	Set ID - NK1
NK1.2	NK Name	Contact	ContactName
		Account	AccountName
		EhrPatient EhrRelatedPerson	Given ame1 (up to 5); FamilyName1 (up to 3)
NK1.3	Relationship	Contact	RelatedRole, ContactRelationship
NK1.3	Relationship	EhrPatient EhrRelatedPerson	Relationship
NK1.4	Address	Contact	Address Information: MailingStreet, MailingCity, MailingState, MailingZip/MailingPostal Code, MailingCountry
NK1.4	Address	EhrPatient EhrRelatedPerson	Address Information: Address1Line1, Address1Line2, Address1City, Address1State, Address1Postal Code, Address1Country
NK1.5	Phone Number	Contact	Phone, HomePhone, Mobile
NK1.5	Phone Number	EhrPatient EhrRelatedPerson	Telecom1Value(up to 5)
NK1.6	Business Phone Number	Contact	Phone, OtherPhone
NK1.6	Business Phone Number	EhrPatient EhrRelatedPerson	Telecom1Value(up to 5)
NK1.7	Contact Role	EhrPatient EhrRelatedPerson	Role, Role255
NK1.10	Next of Kin / Associated Parties Job Title	Contact	Title
NK1.11	Next of Kin / Associated Parties Job Title
NK1.12	Next of Kin / Associated Parties Employee Number	User	EmployeeNumber
NK1.15	Sex	Account	Gender
		Contact	Gender
		EhrPatient EhrRelatedPerson	Gender
NK1.16	Date/Time Of Birth	Account	BirthDate
		Contact	BirthDate
		EhrPatient EhrRelatedPerson	BirthDate
NK1.20	Primary Language	Account	PrimaryLanguage__pc
		Contact	PrimaryLanguage
		EhrPatient EhrRelatedPerson	Language1 (from 1 to 5)
NK1.30	Contact Person’s Name	EhrPatient Contact	GivenName1 (up to 5); FamilyName1 (up to 3)
NK1.31	Contact Person’s Telephone Number	EhrPatient Contact	Telecom1Value (up to 5)
NK1.32	Contact Person’s Address	EhrPatient Contact	Address Information: Address1Line1, Address1Line2, Address1City, Address1State, Address1Postal Code, Address1Country

ADT Patient Visit (PV1)

The PV1 segment contains information about inpatient or outpatient health care encounters.

SEQ	HL7 Element	Salesforce Object	Field
2	Patient Class	EhrEncounter	Class
3	Assigned Patient Location	EhrEncounter	Location1Description, Location1Name, Location1Type
4	Admission Type	EhrEncounter	Indication, ReasonCode, ReasonLabel
5	Preadmit Number	EhrEncounter	HospitalizePreAdmissionId, HospitalizationPreAdmissionId, HospitalizeAdmitSourceCode
6	Prior Patient Location	EhrEncounter	HospitalizeOrigin, HospitalizationOrigin
7	Attending Doctor	EhrEncounterParticipant	Practitioner
7	Attending Doctor	EhrEncounterParticipant	TypeCode, TypeLabel
8	Referring Doctor	EhrEncounter	HospitalizeAdmitSourceCode, HospitalAdmitSourceLabel
9	Consulting Doctor	EhrEncounterParticipant	Practitioner
9	Consulting Doctor	EhrEncounterParticipant	TypeCode, TypeLabel
10	Hospital Service	EhrEncounter	TypeCode, TypeLabel
13	Re-admission Indicator	EhrEncounter	HospitalizeReadmission
17	Admitting Doctor	EhrEncounterParticipant	Practitioner
17	Admitting Doctor	EhrEncounterParticipant	TypeCode, TypeLabel
36	Discharge Disposition	EhrEncounter	HospitalizeDischargeDispositionCode
37	Discharged to Location	EhrEncounter	HospitalizeDestination
38	Diet Type	EhrEncounter	HospitalizeDietCode, HospitalizeDietLabel
42	Pending Location	EhrEncounter	Location1Description, Location1Name, Location1Type
43	Prior Temporary Location	EhrEncounter	Location1Description, Location1Name, Location1Type
44	Admit Date/Time	EhrEncounter	HospitalizePeriodStart
45	Discharge Date/Time	EhrEncounter	HospitalizePeriodEnd

ADT Guarantor (GT1)

The GT1 segment contains data about the guarantor (e.g., the person or the organization with financial responsibility for payment of a patient account) for patient and insurance billing applications.