Note Block Types Value set¶
| Canonical | https://fhir.apps.health/ValueSet/note-block-types |
|---|---|
| Status | draft · 1.33.0 |
| Source | FSH · JSON |
The render kinds a structured section may declare, bound extensible from the
block-type extension on Composition.section.
The kinds named today are those with a block some stream composes. Four arrive declared on the
wire, all from the note editor: text, heading-1, heading-2 and the chronic-care review's
fields-diabetes. Three are named ahead of the declaration -- the letter composer's
merge-field-body and enclosures, and the summary graphs' cited-claims -- because those
streams file their sections without stamping the kind. Identify those three by their other markers
as well: the enclosures section by its LOINC 28562-7 code, a cited summary by the citation trail
on its Provenance, a merge-field body by the letter that holds it.
This set is how a kind becomes named, not a fence around what may exist: a writer whose kind is
listed here uses this code, and a writer shipping a kind the guide has not named yet is conformant
carrying its own. Adding a kind is an edit to this set, to its code system, and to the EMR's block
registry together. A section declaring no kind at all predates the extension and reads as text.
Codes from Note Block Type CodeSystem¶
All 7 codes from this system, defined by this specification.
| Code | Display | Definition |
|---|---|---|
text | Text | A plain rich-text block -- a run of narrative the author typed. Its stored value is the markup itself, in the section's narrative, with no structured value beside it. The first block kind to ship, and the kind an untyped legacy section is read as. |
heading-1 | Heading 1 | A first-level heading: one line of plain text naming the run of the note beneath it. It is a section in its own right, not a property of the section that follows -- so it moves, is deleted and is read on its own terms, and the section order carries the outline. The narrative is the heading element itself, so a reader that does not know this kind still renders the words as a heading; only the block's independence is lost. There is no structured value beside it. |
heading-2 | Heading 2 | A second-level heading -- a run named inside a run. Identical to `heading-1` in every other respect: one line of plain text, its own section, narrative only. The note carries two heading levels rather than six because it renders inside a chart page whose outline it must not outrank. |
merge-field-body | Merge-field body | A letter body composed from a stored template by resolving its merge fields against the patient, provider and clinic. The section's narrative is the finished prose; the render kind says it was FILLED rather than typed, which is what lets a consumer offer to re-render it against current data or show which runs came from the record. The unresolved prototype held on a letter template carries this same kind: it is the same body before resolution, not a different sort of block. |
cited-claims | Cited claims | A body whose every claim is backed by a citation to the source it was drawn from -- the shape the summary graphs emit, under a generation contract that refuses to state a fact it cannot cite. The render kind is an instruction to a consumer that knows it: surface the backing, do not render the claims as bare prose. The trail itself is on the accompanying Provenance (`nexus-attributed-fact`), because it records what the generating activity read; this code says only that the body was built to be checked against it. A reader that does not know this kind renders the narrative and loses nothing clinically -- the claims are still there, only unverifiable in place. |
enclosures | Enclosures | A block whose content is what TRAVELS WITH the document rather than part of it: one reference to an attachment packet (a `List` profiled as NexusAttachmentPacket) holding the chart items assembled to be sent alongside. The section carries no prose of its own -- what a reader wants is the membership and its order, which live on the packet. Rendering it means rendering the packet's entries; a consumer that does not know this kind renders the section as text and loses only the layout, because the narrative names the members. Coded LOINC 28562-7 at the section level. |
fields-diabetes | Diabetes review | The diabetes care elements a visit reviewed and recorded: each entry naming the element, the value or attestation recorded against it, who recorded it and when. Only what the visit touched enters the block -- it shows what is due and records what was done, rather than restating the chart. The condition is part of the code, because a note template names a block by kind and cannot parameterise one; another condition is another code. The values themselves are written to the chart records that own them (Observations, vitals, Procedures) as they are recorded, so the block's structured value is this visit's account of them rather than the record of them. A reader that does not know this kind renders the narrative, which names every element and value recorded. |