Segment

Provider data

Identifies a provider involved in a referral, carrying the provider role (referring, referred-to, or consulting), provider name, address, and identifiers. It is specifically designed for inter-enterprise referral scenarios where PV1 alone is insufficient to fully identify external providers. Multiple PRD segments appear in REF and RRI messages, one for each provider role involved in the referral.

14fields

1required

v2.9HL7 version

from zato.hl7v2.v2_9 import PRD
from zato.hl7v2.v2_9 import CWE, XPN, PLN

prd = PRD()
prd.provider_role = CWE(
    identifier='RP',
    text='Referring Provider',
    name_of_coding_system='HL70286'
)
prd.provider_name = XPN(
    family_name='Johnson',
    given_name='Sarah'
)

Python examples

Build PRD segments in Python

How to construct and work with real-world PRD segments.

Referring physician with name, address, and phone

Identifies a referring provider with role, full name, office address, and telephone for a wellness referral

from zato.hl7v2.v2_9 import PRD
from zato.hl7v2.v2_9 import CWE, XAD, XPN

prd = PRD()
prd.provider_role = CWE(
    identifier='RP',
    text='Referring Provider',
    name_of_coding_system='HL70286'
)
prd.provider_name = XPN(
    family_name='JOHNSON',
    given_name='SARAH'
)
prd.provider_address = XAD(
    street_address='120 Wellness Ave',
    city='Portland',
    state_or_province='OR',
    zip_or_postal_code='97201'
)

Consulting dietitian with location and identifiers

Records a consulting dietitian with provider location and NPI identifier for a nutrition counseling referral

from zato.hl7v2.v2_9 import PRD
from zato.hl7v2.v2_9 import CWE, PL, PLN, XPN

prd = PRD()
prd.provider_role = CWE(
    identifier='CP',
    text='Consulting Provider',
    name_of_coding_system='HL70286'
)
prd.provider_name = XPN(
    family_name='MARTINEZ',
    given_name='ELENA'
)
prd.provider_location = PL(
    point_of_care='NUTR',
    room='205'
)
prd.provider_identifiers = PLN(
    id_number='1234567890',
    type_of_id_number='NPI'
)

Wellness coordinator with role dates and preferred contact

Defines a wellness coordinator with effective start and end dates and a preferred contact method for ongoing program coordination

from zato.hl7v2.v2_9 import PRD
from zato.hl7v2.v2_9 import CWE, XPN

prd = PRD()
prd.provider_role = CWE(
    identifier='RT',
    text='Referred-to Provider',
    name_of_coding_system='HL70286'
)
prd.provider_name = XPN(
    family_name='THOMPSON',
    given_name='DAVID'
)
prd.preferred_method_of_contact = CWE(
    identifier='TEL',
    text='Telephone',
    name_of_coding_system='HL70185'
)
prd.effective_start_date_of_provider_role = '20240601'
prd.effective_end_date_of_provider_role = '20251231'

Tutorials

Learn by building

Step-by-step guides for working with HL7 v2 in Zato.

MLLP

Receive and parse HL7 v2 messages

Set up an MLLP channel, parse incoming messages, and respond with acknowledgments.

Start tutorial Build

Build and send HL7 v2 messages

Construct HL7 v2 messages from scratch using typed segment classes and send them over MLLP.

Start tutorial

FAQ

Frequently asked questions

PRD contains provider data including name, role, identifiers, and contact information. It identifies wellness coaches, nutritionists, and preventive care providers in referral messages.

Use HL70286 table values for provider roles like RP, CP, or RT:

prd.provider_role = CWE(
    identifier='RP',
    text='Referring Provider',
    name_of_coding_system='HL70286'
)

Use NPI (National Provider Identifier) as the primary identifier. Additional identifiers like state license numbers can also be included.

PRD identifies the provider while CTD contains additional contact details. Both segments work together to provide complete provider information for wellness referrals.

Zato connects to any system that speaks HL7v2 over MLLP or FHIR over REST. This includes Epic, Cerner, Meditech, Allscripts, and other EHR platforms.

Yes, Zato has built-in MLLP support for sending and receiving HL7v2 messages. MLLP channels handle the framing protocol automatically.

Zato supports HL7 v2.9, which is backward compatible with earlier versions including v2.3, v2.5, and v2.7. Standard segments and datatypes are available as typed Python classes.

Yes. Zato handles both HL7v2 and FHIR natively, so you can parse v2 messages and build FHIR resources with IG-specific extensions in the same service. Typed Python classes are available for both protocols, including extensions from US Core, UK Core, Da Vinci, and other Implementation Guides.

Reference

PRD field reference

Complete list of fields in the PRD segment, HL7 v2.9.

#	Python name	Datatype	Usage	Repeatable	Table
1	▶`provider_role`	`CWE`	Required	Yes	`HL70286`
1.1	├`.identifier`	`ST`	Optional	No	-
1.2	├`.text`	`ST`	Optional	No	-
1.3	├`.name_of_coding_system`	`ID`	Optional	No	-
1.4	├`.alternate_identifier`	`ST`	Optional	No	-
1.5	├`.alternate_text`	`ST`	Optional	No	-
1.6	├`.name_of_alternate_coding_system`	`ID`	Optional	No	-
1.7	├`.coding_system_version_id`	`ST`	Optional	No	-
1.8	├`.alternate_coding_system_version_id`	`ST`	Optional	No	-
1.9	├`.original_text`	`ST`	Optional	No	-
1.10	├`.second_alternate_identifier`	`ST`	Optional	No	-
1.11	├`.second_alternate_text`	`ST`	Optional	No	-
1.12	├`.name_of_second_alternate_coding_system`	`ID`	Optional	No	-
1.13	├`.second_alternate_coding_system_version_id`	`ST`	Optional	No	-
1.14	├`.coding_system_oid`	`ST`	Optional	No	-
1.15	├`.value_set_oid`	`ST`	Optional	No	-
1.16	├`.value_set_version_id`	`DTM`	Optional	No	-
1.17	├`.alternate_coding_system_oid`	`ST`	Optional	No	-
1.18	├`.alternate_value_set_oid`	`ST`	Optional	No	-
1.19	├`.alternate_value_set_version_id`	`DTM`	Optional	No	-
1.20	├`.second_alternate_coding_system_oid`	`ST`	Optional	No	-
1.21	├`.second_alternate_value_set_oid`	`ST`	Optional	No	-
1.22	└`.second_alternate_value_set_version_id`	`DTM`	Optional	No	-
2	▶`provider_name`	`XPN`	Optional	Yes	-
2.1	├`.family_name`	`FN`	Optional	No	-
2.2	├`.given_name`	`ST`	Optional	No	-
2.3	├`.second_and_further_given_names_or_initials_thereof`	`ST`	Optional	No	-
2.4	├`.suffix`	`ST`	Optional	No	-
2.5	├`.prefix`	`ST`	Optional	No	-
2.6	├`.degree`	`ST`	Optional	No	-
2.7	├`.name_type_code`	`ID`	Optional	No	-
2.8	├`.name_representation_code`	`ID`	Optional	No	-
2.9	├`.name_context`	`CWE`	Optional	No	-
2.10	├`.name_validity_range`	`DR`	Optional	No	-
2.11	├`.name_assembly_order`	`ID`	Optional	No	-
2.12	├`.effective_date`	`DTM`	Optional	No	-
2.13	├`.expiration_date`	`DTM`	Optional	No	-
2.14	├`.professional_suffix`	`ST`	Optional	No	-
2.15	└`.called_by`	`ST`	Optional	No	-
3	▶`provider_address`	`XAD`	Optional	Yes	-
3.1	├`.street_address`	`SAD`	Optional	No	-
3.2	├`.other_designation`	`ST`	Optional	No	-
3.3	├`.city`	`ST`	Optional	No	-
3.4	├`.state_or_province`	`ST`	Optional	No	-
3.5	├`.zip_or_postal_code`	`ST`	Optional	No	-
3.6	├`.country`	`ID`	Optional	No	-
3.7	├`.address_type`	`ID`	Optional	No	-
3.8	├`.other_geographic_designation`	`ST`	Optional	No	-
3.9	├`.county_parish_code`	`CWE`	Optional	No	-
3.10	├`.census_tract`	`CWE`	Optional	No	-
3.11	├`.address_representation_code`	`ID`	Optional	No	-
3.12	├`.address_validity_range`	`DR`	Optional	No	-
3.13	├`.effective_date`	`DTM`	Optional	No	-
3.14	├`.expiration_date`	`DTM`	Optional	No	-
3.15	├`.expiration_reason`	`CWE`	Optional	No	-
3.16	├`.temporary_indicator`	`ID`	Optional	No	-
3.17	├`.bad_address_indicator`	`ID`	Optional	No	-
3.18	├`.address_usage`	`ID`	Optional	No	-
3.19	├`.addressee`	`ST`	Optional	No	-
3.20	├`.comment`	`ST`	Optional	No	-
3.21	├`.preference_order`	`NM`	Optional	No	-
3.22	├`.protection_code`	`CWE`	Optional	No	-
3.23	└`.address_identifier`	`EI`	Optional	No	-
4	▶`provider_location`	`PL`	Optional	No	-
4.1	├`.point_of_care`	`HD`	Optional	No	-
4.2	├`.room`	`HD`	Optional	No	-
4.3	├`.bed`	`HD`	Optional	No	-
4.4	├`.facility`	`HD`	Optional	No	-
4.5	├`.location_status`	`IS`	Optional	No	-
4.6	├`.person_location_type`	`IS`	Optional	No	-
4.7	├`.building`	`IS`	Optional	No	-
4.8	├`.floor`	`IS`	Optional	No	-
4.9	├`.location_description`	`ST`	Optional	No	-
4.10	├`.comprehensive_location_identifier`	`EI`	Optional	No	-
4.11	└`.assigning_authority_for_location`	`HD`	Optional	No	-
5	▶`provider_communication_information`	`XTN`	Optional	Yes	-
5.1	├`.telephone_number`	`ST`	Optional	No	-
5.2	├`.telecommunication_use_code`	`ID`	Optional	No	-
5.3	├`.telecommunication_equipment_type`	`ID`	Optional	No	-
5.4	├`.communication_address`	`ST`	Optional	No	-
5.5	├`.country_code`	`SNM`	Optional	No	-
5.6	├`.area_city_code`	`SNM`	Optional	No	-
5.7	├`.local_number`	`SNM`	Optional	No	-
5.8	├`.extension`	`SNM`	Optional	No	-
5.9	├`.any_text`	`ST`	Optional	No	-
5.10	├`.extension_prefix`	`ST`	Optional	No	-
5.11	├`.speed_dial_code`	`ST`	Optional	No	-
5.12	├`.unformatted_telephone_number`	`ST`	Optional	No	-
5.13	├`.effective_start_date`	`DTM`	Optional	No	-
5.14	├`.expiration_date`	`DTM`	Optional	No	-
5.15	├`.expiration_reason`	`CWE`	Optional	No	-
5.16	├`.protection_code`	`CWE`	Optional	No	-
5.17	├`.shared_telecommunication_identifier`	`EI`	Optional	No	-
5.18	└`.preference_order`	`NM`	Optional	No	-
6	▶`preferred_method_of_contact`	`CWE`	Optional	No	`HL70185`
6.1	├`.identifier`	`ST`	Optional	No	-
6.2	├`.text`	`ST`	Optional	No	-
6.3	├`.name_of_coding_system`	`ID`	Optional	No	-
6.4	├`.alternate_identifier`	`ST`	Optional	No	-
6.5	├`.alternate_text`	`ST`	Optional	No	-
6.6	├`.name_of_alternate_coding_system`	`ID`	Optional	No	-
6.7	├`.coding_system_version_id`	`ST`	Optional	No	-
6.8	├`.alternate_coding_system_version_id`	`ST`	Optional	No	-
6.9	├`.original_text`	`ST`	Optional	No	-
6.10	├`.second_alternate_identifier`	`ST`	Optional	No	-
6.11	├`.second_alternate_text`	`ST`	Optional	No	-
6.12	├`.name_of_second_alternate_coding_system`	`ID`	Optional	No	-
6.13	├`.second_alternate_coding_system_version_id`	`ST`	Optional	No	-
6.14	├`.coding_system_oid`	`ST`	Optional	No	-
6.15	├`.value_set_oid`	`ST`	Optional	No	-
6.16	├`.value_set_version_id`	`DTM`	Optional	No	-
6.17	├`.alternate_coding_system_oid`	`ST`	Optional	No	-
6.18	├`.alternate_value_set_oid`	`ST`	Optional	No	-
6.19	├`.alternate_value_set_version_id`	`DTM`	Optional	No	-
6.20	├`.second_alternate_coding_system_oid`	`ST`	Optional	No	-
6.21	├`.second_alternate_value_set_oid`	`ST`	Optional	No	-
6.22	└`.second_alternate_value_set_version_id`	`DTM`	Optional	No	-
7	▶`provider_identifiers`	`PLN`	Optional	Yes	`HL70338`
7.1	├`.id_number`	`ST`	Optional	No	-
7.2	├`.type_of_id_number`	`CWE`	Optional	No	-
7.3	├`.stateother_qualifying_information`	`ST`	Optional	No	-
7.4	└`.expiration_date`	`DT`	Optional	No	-
8	`effective_start_date_of_provider_role`	`DTM`	Optional	No	-
9	`effective_end_date_of_provider_role`	`DTM`	Optional	Yes	-
10	▶`provider_organization_name_and_identifier`	`XON`	Optional	No	-
10.1	├`.organization_name`	`ST`	Optional	No	-
10.2	├`.organization_name_type_code`	`CWE`	Optional	No	-
10.3	├`.id_number`	`NM`	Optional	No	-
10.4	├`.identifier_check_digit`	`ST`	Optional	No	-
10.5	├`.check_digit_scheme`	`ID`	Optional	No	-
10.6	├`.assigning_authority`	`HD`	Optional	No	-
10.7	├`.identifier_type_code`	`ID`	Optional	No	-
10.8	├`.assigning_facility`	`HD`	Optional	No	-
10.9	├`.name_representation_code`	`ID`	Optional	No	-
10.10	└`.organization_identifier`	`ST`	Optional	No	-
11	▶`provider_organization_address`	`XAD`	Optional	Yes	-
11.1	├`.street_address`	`SAD`	Optional	No	-
11.2	├`.other_designation`	`ST`	Optional	No	-
11.3	├`.city`	`ST`	Optional	No	-
11.4	├`.state_or_province`	`ST`	Optional	No	-
11.5	├`.zip_or_postal_code`	`ST`	Optional	No	-
11.6	├`.country`	`ID`	Optional	No	-
11.7	├`.address_type`	`ID`	Optional	No	-
11.8	├`.other_geographic_designation`	`ST`	Optional	No	-
11.9	├`.county_parish_code`	`CWE`	Optional	No	-
11.10	├`.census_tract`	`CWE`	Optional	No	-
11.11	├`.address_representation_code`	`ID`	Optional	No	-
11.12	├`.address_validity_range`	`DR`	Optional	No	-
11.13	├`.effective_date`	`DTM`	Optional	No	-
11.14	├`.expiration_date`	`DTM`	Optional	No	-
11.15	├`.expiration_reason`	`CWE`	Optional	No	-
11.16	├`.temporary_indicator`	`ID`	Optional	No	-
11.17	├`.bad_address_indicator`	`ID`	Optional	No	-
11.18	├`.address_usage`	`ID`	Optional	No	-
11.19	├`.addressee`	`ST`	Optional	No	-
11.20	├`.comment`	`ST`	Optional	No	-
11.21	├`.preference_order`	`NM`	Optional	No	-
11.22	├`.protection_code`	`CWE`	Optional	No	-
11.23	└`.address_identifier`	`EI`	Optional	No	-
12	▶`provider_organization_location_information`	`PL`	Optional	Yes	-
12.1	├`.point_of_care`	`HD`	Optional	No	-
12.2	├`.room`	`HD`	Optional	No	-
12.3	├`.bed`	`HD`	Optional	No	-
12.4	├`.facility`	`HD`	Optional	No	-
12.5	├`.location_status`	`IS`	Optional	No	-
12.6	├`.person_location_type`	`IS`	Optional	No	-
12.7	├`.building`	`IS`	Optional	No	-
12.8	├`.floor`	`IS`	Optional	No	-
12.9	├`.location_description`	`ST`	Optional	No	-
12.10	├`.comprehensive_location_identifier`	`EI`	Optional	No	-
12.11	└`.assigning_authority_for_location`	`HD`	Optional	No	-
13	▶`provider_organization_communication_information`	`XTN`	Optional	Yes	-
13.1	├`.telephone_number`	`ST`	Optional	No	-
13.2	├`.telecommunication_use_code`	`ID`	Optional	No	-
13.3	├`.telecommunication_equipment_type`	`ID`	Optional	No	-
13.4	├`.communication_address`	`ST`	Optional	No	-
13.5	├`.country_code`	`SNM`	Optional	No	-
13.6	├`.area_city_code`	`SNM`	Optional	No	-
13.7	├`.local_number`	`SNM`	Optional	No	-
13.8	├`.extension`	`SNM`	Optional	No	-
13.9	├`.any_text`	`ST`	Optional	No	-
13.10	├`.extension_prefix`	`ST`	Optional	No	-
13.11	├`.speed_dial_code`	`ST`	Optional	No	-
13.12	├`.unformatted_telephone_number`	`ST`	Optional	No	-
13.13	├`.effective_start_date`	`DTM`	Optional	No	-
13.14	├`.expiration_date`	`DTM`	Optional	No	-
13.15	├`.expiration_reason`	`CWE`	Optional	No	-
13.16	├`.protection_code`	`CWE`	Optional	No	-
13.17	├`.shared_telecommunication_identifier`	`EI`	Optional	No	-
13.18	└`.preference_order`	`NM`	Optional	No	-
14	▶`provider_organization_method_of_contact`	`CWE`	Optional	No	`HL70185`
14.1	├`.identifier`	`ST`	Optional	No	-
14.2	├`.text`	`ST`	Optional	No	-
14.3	├`.name_of_coding_system`	`ID`	Optional	No	-
14.4	├`.alternate_identifier`	`ST`	Optional	No	-
14.5	├`.alternate_text`	`ST`	Optional	No	-
14.6	├`.name_of_alternate_coding_system`	`ID`	Optional	No	-
14.7	├`.coding_system_version_id`	`ST`	Optional	No	-
14.8	├`.alternate_coding_system_version_id`	`ST`	Optional	No	-
14.9	├`.original_text`	`ST`	Optional	No	-
14.10	├`.second_alternate_identifier`	`ST`	Optional	No	-
14.11	├`.second_alternate_text`	`ST`	Optional	No	-
14.12	├`.name_of_second_alternate_coding_system`	`ID`	Optional	No	-
14.13	├`.second_alternate_coding_system_version_id`	`ST`	Optional	No	-
14.14	├`.coding_system_oid`	`ST`	Optional	No	-
14.15	├`.value_set_oid`	`ST`	Optional	No	-
14.16	├`.value_set_version_id`	`DTM`	Optional	No	-
14.17	├`.alternate_coding_system_oid`	`ST`	Optional	No	-
14.18	├`.alternate_value_set_oid`	`ST`	Optional	No	-
14.19	├`.alternate_value_set_version_id`	`DTM`	Optional	No	-
14.20	├`.second_alternate_coding_system_oid`	`ST`	Optional	No	-
14.21	├`.second_alternate_value_set_oid`	`ST`	Optional	No	-
14.22	└`.second_alternate_value_set_version_id`	`DTM`	Optional	No	-

Ready to build integrations?

Get started with Zato and connect your systems in minutes.

Get started ▶Read the docs

Open source In Python