Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterRepeats?TypeDocumentation
loggingyescode

Which kinds of log output messages to produce - the value is a code, from this list:

  • init: Messages describing the start up process (for debugging)
  • progress: Overall progress messages
  • tx: Messages describing the use of the terminology server (for debugging)
  • generate: Log when producing an individual resource  (troubleshooting only - leave off)
  • html: Log when validating an html page (troubleshooting only - leave off)

Default = none

generateyescode

Fine grained control over generation of resources:

  • example-narratives: generate narrative in examples if they don't have any (as opposed to conformance resources, which are always generated)
  • genExamples: produce extra examples (todo: document this)

Default = none

path-resourceyespathRelative path to a location in the IG repository from which to load resources.  Default = "\resources"
autoload-resourcesnotrue|false

If true, scan the locations in which resources might be found (above) looking for resources, and auto-loading them. Else, only load what is in the IG.

Default = false

codesystem-propertyyesuriA code system property to show when rendering code systems (code system property definitions with a 'rendered-value' extension are always shown, as is any property in the uri space http://hl7.org/fhir/concept-properties
path-pagesyespathA relative path in which pages can be found.  Default = "\pages"
path-qanopathThe relative path to the qa folder (generated fragments to check rendering in browser). If not specified, no qa is produced.  Default = "\qc"
path-tx-cacheno

path

The relative path to the terminology cache. (see (todo) for further details). 

default = no value - txCache not in version control (slower builds)

path-liquid

yes

path

A relative path that contains liquid templates for generating narrative

path-tempnopathThe relative path to use for jekyll processing. Defaults to "\temp"
path-outputnopathThe relative path where the output is generated. Defaults to "\output", which must be the case for the ci-build scripts
path-historynourlThe url where the history file is found (usually "(canonical)/history.html"). Used when checking links
path-expansion-paramsnopathThe relative path to a parameters resource that contains expansion parameters used when the IG publisher expands a value set
path-suppressed-warningsyespathA file to load suppressed error messages from (one msg per line). Suppressed errors don't chose up in the qa.ini (but will be checked anyway if publishing through HL7 processes)
html-exemptyesstring

A mask that identifies specific HTML files exempt from having header / footer etc.

Discuss with FHIR Product Manager before using in any HL7 IG

extension-domainyesurlAn external domain fro which extensions are allowed to come (else they'll be flagged as invalid when validating).  http://example.org is always allowed
active-tablesnotrue|false

Whether to generate active tables in the generated fragments (tables that will expand and contract). Note that turning this on requires that this entry be found somewhere in the header of the generated html pages:  Default = false

 <script src="fhir-table-scripts.js"></script>
ig-expansion-parametersyescode? broken - needs reworking
special-urlyesurlIf a canonical resource in the IG should actually have a URL that isn't the one implied by the canonical URL for the IG itself, it must be listed here explicitly (as well as defined in the resource itself). It must be listed here to stop it accidentally being different
template-openapinopathA relative path to the template openapi file to use when generating openapi files (e.g. populate openAPI security details)
template-htmlnopathA relative path to the template to use when rendering html pages
template-mdnopathA relative path to the template to use when rendering markdown pages
apply-contactnotrue|falseif true, overwrite all canonical resource contact details with that found in the IG.  Default = false
apply-contextnotrue|falseif true, overwrite all canonical resource context details with that found in the IG.  Default = false
apply-copyrightnotrue|falseif true, overwrite all canonical resource copyright details with that found in the IG.  Default = false
apply-jurisdictionnotrue|falseif true, overwrite all canonical resource jurisidiction details with that found in the IG.  Default = false
apply-licensenotrue|falseif true, overwrite all canonical resource license details with that found in the IG.  Default = false
apply-publishernotrue|falseif true, overwrite all canonical resource publisher details with that found in the IG.  Default = false
apply-versionnotrue|falseif true, overwrite all canonical resource version details with that found in the IG.  Default = false
validationyescode

Fine grained control over validation flags when validating resources / IGs:

  • check-must-support: Does nothing! (for now?)
  • allow-any-extensions: Allow any extensions at all (and therefore miss accidental broken extension references)
  • check-aggregation: check that aggregation is correct (in IGs, bundles are often broken up for publishing / documentation purposes)
  • no-broken-links: don't report broken links in HTML pages (note: never turn this off for HL7 guides. Stay on top of fixing broken links; it's a chore, but if you leave it till later, you won't have time, and your IG won't be approved for publishing)
  • show-reference-messages: when validating, instead of showing a summary of issues from validating the target of references, just show all the validation messages in detail

Default = none of these options

show-inherited-invariantsnotrue|falseIf true, render inherited constraints in the full details and invariants view. Default = true
usage-stats-opt-outnotrue|falseIf true, usage stats (information about extensions, value sets, and invariants being used) is not sent to fhir.org (see e.g. http://clinfhir.com/igAnalysis.html). Default = false