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

SEQHL7 ElementSalesforce ObjectField
1Set ID – Patient ID  
2Patient ID (External ID)AccountMedicalRecordNumber
3Patient ID (Internal ID)AccountSourceSystem; ID
5Patient NameAccountName
 Patient NameContactName
 Patient NameEhrPatientGivenName1; FamilyName1
7Date/Time of BirthContactDateOfBirth
 Date/Time of BirthEhrPatientBirthDate
8SexEhrPatientGenderCode;GenderLabel
9Patient AliasEhrPatientGivenName2;Family Name2
 Patient AliasEhrPatientGivenName3;Family Name3
 Patient AliasEhrPatientGiven Name4; Family Name4
11Patient AddressContactAddress Information: MailingStreet, MailingCity, MailingState, MailingZip (PostalCode), MailingCountry
 Patient AddressEhrPatientAddress1Line1, Address1Line2, Address1City, Address1Country, Address1Postal Code, Address1 StateDate, Address1EndDate
13Phone Number – HomeContactHomePhone
14Phone Number – BusinessContactPhone
15Primary LanguageContactPrimaryLanguage
 Primary LanguageAccountPrimaryLanguage
 Primary LanguageEhrPatientCommunication1Code (1 to 5)
16Marital StatusEhrPatientMaritalStatusCode, MaritalStatusLabel
30Patient Death IndicatorEhrPatientDeceased

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.

SEQHL7 ElementSalesforce ObjectField
NK1.1Set ID - NK1  
NK1.2NK NameContactContactName
NK1.2NK NameAccountAccountName
NK1.2NK NameEhrPatient EhrRelatedPersonGiven ame1 (up to 5); FamilyName1 (up to 3)
NK1.3RelationshipContactRelatedRole, ContactRelationship
NK1.3RelationshipEhrPatient EhrRelatedPersonRelationship
NK1.4AddressContactAddress Information: MailingStreet, MailingCity, MailingState, MailingZip/MailingPostal Code, MailingCountry
NK1.4AddressEhrPatient EhrRelatedPersonAddress Information: Address1Line1, Address1Line2, Address1City, Address1State, Address1Postal Code, Address1Country
NK1.5Phone NumberContactPhone, HomePhone, Mobile
NK1.5Phone NumberEhrPatient EhrRelatedPersonTelecom1Value(up to 5)
NK1.6Business Phone NumberContactPhone, OtherPhone
NK1.6Business Phone NumberEhrPatient EhrRelatedPersonTelecom1Value(up to 5)
NK1.7Contact RoleEhrPatient EhrRelatedPersonRole, Role255
NK1.10Next of Kin / Associated Parties Job TitleContactTitle
NK1.11Next of Kin / Associated Parties Job Title  
NK1.12Next of Kin / Associated Parties Employee NumberUserEmployeeNumber
NK1.15SexAccountGender
NK1.15SexContactGender
NK1.15SexEhrPatient EhrRelatedPersonGender
NK1.16Date/Time Of BirthAccountBirthDate
NK1.16Date/Time Of BirthContactBirthDate
NK1.16Date/Time Of BirthEhrPatient EhrRelatedPersonBirthDate
NK1.20Primary LanguageAccountPrimaryLanguage__pc
NK1.20Primary LanguageContactPrimaryLanguage
NK1.20Primary LanguageEhrPatient EhrRelatedPersonLanguage1 (from 1 to 5)
NK1.30Contact Person’s NameEhrPatient ContactGivenName1 (up to 5); FamilyName1 (up to 3)
NK1.31Contact Person’s Telephone NumberEhrPatient ContactTelecom1Value (up to 5)
NK1.32Contact Person’s AddressEhrPatient ContactAddress Information: Address1Line1, Address1Line2, Address1City, Address1State, Address1Postal Code, Address1Country

ADT Patient Visit (PV1) 

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

SEQHL7 ElementSalesforce ObjectField
2Patient ClassEhrEncounterClass
3Assigned Patient LocationEhrEncounterLocation1Description, Location1Name, Location1Type
4Admission TypeEhrEncounterIndication, ReasonCode, ReasonLabel
5Preadmit NumberEhrEncounterHospitalizePreAdmissionId, HospitalizationPreAdmissionId, HospitalizeAdmitSourceCode
6Prior Patient LocationEhrEncounterHospitalizeOrigin, HospitalizationOrigin
7Attending DoctorEhrEncounterParticipantPractitioner
 Attending DoctorEhrEncounterParticipantTypeCode, TypeLabel
8Referring DoctorEhrEncounterHospitalizeAdmitSourceCode, HospitalAdmitSourceLabel
9Consulting DoctorEhrEncounterParticipantPractitioner
 Consulting DoctorEhrEncounterParticipantTypeCode, TypeLabel
10Hospital ServiceEhrEncounterTypeCode, TypeLabel
13Re-admission IndicatorEhrEncounterHospitalizeReadmission
17Admitting DoctorEhrEncounterParticipantPractitioner
 Admitting DoctorEhrEncounterParticipantTypeCode, TypeLabel
36Discharge DispositionEhrEncounterHospitalizeDischargeDispositionCode
37Discharged to LocationEhrEncounterHospitalizeDestination
38Diet TypeEhrEncounterHospitalizeDietCode, HospitalizeDietLabel
42Pending LocationEhrEncounterLocation1Description, Location1Name, Location1Type
43Prior Temporary LocationEhrEncounterLocation1Description, Location1Name, Location1Type
44Admit Date/TimeEhrEncounterHospitalizePeriodStart
45Discharge Date/TimeEhrEncounterHospitalizePeriodEnd

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.

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

SEQHL7 ElementSalesforce ObjectField
2Guarantor NumberContactIndividualId
 Guarantor NumberAccountIndividualId
3Guarantor NameContactContact Name
5Guarantor AddressContactAddress Information: Mailing Street, Mailing City, Mailing State, Mailing Zip/ Postal Code, Mailing Country
6Guarantor Ph Num-HomeContactHomePhone
7Guarantor Ph Num-BusinessContactPhone
8Guarantor Date/Time Of BirthContactBirthDate
9Guarantor SexContactGender
10Guarantor TypeContactIndividualType
11Guarantor RelationshipContactContactRelationRelated Role
13Guarantor Date - BeginContactContactRelationStartDate
14Guarantor Date - EndContactContactRelationEndDate
21Guarantor Organization NameAccountName
36Primary LanguageContactPrimaryLanguage

ADT Allergies (AL1) 

The AL1 segment contains patient allergy information. Most of this information will be derived from user-defined tables. Each AL1 segment describes a single patient allergy.

SEQHL7 ElementSalesforce ObjectField
2Allergen Type CodeEhrAllergyIntoleranceSensitivityTypeCode, SensitivityTypeLabel, SensitivityTypeSystem
3Allergen Code/Mnemonic/DescriptionEhrAllergyIntoleranceSubstance255, SubstanceLong
4Allergy Severity CodeEhrAllergyIntoleranceCriticalityCode, CriticalityLabel, CriticalitySystem
5Allergy Reaction CodeEhrAllergyIntoleranceReaction255, Reaction
6Identification DateEhrAllergyIntoleranceRecordedDate