OULR24 Unsolicited Order Oriented Observation Message (2.6)

This is the standard HL7 v2.6 spec, with 7 loops and 27 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 (208 KB) Generate classes
The ediFabric .NET template, class TSOULR24. 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 OULR24 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 OULR24 files into TSOULR24 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 OULR24 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 OULR24 classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each OULR24 as JSON. To work with OULR24 data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSOULR24. 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.

OULR24 structure

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

IDNameUsageMax use
MSHMessage HeaderMandatory1
SFTSoftware SegmentOptional>1
UACUser Authentication Credential SegmentOptional1
NTENotes And CommentsOptional1
Loop PIDPatient IdentificationOptional1
PIDPatient IdentificationMandatory1
PD1Patient Additional DemographicOptional1
NTENotes And CommentsOptional>1
OBXObservation ResultOptional>1
Loop PV1Patient VisitOptional1
PV1Patient VisitMandatory1
PV2Patient Visit Additional InformationOptional1
NK1Next Of Kin Associated PartiesOptional>1
Loop OBRObservation RequestMandatory>1
OBRObservation RequestMandatory1
ORCCommon OrderOptional1
NTENotes And CommentsOptional>1
ROLRoleOptional>1
Loop TQ1Timing QuantityOptional>1
TQ1Timing QuantityMandatory1
TQ2Timing Quantity RelationshipOptional>1
Loop SPMSpecimenOptional>1
SPMSpecimenMandatory1
OBXObservation ResultOptional>1
Loop SACSpecimen Container DetailOptional>1
SACSpecimen Container DetailMandatory1
INVInventory DetailOptional1
Loop OBXObservation ResultOptional>1
OBXObservation ResultMandatory1
TCDTest Code DetailOptional1
SIDSubstance IdentifierOptional>1
NTENotes And CommentsOptional>1
CTIClinical Trial IdentificationOptional>1
DSCContinuation PointerOptional1