Salesforce Health Cloud Developer Guide
Winter '27 (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Parsing HL7 Data
Example: Parse an ADT Message
Example: Parse an Al1 Message Segment
ADT Patient Identification (PID)
ADT Next of Kin (NK1)
ADT Patient Visit (PV1)
ADT Guarantor (GT1)
ADT Allergies (AL1)
EhrAllergyIntolerance__c
EhrCarePlan__c
EhrCarePlanActivity__c
EhrCarePlanConcern__c
EhrCarePlanGoal__c
EhrCarePlanParticipant__c
EhrCondition__c
EhrConditionRelatedItem__c
EhrDevice__c
EhrDosageInstruction__c
EhrEncounter__c
EhrEncounterAccommodation__c
EhrEncounterParticipant__c
EhrImmunization__c
EhrImmunizationReaction__c
EhrMedicationPrescription__c
EhrMedicationStatement__c
EhrObservation__c
EhrPatient__c
EhrPatientCareProvider
EhrPatientContact__c
EhrPractitioner__c
EhrPractitionerIdentity__c
EhrPractitionerQualification__c
EhrPractitionerRole__c
EhrProcedure__c
EhrProcedurePerformer__c
EhrProcedureRequest__c
EhrProgram__c
EhrRelatedObservation__c
EhrRelatedPerson__c
EhrVaccinationProtocol__c
EhrVirtualDevice__c
EhrVirtualDeviceChannel__c
CarePlanTemplate__c
CarePlanTemplateGoal__c
CarePlanTemplateProblem__c
CarePlanTemplateTask__c
AccountAccountRelation__c
CandidatePatient__c
CardViewDropdown__c
CarePlanGoal__c
CarePlanProblem__c
ConditionToHCCCodeMapping__c
ContactContactRelation__c
CrossObjectRelationship__c
CustomFieldSets__c
CustomLabelConfig__c
FilterColumn__c
FilterCondition__c
FilterCriterion__c
PatientCardViewConfiguration__c
ReciprocalRole__c
ProgramPatientAffiliation__c
ProgramPatientSummary__c
Provider__c
TimelineViewConfiguration__c
Create Patients With the Health Cloud Business API
Newer Version Available
Storing HL7 Admission, Discharge, Transfer (ADT) Data in Salesforce Objects
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. 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. -
ADT Next of Kin (NK1)
The NK1 segment contains information about the patient’s other related parties, and any associated parties. -
ADT Patient Visit (PV1)
The PV1 segment contains information about inpatient or outpatient health care encounters. -
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. -
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.