DRAFT Working draft of an upcoming version. Not the published standard. View the current published version
Skip to content

5.4 Data Elements in the Message Payload ​

Data Element NumberData Element NameElement TypeCMS Final RuleContext/MetadataContentHuman Readable
X-Direct-ContextMessage HeaderR
Content-TypeMime-partR
Content-Transfer-EncodingMime-partO
Content-IDMime-partR
Content-DispositionMime-partR
versionContextR
IdContextR
patient-idContextR
TypeContextR
purposeContextR
patientContextR
11a.givenNameContextR
11b.surnameContextR
11c.middleNameContextRE
11d.dateOfBirthContextR
11e.genderContextR
11f.socialSecurityNumberContextRE
11g.telephoneNumberContextRE
11h.streetAddressContextRE
11i.stateOrProvinceNameContextRE
11j.localityNameContextRE
11k.postalCodeContextRE
11l.countryContext
11m.directAddressContextRE
creation-timeContextR
profileContextR
type-codeContextR
activity-codeContextRR
authorSubmission SetR
contentTypeCodeSubmission SetR
entryUUIDSubmission SetR
intendedRecipientSubmission SetR
patientIdSubmission SetRE
sourceIdSubmission SetR
submissionTimeSubmission SetR
titleSubmission SetO
uniqueIdSubmission SetR
authorDocument entryRE
classCodeDocument entryRE
confidentialityCodeDocument entryRE
creationTimeDocument entryRE
entryUUIDDocument entryR
formatCodeDocument entryR
healthcareFacilityTypeCodeDocument entryRE
languageCodeDocument entryRE
mimeTypeDocument entryR
patientIdDocument entryRE
practiceSettingCodeDocument entryRE
sourcePatientIdDocument entryRE
sourcePatientInfoDocument entryR
37a.Source patient identifier list
37b.Source patient nameR
37c.(Intentionally Blank)
37d.(Intentionally Blank)
37e.Source patient date of birthR
37f.Source patient administrative genderR
37g.Source patient addressRE
typeCodeDocument entryRR
uniqueIdDocument entryR
(Intentionally Blank)
40A.Message CodeMSH-9.1 – Message Type.Message CodeR
40B.Message EventMSH-9.2 – Message Type.Trigger EventR
Transaction IDMSH-10 – Message Control IDR
Event DateEVN-2.1 - Recorded Date/Time.TimeRRR
Version IDMSH-12 – Version IDR
Patient IDPID-3.1– Patient Identifier List.Id NumberR
Patient ID TypePID-3.5– Patient Identifier List.Identifier Type CodeRE
Patient SSN Last 4 digitsPID-3.1 – Patient Identifier List.Id NumberO
Patient First NamePID-5.2 – Patient Name.Given NameRRR
Patient Last NamePID-5.1 – Patient Name.Family NameRRR
Patient Middle NamePID-5.3 – Patient Name.Second And Further Given Names Or Initials ThereofRER
Patient SuffixPID-5.4 – Patient Name.Suffix (e.g., Jr Or Iii)RER
Patient AliasPID-5.7 – - Patient Name.Name Type CodeO
Patient Date of BirthPID-7 – Date/Time of BirthRR
Patient GenderPID-8 – Administrative SexRR
Patient Street AddressPID-11.1 – Patient Address.Street AddressRE
Patient Street Address 2PID-11.2 – Patient Address.Other DesignationRE
Patient CityPID-11.3 – Patient Address.CityRE
Patient StatePID-11.4 – Patient Address.State Or ProvinceRE
Patient ZIPPID-11.5 –Patient Address.Zip Or Postal CodeRE
Patient Countr– - if not USPID-11.6 – Patient Address.CountryRE
Patient Telephone Number

PID-13.6 – Phone Number – Home.Area/City Code

PID-13.7 – Phone Number – Home.Local Number

RE
Patient Telecommunication Use TypePID-13.2 - Phone Number – Home.Telecommunication Use CodeRE
Patient emailPID-13. 4– Phone Number – Home.Email AddressRE
Patient Account NumberPID-18 – Patient Account NumberR
Patient Date of DeathPID-29 – Patient Death Date and TimeRE
RoleROL-3.1 – Role-ROL. IdentifierRE
Person Identifier (NPI)ROL-4.1 - Role Person.Id NumberRE
Person Last NameROL-4.2 - Role Person.Family NameRE
Person First NameROL-4.3 - Role Person.Given NameRE
Organization Identifier (NPI)ROL-4.1 - Role Person.Id NumberRE
Organization NameROL-4.2 - Role Person.Family NameRE
Person or Organization Direct addressROL-12.4-Phone.Email AddressRE
Treating Facility Identifier (Type 2 NPI)EVN-7.2 – Event Facility.Universal IdR
Patient ClassPV1-2 - Patient ClassRR
Assigned Patient Location – Point of CarePV1-3.1 - Assigned Patient Location.Point Of CareRE
Treating Facility NamePV1-3.9 - Assigned Patient Location.Location DescriptionR
Treating Facility AddressROL-11 - Office/Home Address/Birthplace (ROL-3.1 = TF)RERE
Admission Type ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-1.svg)PV1-4 - Admission TypeR
Prior Patient LocationPV1-6 - Prior Patient LocationRE
79a.Treating Provider (Attending) NPIPV1-7.1 – Attending Doctor.Id NumberRERE
Treating Provider (Attending) Last NamePV1-7.2 - Attending Doctor.Family NameRERE
Treating Provider (Attending) First NamePV1-7.3 - Attending Doctor.Given NameRERE
Intentionally Blank
Treating Provider (Attending) Direct addressROL-12.4-Phone.Email AddressRERE
Treating Provider (Consulting) NPIPV1-9.1 - Consulting Doctor.Id NumberRERE
Treating Provider (Consulting) Last NamePV1-9.2 - Consulting Doctor.Family NameRERE
Treating Provider (Consulting) First NamePV1-9.3 - Consulting Doctor.Given NameRERE
Intentionally Blank
Treating Provider (Consulting) Direct addressROL-12.4-Phone.Email AddressRERE
Treating Provider (Admitting) NPIPV1-17.1 - Admitting Doctor.Id NumberRERE
Treating Provider (Admitting) Last NamePV1-17.2 - Admitting Doctor.Family NameRERE
Treating Provider (Admitting) First NamePV1-17.3 - Admitting Doctor.Given NameRERE
Intentionally Blank
Treating Provider (Admitting) Direct addressROL-12.4-Phone.Email AddressRERE
Visit NumberPV1-19 - Visit NumberR
Discharge DispositionPV1-36 - Discharge DispositionRRE
Discharged to LocationPV1-37 - Discharged to LocationRE
Admit DatePV1-44 - Admit Date/TimeR
Admission ReasonPV2-3 - Admit ReasonRERE
Diagnosis CodeDG1-3.1 - Diagnosis Code - DG1.IdentifierRE
Diagnosis DescriptionDG1-3.2 - Diagnosis Code - DG1.TextRERE
Diagnosis Coding SystemDG1-3.3 - Diagnosis Code - DG1.Name Of Coding SystemRE
Diagnosis TypeDG1-6 - Diagnosis TypeRE
Insurance Company NameIN1-4 - Insurance Company NameRE
Insurance Group NumberIN1-8 - Group NumberRE
Insurance TypeIN1-15 - Plan TypeRE
Patient Insurance Member IDIN1-36 - Policy NumberRE
Insured’s ID NumberIN1-49 – Insured’s ID NumberRE

Primary Care Provider Identifier (NPI)

NOTE: Type 1 NPI if the entity is an Individual

ROL-4.1 – Role Person.Id Number (with ROL-3.1 = PP)

RE

RE

Primary Care Provider Last NameROL-4.2 - Role Person.Family NameRE
Primary Care Provider First NameROL-4.3 - Role Person.Given NameRE
TimeEVN-2.1 – Recorded Date/Time.TimeR
Universal Id TypeEVN-7.3 – Event Facility.Universal Id TypeR
Mother’s Name ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-2.svg)NK1-2 - NameRE
Relationship ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-3.svg)NK1-3 - RelationshipRE
Mother’s Address ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-4.svg)NK1-4 – AddressRE
Mother’s Phone Number ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-5.svg)NK1-5.1 – Phone Number.Telephone NumberRE
Newborn Baby Indicator ![Woman with stroller](/images/05-value-sets-and-examples/5-4-data-elements-in-the-message-payload-6.svg)PV2-36 – Newborn Baby IndicatorO
Discharge Date/timePV1-45 – Discharge Date/TimeO

Woman with stroller - See Appendix