Skip to main content
Version: v0.1.11

Generate animal patients in HL7 v2

A veterinary system receives the same ADT and ORU messages a hospital does, about an animal and its owner. generateAdt and generateOru write one when you pass subject: "animal". Leave subject out, or pass "person", and a seed gives the same bytes it always has.

Generate one message​

import { parseHL7 } from "@cosyte/hl7";
import { generateAdt, generateOru, roundTrip } from "@cosyte/synth/hl7";

const admit = generateAdt({ seed: 42, trigger: "A01", subject: "animal" });
const result = generateOru({ seed: 7, subject: "animal" });

const pid = parseHL7(admit.toString());
// The pet's name, read and asserted, never logged; the value is synthetic.
pid.get("PID.5.2"); // => "Seedpup"
pid.get("PID.35.2"); // => "Horse"
pid.get("PID.36.2"); // => "Thoroughbred"
pid.get("NK1.3.1"); // => "OWN"

roundTrip(result).specClean; // => true

Every ADT trigger takes subject. Any other value throws a SynthError with the code SYNTH_UNSUPPORTED_KIND.

What a run writes​

generateAdt({ seed: 42, subject: "animal" }) writes this message (one segment a line here; the wire separates them with a carriage return):

MSH|^~\&|COSYTE-SYNTH|SYNTH-FAC|RECEIVER|RECV-FAC|20220627005325||ADT^A01|SYNTH3269244188|T|2.5
EVN|A01|20220627005325
PID|1||38781325^^^COSYTE-SYNTH^MR~999817111682964^^^COSYTE-SYNTH^MCN||Examplewood^Seedpup||20071226|F|||7927 Example Boulevard^^Exampleburg^ND^00000||(441) 555-0193||||||||||||||||||||||HORSE^Horse^99COSYTE|HRS-TB^Thoroughbred^99COSYTE
NK1|1|Examplewood^Mocktavia|OWN^Owner^HL70063|7927 Example Boulevard^^Exampleburg^ND^00000|(441) 555-0193
PV1|1|E|SYNTHWARD^902^01
FieldWhat it holds
PID-3the record number (MR), then the microchip with identifier type MCN
PID-5the owner's family name, then the pet's name as the given name
PID-7the birth date, from 0 to 20 years before the message date in MSH-7
PID-11the owner's address, with the ZIP Code 00000
PID-13the owner's phone, in the 555-01xx block reserved for fiction
PID-19empty: an animal has no Social Security number
PID-35the species as code^text^99COSYTE
PID-36the breed as code^text^99COSYTE
NK1the owner: name, relationship OWN^Owner^HL70063, address and phone. It follows the PID.

The birth date is measured from the message date, not the clock, so a seed gives the same message on any day.

Where each value comes from​

  • Species and breed come from our own short list: dog (Labrador Retriever, Beagle, mixed breed), cat (Domestic Shorthair, Siamese), horse (Quarter Horse, Thoroughbred) and cattle (Holstein, Angus). The codes are ours, under the local code system 99COSYTE (HL7 table 0396 gives local systems the form 99 and letters). We use no SNOMED CT, VetSCT or VeNom content.
  • The relationship is OWN^Owner^HL70063. We have not verified that OWN is a value of HL7 table 0063 (relationship): it is not verified, so check it against your copy of the standard.
  • The microchip is 15 digits beginning 999. We chose 999 as a range we believe no implanted chip uses, but it is not verified against ISO 11784 or any manufacturer code list.
  • The identifier type for the microchip is MCN. It is not verified against HL7 table 0203 (identifier type) in any version; these messages declare v2.5.
  • Names come from invented pools: SYNTHETIC_PET_NAMES for the pet, the person-name pools for the owner.

Draw the values yourself​

The same providers are on the package root, for a fixture in another format:

import { animalBirthDate, animalBreed, createRng, isSyntheticMicrochip, microchip, petName } from "@cosyte/synth";

const rng = createRng(5);
const name = petName(rng);
const { species, breed } = animalBreed(rng);
const chip = microchip(rng);
const born = animalBirthDate(rng, "20250601");

name.length > 0; // => true
species.system === breed.system; // => true
isSyntheticMicrochip(chip); // => true
born >= "20050601" && born <= "20250601"; // => true