SMART Guidelines Starter Kit
2.0.0 - release International flag

This page is part of the SMART IG STARTER KIT (v2.0.0: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Authoring Narrative content

Narrative content can be used for different purposes:

  • Narrative pages describing the content
  • Auxiliary narrative for the resources - for example introductory text to a profile or Library.

General authoring guidance:

  • Pages should only contain headings of level 3 and above - 1 or 2 are not supported.
  • PlantUML diagrams can be added
  • All narrative pages must be listed in the ImplementationGuide resource (or equivalently in the sushi-config.yaml).
Narrative pages must be listed in the ImplementationGuide All narrative pages must be listed in the ImplementationGuide resource (or equivalently in the sushi-config.yaml). Narrative files that are not listed will not be processed or displayed.

File location

For narrative, all files are in input/pagecontent and can be written in xhtml or markdown.

XHTML

The tooling supports xhtml pages. The file extension is .xhtml.

Markdown

Markdown pages are created as files with extension .md. The Markdown dialect supported is CommonMark markdown.