Interface: BuildCcdaPatient

A patient for the document's single recordTarget. Every field is optional; an omitted demographic is emitted as a spec-clean nullFlavor="UNK" rather than invented. Supply mrn to set the patient identifier the parser returns from CcdaDocument.getMrn.

Example

import type { BuildCcdaPatient } from "@cosyte/ccda";
const patient: BuildCcdaPatient = {
  mrn: "MRN001",
  given: ["Jane"],
  family: "Doe",
  gender: "F",
  birthTime: "19800101",
};

Properties

birthTime?

readonly optional birthTime?: string

Birth time as an HL7 date/datetime string (e.g. "19800101").

---

family?

readonly optional family?: string

---

gender?

readonly optional gender?: string

Administrative gender code (M / F / UN), HL7 AdministrativeGender.

---

given?

readonly optional given?: readonly string[]

---

mrn?

readonly optional mrn?: string

The medical record number (the patientRole/id/@extension).

---

mrnAssigningAuthority?

readonly optional mrnAssigningAuthority?: string

The assigning-authority name for the MRN; defaults to a synthetic label.

---

mrnRoot?

readonly optional mrnRoot?: string

The assigning-authority OID for the MRN; defaults to a synthetic root.

---

prefix?

readonly optional prefix?: readonly string[]

---

suffix?

readonly optional suffix?: readonly string[]