VXRV03 Vaccination record response (2.6)

This is the standard HL7 v2.6 spec, with 5 loops and 22 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…
The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (200 KB) Generate classes
The ediFabric .NET template, class TSVXRV03. It needs the common segments, composites and codes of HL7 v2.6, one download for every transaction in the version. Download C# (1 KB) Common files (99 KB)
The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and HL7 is coming. Download Native (1 KB)

Use the VXRV03 spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read VXRV03 files into TSVXRV03 objects. See ediFabric .NET.

ediFabric Native

Native supports X12 today, and HL7 is coming. When it's available, map version 2.6 to this Native model with set_map to parse VXRV03 files to JSON from Python, Java, C or C#. See ediFabric Native.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate VXRV03 classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each VXRV03 as JSON. To work with VXRV03 data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSVXRV03. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

VXRV03 structure

Loops and segments of the standard VXRV03, with their usage and maximum repeats.

IDNameUsageMax use
MSHMessage HeaderMandatory1
MSAMessage AcknowledgmentMandatory1
SFTSoftware SegmentOptional>1
UACUser Authentication Credential SegmentOptional1
QRDOriginal Style Query DefinitionMandatory1
QRFOriginal Style Query FilterOptional1
PIDPatient IdentificationMandatory1
PD1Patient Additional DemographicOptional1
NK1Next Of Kin Associated PartiesOptional>1
Loop PV1Patient VisitOptional1
PV1Patient VisitMandatory1
PV2Patient Visit Additional InformationOptional1
GT1GuarantorOptional>1
Loop IN1InsuranceOptional>1
IN1InsuranceMandatory1
IN2Insurance Additional InformationOptional1
IN3Insurance Additional Information CertificationOptional1
Loop ORCCommon OrderOptional>1
ORCCommon OrderMandatory1
Loop TQ1Timing QuantityOptional>1
TQ1Timing QuantityMandatory1
TQ2Timing Quantity RelationshipOptional>1
RXAPharmacy Treatment AdministrationMandatory1
RXRPharmacy Treatment RouteOptional1
Loop OBXObservation ResultOptional>1
OBXObservation ResultMandatory1
NTENotes And CommentsOptional>1