v2.1 Messages

class hl7types.hl7.v2_1.messages.ACK.ACK

HL7 v2 ACK message.

ACK

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

MSA

MSA

required

MSA: Required

ERR

Optional[ERR]

optional

ERR: Optional

class hl7types.hl7.v2_1.messages.ADR_A19.ADR_A19

HL7 v2 ADR_A19 message.

ADR_A19

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

MSA

MSA

required

MSA: Required

QRD

QRD

required

QRD: Required

QUERY_RESPONSE

List[ADR_A19_QUERY_RESPONSE]

required

QUERY_RESPONSE: Required, repeating

DSC

Optional[DSC]

optional

DSC: Optional

class hl7types.hl7.v2_1.messages.ADT_A01.ADT_A01

HL7 v2 ADT_A01 message.

ADT_A01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

NK1

NK1

required

NK1: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A02.ADT_A02

HL7 v2 ADT_A02 message.

ADT_A02

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A03.ADT_A03

HL7 v2 ADT_A03 message.

ADT_A03

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A04.ADT_A04

HL7 v2 ADT_A04 message.

ADT_A04

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

NK1

NK1

required

NK1: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A05.ADT_A05

HL7 v2 ADT_A05 message.

ADT_A05

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

NK1

NK1

required

NK1: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A06.ADT_A06

HL7 v2 ADT_A06 message.

ADT_A06

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A07.ADT_A07

HL7 v2 ADT_A07 message.

ADT_A07

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A08.ADT_A08

HL7 v2 ADT_A08 message.

ADT_A08

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

NK1

NK1

required

NK1: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A09.ADT_A09

HL7 v2 ADT_A09 message.

ADT_A09

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A10.ADT_A10

HL7 v2 ADT_A10 message.

ADT_A10

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A11.ADT_A11

HL7 v2 ADT_A11 message.

ADT_A11

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A12.ADT_A12

HL7 v2 ADT_A12 message.

ADT_A12

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A13.ADT_A13

HL7 v2 ADT_A13 message.

ADT_A13

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A14.ADT_A14

HL7 v2 ADT_A14 message.

ADT_A14

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

NK1

NK1

required

NK1: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A15.ADT_A15

HL7 v2 ADT_A15 message.

ADT_A15

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A16.ADT_A16

HL7 v2 ADT_A16 message.

ADT_A16

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

DG1

Optional[DG1]

optional

DG1: Optional

class hl7types.hl7.v2_1.messages.ADT_A17.ADT_A17

HL7 v2 ADT_A17 message.

ADT_A17

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PATIENT

List[ADT_A17_PATIENT]

required

PATIENT: Required, repeating

class hl7types.hl7.v2_1.messages.ADT_A18.ADT_A18

HL7 v2 ADT_A18 message.

ADT_A18

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

MRG

MRG

required

MRG: Required

PV1

Optional[PV1]

optional

PV1: Optional

class hl7types.hl7.v2_1.messages.ADT_A20.ADT_A20

HL7 v2 ADT_A20 message.

ADT_A20

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

NPU

NPU

required

NPU: Required

class hl7types.hl7.v2_1.messages.ADT_A21.ADT_A21

HL7 v2 ADT_A21 message.

ADT_A21

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A22.ADT_A22

HL7 v2 ADT_A22 message.

ADT_A22

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A23.ADT_A23

HL7 v2 ADT_A23 message.

ADT_A23

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.ADT_A24.ADT_A24

HL7 v2 ADT_A24 message.

ADT_A24

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

PV1

required

PV1: Required

class hl7types.hl7.v2_1.messages.BAR_P01.BAR_P01

HL7 v2 BAR_P01 message.

BAR_P01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

VISIT

List[BAR_P01_VISIT]

required

VISIT: Required, repeating

class hl7types.hl7.v2_1.messages.BAR_P02.BAR_P02

HL7 v2 BAR_P02 message.

BAR_P02

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PATIENT

List[BAR_P02_PATIENT]

required

PATIENT: Required, repeating

class hl7types.hl7.v2_1.messages.DFT_P03.DFT_P03

HL7 v2 DFT_P03 message.

DFT_P03

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

EVN

EVN

required

EVN: Required

PID

PID

required

PID: Required

PV1

Optional[PV1]

optional

PV1: Optional

FT1

Optional[List[FT1]]

optional

FT1: Optional, repeating

class hl7types.hl7.v2_1.messages.DSR_Q01.DSR_Q01

HL7 v2 DSR_Q01 message.

DSR_Q01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

MSA

MSA

required

MSA: Required

QRD

QRD

required

QRD: Required

QRF

Optional[QRF]

optional

QRF: Optional

DSP

List[DSP]

required

DSP: Required, repeating

DSC

DSC

required

DSC: Required

class hl7types.hl7.v2_1.messages.DSR_Q03.DSR_Q03

HL7 v2 DSR_Q03 message.

DSR_Q03

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

QRD

QRD

required

QRD: Required

QRF

Optional[QRF]

optional

QRF: Optional

DSP

List[DSP]

required

DSP: Required, repeating

DSC

DSC

required

DSC: Required

class hl7types.hl7.v2_1.messages.MCF_Q02.MCF_Q02

HL7 v2 MCF_Q02 message.

MCF_Q02

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

MSA

MSA

required

MSA: Required

class hl7types.hl7.v2_1.messages.ORM_O01.ORM_O01

HL7 v2 ORM_O01 message.

ORM_O01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

NTE

Optional[List[NTE]]

optional

NTE: Optional, repeating

PATIENT

Optional[ORM_O01_PATIENT]

optional

PATIENT: Optional

ORDER

List[ORM_O01_ORDER]

required

ORDER: Required, repeating

class hl7types.hl7.v2_1.messages.ORR_O02.ORR_O02

HL7 v2 ORR_O02 message.

ORR_O02

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

MSA

MSA

required

MSA: Required

NTE

Optional[List[NTE]]

optional

NTE: Optional, repeating

PATIENT

Optional[ORR_O02_PATIENT]

optional

PATIENT: Optional

class hl7types.hl7.v2_1.messages.ORU_R01.ORU_R01

HL7 v2 ORU_R01 message.

ORU_R01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

PATIENT_RESULT

List[ORU_R01_PATIENT_RESULT]

required

PATIENT_RESULT: Required, repeating

DSC

Optional[DSC]

optional

DSC: Optional

class hl7types.hl7.v2_1.messages.ORU_R03.ORU_R03

HL7 v2 ORU_R03 message.

ORU_R03

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

PATIENT_RESULT

List[ORU_R03_PATIENT_RESULT]

required

PATIENT_RESULT: Required, repeating

DSC

Optional[DSC]

optional

DSC: Optional

class hl7types.hl7.v2_1.messages.QRY_A19.QRY_A19

HL7 v2 QRY_A19 message.

QRY_A19

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

QRD

QRD

required

QRD: Required

class hl7types.hl7.v2_1.messages.QRY_Q01.QRY_Q01

HL7 v2 QRY_Q01 message.

QRY_Q01

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

QRD

QRD

required

QRD: Required

QRF

Optional[QRF]

optional

QRF: Optional

DSC

DSC

required

DSC: Required

class hl7types.hl7.v2_1.messages.QRY_Q02.QRY_Q02

HL7 v2 QRY_Q02 message.

QRY_Q02

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

QRD

QRD

required

QRD: Required

QRF

Optional[QRF]

optional

QRF: Optional

DSC

DSC

required

DSC: Required

class hl7types.hl7.v2_1.messages.UDM_Q05.UDM_Q05

HL7 v2 UDM_Q05 message.

UDM_Q05

Field

HL7

Type

Required

Max Length

Description

MSH

MSH

required

MSH: Required

URD

URD

required

URD: Required

URS

Optional[URS]

optional

URS: Optional

DSP

List[DSP]

required

DSP: Required, repeating

DSC

DSC

required

DSC: Required