Skip to main content
Version: v0.0.3

Interface: BuildCcdaPlannedOrder

A planned Medication Activity or Supply (…4.42 / …4.43). mood excludes the appointment moods (not in these elements' base mood domain). The drug/supply code defaults to RxNorm (medication, emitted in the consumable) / SNOMED CT (supply).

Example​

import type { BuildCcdaPlannedOrder } from "@cosyte/ccda";
const order: BuildCcdaPlannedOrder = {
  kind: "medicationActivity",
  code: { code: "314076", displayName: "Lisinopril 10 MG Oral Tablet" },
  mood: "RQO",
};

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: "medicationActivity" | "supply"

mood?​

readonly optional mood?: PlannedOrderMood

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