Interface: ClinicalDocument

TXA-derived clinical-document entry (MDM document breadth). The load-bearing safety property: completion status (TXA-17) and availability status (TXA-19) are DISTINCT fields and are never conflated: a document can be available before it is authenticated, and reading a preliminary document as final is the clinical harm. Both are verbatim / provenance-only.

Example

import type { ClinicalDocument } from "@cosyte/hl7";
const doc: ClinicalDocument = {
  documentType: "DS",
  completionStatus: "IP", // in progress: NOT yet authenticated
  availabilityStatus: "AV", // available: a different axis
  observations: [],
};

Properties

activityDateTime?

readonly optional activityDateTime?: DtmParts

TXA-4 activity date/time (fidelity TS).

---

availabilityStatus?

readonly optional availabilityStatus?: string

TXA-19 document availability status (HL7 Table 0273: AV available, CA cancelled, OB obsolete, UN unavailable). Surfaced DISTINCT from completionStatus; verbatim, never validated, never merged.

---

completionStatus?

readonly optional completionStatus?: string

TXA-17 document completion status (HL7 Table 0271: e.g. DO documented, IP in progress, AU authenticated, LA legally authenticated, IN incomplete). Surfaced DISTINCT from availabilityStatus; verbatim, never validated, never merged.

---

documentType?

readonly optional documentType?: string

TXA-2 document type (HL7 Table 0270), verbatim.

---

observations

readonly observations: readonly Observation[]

OBX narrative body grouped under this TXA. Always present (possibly empty).

---

parentDocumentNumber?

readonly optional parentDocumentNumber?: string

TXA-13 parent document number (EI first component): addendum / replacement link.

---

uniqueDocumentNumber?

readonly optional uniqueDocumentNumber?: string

TXA-12 unique document number (EI first component, verbatim).