Skip to main content
Version: v0.0.3

Interface: DefineProfileOptions

Options accepted by defineProfile() (D-02). Mirrors the locked Profile shape plus the extends input key. Every field except name is optional.

Example​

import { defineProfile, type DefineProfileOptions } from "@cosyte/hl7";
const opts: DefineProfileOptions = {
  name: "my-lab",
  dateFormats: ["MM/DD/YYYY"],
  customSegments: { ZLB: { fields: { noteText: 3 } } },
};
const profile = defineProfile(opts);

Properties​

customSegments?​

readonly optional customSegments?: Readonly<Record<string, CustomSegmentDefinition>>

dateFormats?​

readonly optional dateFormats?: readonly string[]

description?​

readonly optional description?: string

extends?​

readonly optional extends?: Profile | readonly Profile[]

name​

readonly name: string

onWarning?​

readonly optional onWarning?: OnWarningCallback