Interface: CcdaHeader

The parsed US Realm Header. documentId + code + title + effectiveTime answer the document's identity; recordTargets are the patient(s) (usually exactly one, more than one emits MULTIPLE_RECORD_TARGETS). setId + versionNumber + relatedDocuments carry the CDA R2 revision chain, a replacement document (see editCcda) shares its predecessor's setId, bumps versionNumber, and names the prior version in a RPLC RelatedDocument.

Example

import type { CcdaHeader } from "@cosyte/ccda";
function when(h: CcdaHeader): Date | undefined {
  return h.effectiveTime?.date;
}

Properties

code?

readonly optional code?: CD

---

confidentialityCode?

readonly optional confidentialityCode?: CD

---

documentId?

readonly optional documentId?: II

---

effectiveTime?

readonly optional effectiveTime?: TS

---

languageCode?

readonly optional languageCode?: string

---

recordTargets

readonly recordTargets: readonly CcdaPatient[]

---

relatedDocuments

readonly relatedDocuments: readonly RelatedDocument[]

---

setId?

readonly optional setId?: II

---

title?

readonly optional title?: string

---

versionNumber?

readonly optional versionNumber?: number