Skip to main content
Version: v0.1.10

src/hl7

@cosyte/synth/hl7: the HL7 v2 generation surface, exposed as its own subpath so importing the package root does not pull @cosyte/hl7. This is the lazy, per-format boundary: a consumer who only needs HL7 fixtures imports @cosyte/synth/hl7; one who needs only the core primitives never loads a parser. @cosyte/hl7 is an optional peer dependency, present only for this subpath.

The HL7 v2 message set: ADT (A01, A02, A03, A04, A08, A11, A13, A28, A31), ORU^R01, ORM^O01, SIU^S12, VXU^V04, MDM^T02, DFT^P03, OML^O21, and an ACK for any of them, each built through @cosyte/hl7's buildMessage, stamped HL7 v2.5, and round-tripping with zero warnings.

Interfaces​

AnimalIdentity​

A complete synthetic animal patient: every value drawn from ../safe.

Properties​

breed​

readonly breed: AnimalCode

The breed, one of the species' breeds.

dob​

readonly dob: string

Birth date (YYYYMMDD), 0 to 20 years before the message date.

microchip​

readonly microchip: string

A 15-digit microchip that begins 999.

owner​

readonly owner: AnimalOwner

The owner.

petName​

readonly petName: string

The pet's name, from the shipped fake pet-name pool.

record​

readonly record: SyntheticIdentifier

The record number, scoped to the synthetic assigning authority.

sex​

readonly sex: "M" | "F"

Administrative sex.

species​

readonly species: AnimalCode

The species, from our own short list.

AnimalOwner​

An animal's owner: every value drawn from ../safe.

Properties​

address​

readonly address: SyntheticAddress

The owner's synthetic postal address (reserved non-real ZIP), which is also the animal's.

person​

readonly person: SyntheticName

The owner's name, from the shipped fake-name pool.

phone​

readonly phone: string

The owner's reserved 555-01xx phone number.

ExampleCode​

A coded concept: an identifier code, human-readable text, and its code system (HL7 CE/CWE).

Properties​

code​

readonly code: string

The code value (component 1).

system​

readonly system: string

The coding-system id (component 3), e.g. "LN" (LOINC) or "CVX".

text​

readonly text: string

The human-readable display text (component 2).

units?​

readonly optional units?: string

Reporting units (UCUM), where the concept is a measured quantity.

GenerateAckOptions​

Options for generateAck.

Properties​

code?​

readonly optional code?: Hl7AckCode

The acknowledgment code in MSA-1. Defaults to "AA".

inbound?​

readonly optional inbound?: Hl7Message

The message being acknowledged. Defaults to the ADT^A01 generateAdt makes from the same seed. It must carry an MSH-10 message control id.

seed?​

readonly optional seed?: number

The seed: the same seed and inbound message yield a byte-identical ACK. Defaults to 0.

GenerateAdtOptions​

Options for generateAdt.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

subject?​

readonly optional subject?: Hl7Subject

Who the message is about. Defaults to "person", whose bytes for a seed are what they always were. "animal" writes a veterinary patient: the pet's name in PID-5, a microchip in PID-3, the species in PID-35 and breed in PID-36, and the owner in an NK1 after the PID.

trigger?​

readonly optional trigger?: AdtTrigger

The ADT trigger event. Defaults to "A01".

GenerateDftOptions​

Options for generateDft.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

GenerateHl7QuirkOptions​

Options for generateHl7Quirk.

Properties​

kind?​

readonly optional kind?: Hl7QuirkKind

The spec-clean base message family. Defaults to "ORU^R01".

quirk​

readonly quirk: Hl7QuirkName

The quirk to inject. Required.

seed?​

readonly optional seed?: number

The seed: the same seed + quirk yields a byte-identical message. Defaults to 0.

GenerateMdmOptions​

Options for generateMdm.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

GenerateOmlOptions​

Options for generateOml.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

GenerateOrmOptions​

Options for generateOrm.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

GenerateOruOptions​

Options for generateOru.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

subject?​

readonly optional subject?: Hl7Subject

Who the result is about. Defaults to "person", whose bytes for a seed are what they always were. "animal" writes a veterinary patient: the pet's name in PID-5, a microchip in PID-3, the species in PID-35 and breed in PID-36, and the owner in an NK1 after the PID.

GenerateSiuOptions​

Options for generateSiu.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

GenerateVxuOptions​

Options for generateVxu.

Properties​

seed?​

readonly optional seed?: number

The seed: the same seed yields a byte-identical message. Defaults to 0.

Hl7CorpusOptions​

Options for hl7Corpus.

Properties​

count?​

readonly optional count?: number

How many messages to generate. Defaults to 1.

mix?​

readonly optional mix?: readonly Hl7MessageKind[]

The message kinds to cycle through, any of HL7_MESSAGE_KINDS. Defaults to one each of the first seven kinds (ADT^A01/A04/A08, ORU^R01, ORM^O01, SIU^S12, VXU^V04), so a seed's default corpus is unchanged as kinds are added. An empty list throws SYNTH_EMPTY_POOL.

seed​

readonly seed: number

The seed for the whole corpus (deterministic).

triggers?​

readonly optional triggers?: readonly AdtTrigger[]

ADT-only convenience: the triggers to cycle through, kept for back-compat. When supplied it takes precedence over mix and restricts the corpus to ADT messages. An empty list throws SYNTH_EMPTY_POOL.

verify?​

readonly optional verify?: boolean

Whether each artifact is read back through its parser and the parser's findings recorded as its warnings. Defaults to true. false skips the read, a large share of a corpus's time; every artifact's warnings is then empty without having been checked.

Hl7QuirkCorpusOptions​

Options for hl7QuirkCorpus.

Properties​

count?​

readonly optional count?: number

How many quirk artifacts to generate. Defaults to the number of quirks.

kind?​

readonly optional kind?: Hl7QuirkKind

The base message family each quirk is injected into. Defaults to "ORU^R01".

profile?​

readonly optional profile?: SynthProfile

A SynthProfile whose quirks drive the corpus (validated). Its quirks, when set, take precedence over quirks; a profile that leaves quirks out leaves the selection to quirks.

quirks?​

readonly optional quirks?: readonly Hl7QuirkName[]

The quirk names to cycle through. Defaults to every HL7 quirk. Validated; unsupported ⇒ fatal. An empty list, or a profile whose quirks is an empty list, throws SYNTH_EMPTY_POOL.

seed​

readonly seed: number

The seed for the whole corpus (deterministic).

MessageScaffold​

The MSH scaffold shared by every generated message: the built message plus its seeded MSH values.

Properties​

controlId​

readonly controlId: string

The seeded message control id (MSH-10).

message​

readonly message: Hl7Message

The Hl7Message with a complete MSH: chain .addSegment(...) to append the payload.

timestamp​

readonly timestamp: string

The seeded YYYYMMDDHHMMSS message timestamp (MSH-7), reused for event/observation times.

PatientIdentity​

A complete synthetic patient identity: every field drawn from ../safe.

Properties​

address​

readonly address: SyntheticAddress

Synthetic postal address (reserved non-real ZIP).

dob​

readonly dob: string

Date of birth (YYYYMMDD) from the seeded generator.

mrn​

readonly mrn: SyntheticIdentifier

Medical-record identifier scoped to the synthetic assigning authority.

person​

readonly person: SyntheticName

Name from the shipped fake-name pool.

phone​

readonly phone: string

Reserved 555-01xx phone number.

sex​

readonly sex: "M" | "F"

Administrative sex.

ssnDigits​

readonly ssnDigits: string

Never-issued SSN as 9 digits (no dashes), for PID-19.

RoundTripResult​

The verdict of one round-trip through @cosyte/hl7.

Properties​

byteStable​

readonly byteStable: boolean

Whether re-serializing the re-parsed message is byte-identical to content.

content​

readonly content: string

The serialized wire text (the parser's own conservative emit).

specClean​

readonly specClean: boolean

true iff the artifact is spec-clean: zero warnings and byte-stable.

warnings​

readonly warnings: readonly string[]

The warning codes the parser emitted on re-parse. Empty ⇒ spec-clean.

Type Aliases​

AdtTrigger​

AdtTrigger = "A01" | "A04" | "A08" | "A02" | "A03" | "A11" | "A13" | "A28" | "A31"

The ADT trigger events this generator produces (all require the EVN, PID and PV1 segments).

Hl7AckCode​

Hl7AckCode = "AA" | "AE" | "AR"

An original-mode acknowledgment code (HL7 table 0008, MSA-1): AA application accept, AE application error, AR application reject.

Hl7MessageKind​

Hl7MessageKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04" | "ACK" | "ADT^A02" | "ADT^A03" | "ADT^A11" | "ADT^A13" | "ADT^A28" | "ADT^A31" | "MDM^T02" | "DFT^P03" | "OML^O21"

Every HL7 v2 message kind this subpath generates: the MSH-9 label used as the corpus kind. ADT carries its trigger; the other families have a single generated trigger each. ACK acknowledges an ADT^A01 generated from the same seed (see generateAck to acknowledge any message).

Hl7QuirkKind​

Hl7QuirkKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04"

The HL7 v2 message families a quirk can be injected into (the spec-clean base).

Hl7QuirkName​

Hl7QuirkName = "unknown-zsegment" | "unknown-escape"

Every HL7 v2 quirk this package ships.

Hl7Subject​

Hl7Subject = "person" | "animal"

Who a message is about. "person", the default, is the human patient every generator has always written. "animal" writes a veterinary patient instead: see AnimalIdentity.

Variables​

EXAMPLE_LAB_OBSERVATIONS​

const EXAMPLE_LAB_OBSERVATIONS: readonly ExampleCode[]

A handful of common LOINC laboratory-observation example codes (for OBX). Public LOINC identifiers used purely as illustrative structural fillers.

EXAMPLE_ORDER_SERVICES​

const EXAMPLE_ORDER_SERVICES: readonly ExampleCode[]

A handful of LOINC panel/service example codes (for the OBR/ORC universal service id). Public identifiers used as structural fillers.

EXAMPLE_VACCINES​

const EXAMPLE_VACCINES: readonly ExampleCode[]

A handful of CDC CVX vaccine example codes (for RXA-5). Public CVX identifiers used as structural fillers; @cosyte/synth bundles no vaccine terminology.

HL7_MESSAGE_KINDS​

const HL7_MESSAGE_KINDS: readonly Hl7MessageKind[]

Every kind generateHl7 and hl7Corpus accept, in a fixed order: the first seven kinds, then each kind added since. Pass it as a corpus mix to cycle through all of them.

Example​

import { HL7_MESSAGE_KINDS, hl7Corpus } from "@cosyte/synth/hl7";
hl7Corpus({ seed: 1, count: HL7_MESSAGE_KINDS.length, mix: HL7_MESSAGE_KINDS });

HL7_QUIRKS​

const HL7_QUIRKS: Readonly<Record<Hl7QuirkName, QuirkDescriptor>>

The HL7 v2 quirk registry: each recipe bound to the exact @cosyte/hl7 warning code it targets and its public grounding.

hl7QuirkProfile​

const hl7QuirkProfile: SynthProfile

A ready-made SynthProfile that requests every built-in HL7 quirk: a convenience for wiring defineSynthProfile's quirk list to the parser's real tolerance.

Example​

import { hl7QuirkProfile, hl7QuirkCorpus } from "@cosyte/synth/hl7";
hl7QuirkCorpus({ seed: 1, profile: hl7QuirkProfile });

MICROCHIP_IDENTIFIER_TYPE​

const MICROCHIP_IDENTIFIER_TYPE: "MCN" = "MCN"

The identifier type the animal subject writes for a microchip in PID-3 (CX.5): MCN, which we use for microchip number. We have not verified it against HL7 table 0203 (identifier type) in any version. Not verified.

OWNER_RELATIONSHIP​

const OWNER_RELATIONSHIP: Readonly<{ code: "OWN"; system: "HL70063"; text: "Owner"; }>

The owner relationship the animal subject writes in NK1-3: OWN^Owner^HL70063. We have not verified that OWN is a value of HL7 table 0063 (relationship). Not verified.

Functions​

animalIdentity()​

animalIdentity(rng, onDate): AnimalIdentity

Mint a complete synthetic AnimalIdentity. The draw order is fixed (owner name, pet name, record number, microchip, species and breed, birth date, sex, address, phone) so the same seed and date yield the same animal.

Parameters​

rng​

Rng

The seeded generator.

onDate​

string

The message date, YYYYMMDD or a longer timestamp: the birth date falls from 0 to 20 years before it.

Returns​

AnimalIdentity

A synthetic AnimalIdentity.

Example​

import { createRng } from "@cosyte/synth";
import { animalIdentity } from "@cosyte/synth/hl7";
const pet = animalIdentity(createRng(1), "20250101");
pet.species.text; // e.g. "Dog"

animalPidSegment()​

animalPidSegment(id): readonly (string | RawField)[]

Lay out the PID segment of an AnimalIdentity: the record number and the microchip as two PID-3 repetitions, the owner's family name and the pet's name in PID-5, the owner's address and phone, and the species in PID-35 and breed in PID-36. PID-19 (SSN) stays empty.

Parameters​

id​

AnimalIdentity

The synthetic animal to render.

Returns​

readonly (string | RawField)[]

The PID field list for Hl7Message.addSegment("PID", …).

Example​

// msg.addSegment("PID", animalPidSegment(animalIdentity(createRng(1), "20250101")));

componentsField()​

componentsField(components): RawField

Build a RawField from a flat list of component strings (single repetition, single subcomponent per component). Empty strings become empty components (absent at the wire level).

Parameters​

components​

readonly string[]

The component values, in HL7 component order.

Returns​

RawField

A RawField the hl7 serializer lays out with ^ separators.

Example​

import { componentsField } from "@cosyte/synth/hl7";
componentsField(["Testerson", "Quilliam"]); // family^given

generateAck()​

generateAck(options?): Hl7Message

Generate a spec-clean ACK Hl7Message answering inbound. Deterministic in seed and inbound.

  • MSH: the inbound receiver (MSH-5, MSH-6) becomes the sender (MSH-3, MSH-4) and the inbound sender the receiver. MSH-7 is one to fifty-nine seconds after the inbound MSH-7, or a seeded time when that is not a full YYYYMMDDHHMMSS. MSH-9 is ACK^<inbound trigger>^ACK, or ACK when the inbound names no trigger. MSH-10 is a seeded SYNTHACK control id. MSH-11 is always T, test data, whatever the inbound says. MSH-12 echoes the inbound version, 2.5 when it names none.
  • MSA: MSA-1 is code, MSA-2 the inbound MSH-10.
  • ERR, for AE and AR only: ERR-3 is condition 207, application internal error (HL7 table 0357), and ERR-4 severity E, error.

Parameters​

options?​

GenerateAckOptions = {}

Seed, inbound message and code. See GenerateAckOptions.

Returns​

Hl7Message

A spec-clean ACK Hl7Message.

Throws​

SynthError SYNTH_ACK_UNCORRELATED when the inbound message has no MSH-10, and SYNTH_UNSUPPORTED_KIND when code is not AA, AE or AR.

Example​

import { generateAck, generateOru } from "@cosyte/synth/hl7";
const ack = generateAck({ seed: 7, inbound: generateOru({ seed: 7 }) });
console.log(ack.toString()); // MSH|...|ACK^R01^ACK|SYNTHACK...|T|2.5 then MSA|AA|SYNTH...

generateAdt()​

generateAdt(options?): Hl7Message

Generate a spec-clean ADT Hl7Message through @cosyte/hl7. Deterministic in seed.

The message carries a complete MSH (seeded control id + timestamp, so the bytes are reproducible), EVN, a fully-populated PID (identity from the synthetic providers), and PV1 (the visit group), so it parses back through @cosyte/hl7 with zero warnings (proven by ./round-trip). A trigger added after A01, A04 and A08 also names its published structure in MSH-9.3 and fills the PV1 fields its event is about (a transfer's prior location, a discharge's times).

With subject: "animal" the patient is an animal and its owner follows the PID in an NK1.

Parameters​

options?​

GenerateAdtOptions = {}

Seed, trigger and subject. See GenerateAdtOptions.

Returns​

Hl7Message

A spec-clean ADT Hl7Message.

Example​

import { generateAdt } from "@cosyte/synth/hl7";
const msg = generateAdt({ seed: 12345, trigger: "A01" });
console.log(msg.toString());

generateDft()​

generateDft(options?): Hl7Message

Generate a spec-clean DFT^P03 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH (DFT^P03^DFT_P03), EVN, PID (synthetic identity), PV1, and one FT1: a SYNTHTXN transaction id, the transaction date, type CG (charge, HL7 table 0017), a local SYNTHCHG charge code and a quantity of one to three.

Parameters​

options?​

GenerateDftOptions = {}

Seed. See GenerateDftOptions.

Returns​

Hl7Message

A spec-clean DFT^P03 Hl7Message.

Example​

import { generateDft } from "@cosyte/synth/hl7";
const msg = generateDft({ seed: 12345 });
console.log(msg.toString());

generateHl7()​

generateHl7(kind, seed): Hl7Message

Generate one message of the given Hl7MessageKind from a seed, dispatching to the right family generator. Every kind builds through @cosyte/hl7 and is deterministic in seed.

Parameters​

kind​

Hl7MessageKind

The message kind to generate.

seed​

number

The seed.

Returns​

Hl7Message

The generated Hl7Message.

Example​

import { generateHl7 } from "@cosyte/synth/hl7";
generateHl7("ORU^R01", 42).toString();

generateHl7Quirk()​

generateHl7Quirk(options): QuirkArtifact

Generate one HL7 v2 quirk artifact: a spec-clean message (built through @cosyte/hl7) with the requested vendor deviation injected post-serialize. Deterministic in seed + quirk + kind.

Parameters​

options​

GenerateHl7QuirkOptions

Seed, quirk, and base kind. See GenerateHl7QuirkOptions.

Returns​

QuirkArtifact

The QuirkArtifact: its content round-trips to intendedWarnings exactly.

Throws​

SynthError SYNTH_UNSUPPORTED_QUIRK if quirk is not a supported HL7 quirk.

Example​

import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
const artifact = generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" });
hl7QuirkRoundTrip(artifact).intendedWarningHeld; // true, exactly UNKNOWN_SEGMENT

generateMdm()​

generateMdm(options?): Hl7Message

Generate a spec-clean MDM^T02 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH (MDM^T02^MDM_T02), EVN, PID (synthetic identity), PV1, TXA (document type from HL7 table 0270, content presentation TX, a SYNTHDOC unique document number, completion status DO, documented) and one to three OBX lines of TX text, each final (F).

Parameters​

options?​

GenerateMdmOptions = {}

Seed. See GenerateMdmOptions.

Returns​

Hl7Message

A spec-clean MDM^T02 Hl7Message.

Example​

import { generateMdm } from "@cosyte/synth/hl7";
const msg = generateMdm({ seed: 12345 });
console.log(msg.toString());

generateOml()​

generateOml(options?): Hl7Message

Generate a spec-clean OML^O21 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH (OML^O21^OML_O21), PID (synthetic identity), ORC (order control NW, a new order) and an OBR carrying the same placer and filler numbers and a laboratory service.

Parameters​

options?​

GenerateOmlOptions = {}

Seed. See GenerateOmlOptions.

Returns​

Hl7Message

A spec-clean OML^O21 Hl7Message.

Example​

import { generateOml } from "@cosyte/synth/hl7";
const msg = generateOml({ seed: 12345 });
console.log(msg.toString());

generateOrm()​

generateOrm(options?): Hl7Message

Generate a spec-clean ORM^O01 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH, PID (synthetic identity), ORC (common order, control NW, new order), and a matching OBR (order detail). The ORC satisfies the parser's ORM^O01 structure net, so the message re-parses with zero warnings (proven by ./round-trip).

Parameters​

options?​

GenerateOrmOptions = {}

Seed. See GenerateOrmOptions.

Returns​

Hl7Message

A spec-clean ORM^O01 Hl7Message.

Example​

import { generateOrm } from "@cosyte/synth/hl7";
const msg = generateOrm({ seed: 12345 });
console.log(msg.toString());

generateOru()​

generateOru(options?): Hl7Message

Generate a spec-clean ORU^R01 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH, PID (synthetic identity), OBR (order/observation request), and 1 to 3 OBX result rows. The OBR/OBX result group satisfies the parser's ORU^R01 structure net, so the message re-parses with zero warnings (proven by ./round-trip).

With subject: "animal" the patient is an animal and its owner follows the PID in an NK1.

Parameters​

options?​

GenerateOruOptions = {}

Seed and subject. See GenerateOruOptions.

Returns​

Hl7Message

A spec-clean ORU^R01 Hl7Message.

Example​

import { generateOru } from "@cosyte/synth/hl7";
const msg = generateOru({ seed: 12345 });
console.log(msg.toString());

generateSiu()​

generateSiu(options?): Hl7Message

Generate a spec-clean SIU^S12 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH, SCH (schedule activity, the required group), PID (synthetic identity), RGS (resource group), AIL (location resource). The SCH satisfies the parser's SIU^S12 structure net, so the message re-parses with zero warnings (proven by ./round-trip).

Parameters​

options?​

GenerateSiuOptions = {}

Seed. See GenerateSiuOptions.

Returns​

Hl7Message

A spec-clean SIU^S12 Hl7Message.

Example​

import { generateSiu } from "@cosyte/synth/hl7";
const msg = generateSiu({ seed: 12345 });
console.log(msg.toString());

generateVxu()​

generateVxu(options?): Hl7Message

Generate a spec-clean VXU^V04 Hl7Message through @cosyte/hl7. Deterministic in seed.

Layout: MSH, PID (synthetic identity, the required group), ORC (common order), RXA (vaccine administration, CVX example code), RXR (route). The PID satisfies the parser's VXU^V04 structure net, so the message re-parses with zero warnings (proven by ./round-trip).

Parameters​

options?​

GenerateVxuOptions = {}

Seed. See GenerateVxuOptions.

Returns​

Hl7Message

A spec-clean VXU^V04 Hl7Message.

Example​

import { generateVxu } from "@cosyte/synth/hl7";
const msg = generateVxu({ seed: 12345 });
console.log(msg.toString());

hl7Corpus()​

hl7Corpus(options): Corpus

Build a reproducible Corpus of spec-clean HL7 messages across the families. Each message is generated from a distinct sub-seed derived from the corpus seed (so the set is deterministic) and round-tripped through @cosyte/hl7; the per-artifact warnings record the parser's verdict (empty ⇒ spec-clean).

Parameters​

options​

Hl7CorpusOptions

Seed, count, and the message mix. See Hl7CorpusOptions.

Returns​

Corpus

A deep-frozen Corpus.

Example​

import { hl7Corpus } from "@cosyte/synth/hl7";
const corpus = hl7Corpus({ seed: 42, count: 7 });
corpus.artifacts.every((a) => a.warnings.length === 0); // true, spec-clean

hl7QuirkCorpus()​

hl7QuirkCorpus(options): Corpus

Build a reproducible Corpus of HL7 v2 quirk artifacts. Each artifact's warnings record the parser's verdict: the intended code(s) for its quirk (not empty: a quirk corpus is deliberately off-spec), and the manifest lists the applied quirk names.

Parameters​

options​

Hl7QuirkCorpusOptions

Seed, count, and the quirk selection. See Hl7QuirkCorpusOptions.

Returns​

Corpus

A deep-frozen Corpus.

Example​

import { hl7QuirkCorpus } from "@cosyte/synth/hl7";
const corpus = hl7QuirkCorpus({ seed: 42 });
corpus.manifest.quirks; // ["unknown-zsegment", "unknown-escape"]

hl7QuirkRoundTrip()​

hl7QuirkRoundTrip(artifact): QuirkRoundTripResult

Round-trip an HL7 v2 quirk artifact through @cosyte/hl7 and report the intended-warning verdict: a bare parse must produce exactly the intended code(s), and, when a built-in public profile tolerates the quirk, the profiled parse must suppress it.

Parameters​

artifact​

QuirkArtifact

The quirk artifact (from generateHl7Quirk).

Returns​

QuirkRoundTripResult

The QuirkRoundTripResult.

Example​

import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
const rt = hl7QuirkRoundTrip(generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" }));
rt.withProfile?.tolerated; // true, the `visage` profile suppresses UNKNOWN_SEGMENT

mshScaffold()​

mshScaffold(rng, type): MessageScaffold

Build the MSH scaffold for a message of the given MSH-9 type through @cosyte/hl7's buildMessage, so the delimiters, control id, and header layout are the parser's own conservative emit. Draws the timestamp then the control id from rng (a fixed order: the reproducibility contract).

Parameters​

rng​

Rng

The seeded generator.

type​

string

The MSH-9 message type, e.g. "ORU^R01".

Returns​

MessageScaffold

The MessageScaffold.

Example​

import { createRng } from "@cosyte/synth";
// mshScaffold(createRng(1), "ORU^R01").message.addSegment("PID", […]);

ownerNk1Segment()​

ownerNk1Segment(id): readonly (string | RawField)[]

Lay out the owner's NK1 segment: the owner's name, relationship OWNER_RELATIONSHIP (OWN, not verified against HL7 table 0063), address and phone.

Parameters​

id​

AnimalIdentity

The synthetic animal whose owner to render.

Returns​

readonly (string | RawField)[]

The NK1 field list for Hl7Message.addSegment("NK1", …).

Example​

// msg.addSegment("NK1", ownerNk1Segment(animalIdentity(createRng(1), "20250101")));

patientIdentity()​

patientIdentity(rng): PatientIdentity

Mint a complete synthetic PatientIdentity. Every value comes from a synthetic-safety provider, so no code path here can return a real or plausibly-real identifier. The draw order is fixed (name → MRN → DOB → sex → address → phone → SSN) so the same seed yields the same identity.

Parameters​

rng​

Rng

The seeded generator.

Returns​

PatientIdentity

A synthetic PatientIdentity.

Example​

import { createRng } from "@cosyte/synth";
// const id = patientIdentity(createRng(1)); // id.person, id.mrn, …

pidSegment()​

pidSegment(id): readonly (string | RawField)[]

Lay out a fully-populated PID segment from a PatientIdentity as addSegment fields: the PHI-dense segment shared by every family. Components go through componentsField so the parser lays out the ^ separators (building through the parser).

Parameters​

id​

PatientIdentity

The synthetic identity to render.

Returns​

readonly (string | RawField)[]

The PID field list for Hl7Message.addSegment("PID", …).

Example​

// msg.addSegment("PID", pidSegment(patientIdentity(createRng(1))));

roundTrip()​

roundTrip(message): RoundTripResult

Round-trip an @cosyte/hl7 Hl7Message through serialize → parse → serialize and report the verdict. A spec-clean artifact re-parses with zero warnings and re-serializes byte-identically.

Parameters​

message​

Hl7Message

The message to check (typically from generateAdt).

Returns​

RoundTripResult

The RoundTripResult.

Example​

import { generateAdt, roundTrip } from "@cosyte/synth/hl7";
const { specClean, warnings } = roundTrip(generateAdt({ seed: 1 }));
// specClean === true, warnings.length === 0

seededTimestamp()​

seededTimestamp(rng): string

A seeded HL7 YYYYMMDDHHMMSS timestamp (message/event time; recent-year range). Strict HL7 DTM, so @cosyte/hl7 parses it back with no TIMESTAMP_FALLBACK_FORMAT warning.

Parameters​

rng​

Rng

The seeded generator.

Returns​

string

A 14-digit YYYYMMDDHHMMSS timestamp string.

Example​

import { createRng } from "@cosyte/synth";
// "20230714…"