The HL7 Patient Demographic REST API Interface supports HL7 2.x and parses patient information based on the mapping below.
| SEG | Field ID | Field Name | Format | Required? | Min | Max | Comments |
|---|---|---|---|---|---|---|---|
| PID | Patient Information | ||||||
| PID 18.1 | Patient Account Number | AN | O | 1 | 30 | ||
| PID 5.1.1 | Patient Last Name | AN | Y | 1 | 35 | ||
| PID 5.2 | Patient First Name | AN | Y | 1 | 25 | ||
| PID 5.3 | Patient Middle Name | AN | O | 1 | 25 | ||
| PID 5.5 | Patient Prefix | AN | O | 1 | 10 | ||
| PID 5.4 | Patient Suffix | AN | O | 1 | 10 | ||
| PID 7 | Patient Date of Birth | DT | Y | 10 | 35 | ||
| PID 8 | Patient Gender | AN | Y | 1 | 1 | ||
| PID 11.1.1 | Patient Street 1 | AN | O | 1 | 55 | ||
| Patient Street 2 | O | Not currently used | |||||
| PID 11.3 | Patient City | AN | O | 1 | 35 | ||
| PID 11.4 | Patient State | AN | O | 2 | 2 | ||
| PID 11.5 | Patient Zip 1 | AN | O | 5 | 5 | ||
| Patient Zip 2 | O | Not currently used | |||||
| PID 13.1 | Patient Phone Number | AN | O | 10 | 10 | ||
| IN1 | Insurance | ||||||
| Insurance Rank | Not currently used | ||||||
| IN1 4.1 | Insurance Name | AN | C | 1 | 35 | ||
| Insurance ID Qualifier | AN | Defaults to “PI” | |||||
| IN1 2.1 | Insurance ID | AN | C | 1 | 80 | ||
| Insurance Type | AN | Defaults to “C1” | |||||
| Insurance Filing Indicator | AN | Defaults to “11” | |||||
| IN1 5.1.1 | Insurance Street 1 | AN | O | 1 | 55 | ||
| Insurance Street 2 | AN | O | 1 | 55 | Not currently used | ||
| IN1 5.3 | Insurance City | AN | O | 1 | 30 | ||
| IN1 5.4 | Insurance State | AN | O | 2 | 2 | ||
| Group ID | AN | Defaults to “[DEFAULT]” | |||||
| IN1 5.5 | Insurance Zip 1 | AN | O | 5 | 5 | ||
| IN1 5.7.1 | Insurance Phone Number | AN | O | 10 | 10 | ||
| Relationship to Patient | AN | Mapped SEL -> 18 SPO -> 01 PAR -> 19 S -> 18 Else -> 34 |
|||||
| IN1 5.36 | Policy Number | AN | C | 2 | 80 | ||
| IN1 5.8 | Group Number | AN | O | 2 | 80 | ||
| IN1 16.1.1 | Subscriber Last Name | AN | C | 1 | 35 | ||
| IN1 16.2 | Subscriber First Name | AN | C | 1 | 25 | ||
| IN1 16.3 | Subscriber Middle Name | AN | O | 1 | 25 | ||
| IN1 16.5 | Subscriber Prefix | AN | O | 1 | 10 | ||
| IN1 16.4 | Subscriber Suffix | AN | O | 1 | 10 | ||
| IN1 19.1.1 | Subscriber Street 1 | AN | O | 1 | 55 | ||
| Subscriber Street 2 | O | Not currently used | |||||
| IN1 19.3 | Subscriber City | AN | O | 1 | 30 | ||
| IN1 19.4 | Subscriber State | AN | O | 2 | 2 | ||
| IN1 19.5 | Subscriber Zip 1 | AN | O | 5 | 5 | ||
| Subscriber Zip 2 | O | Not currently used | |||||
| IN1 63.1 | Subscriber Phone Number | AN | O | 10 | 10 | ||
| PV1 | Patient Visit | ||||||
| Active Flag | Defaults to “Y” | ||||||
| PV1 46 | Patient Balance | DEC | O | 1 | 10 | ||