How to: documentation

How to create documentation pages

Assume we have a Profile: Disease and we would like to add introductory text to the page that is generated by the FHIR publisher. The following profile lives in the inputs/fsh/profiles.fsh page:

Profile: Disease
Parent: Condition
Id: Disease
Title: "Disease profile"
Description: "This profile stipulates that a FHIR Condition must have a codeable concept that represents the disease. The concepts can be taken from various ontologies, but for rare-disease concepts, we recommend MONDO."
* ^version = "0.1.0"
* ^status = #active
(...)

We add a file to the inputs/pagecontent subdirectory. The name of the file must correspond to the FHIR element. In this case, we want input/pagecontent/StructureDefinition-Disease-intro.md. The file is written in markdown, and it will get automatically added to the file:///.../.../GIT/core-ig/output/StructureDefinition-Disease.html page. It is also possible to add *-notes.md, which will appear at the end of the page.

• See http://hl7.org/fhir/uv/shorthand/2020May/sushi.html for more information.