Interface: BuildCcdaPlannedObservation

A planned Observation (…4.44). mood excludes the appointment moods (not in x_ActMoodDocumentObservation). value is the expected coded result (a goal/target, SNOMED CT by default), emitted only when supplied. Default code system for the observation code: LOINC.

Example

import type { BuildCcdaPlannedObservation } from "@cosyte/ccda";
const cbc: BuildCcdaPlannedObservation = {
  kind: "observation",
  code: { code: "58410-2", displayName: "CBC panel" }, // LOINC
  mood: "RQO",
  effectiveTime: "20240801",
};

Extends

• BuildCcdaPlannedItemBase

Properties

code

readonly code: BuildCode

The planned act/observation/drug code; default code system varies by kind.

Inherited from

BuildCcdaPlannedItemBase.code

---

effectiveTime?

readonly optional effectiveTime?: string

The planned time as an HL7 date string; emitted only when supplied, never fabricated.

[0..1] is the cardinality on five of the seven templates, not on all of them. Both substanceAdministration variants SHALL carry exactly one: Planned Medication Activity (…4.42, CONF:1098-30468) and Planned Immunization Activity (…4.120). BuildCcdaPlannedImmunization redeclares this field as required, which is why omitting it there is a type error; BuildCcdaPlannedOrder does not, so buildCcda will emit a Planned Medication Activity short that SHALL element if you leave it out. That gap is known and deliberately still open: closing it means making the field required on a published input type, which is a breaking change and a decision of its own rather than a patch.

Inherited from

BuildCcdaPlannedItemBase.effectiveTime

---

kind

readonly kind: "observation"

---

mood?

readonly optional mood?: PlannedOrderMood

The planned @moodCode; defaults to "INT". Appointment moods not representable.

---

value?

readonly optional value?: BuildCode

The expected coded result value (xsi:type="CD", SNOMED CT default), the plan's goal/target. Emitted only when supplied; never fabricated.