FHIR Tooling Extensions IG
0.2.0-snapshot - Release
FHIR Tooling Extensions IG
0.2.0-snapshot - Release
FHIR Tooling Extensions IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.2.0-snapshot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/fhir-tools-ig/ and changes regularly. See the Directory of published versions
| Active as of 2024-04-25 |
{
"resourceType" : "CodeSystem",
"id" : "ig-parameters",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div xml:lang=\"en\" lang=\"en\"><hr/><p><b>English</b></p><hr/><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>repeats</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#repeats</td><td>boolean</td><td>Whether the parameter can repeat more than once</td></tr><tr><td>string-format</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#string-format</td><td>string</td><td>Description of the value domain for the values of the parameter. Note: all values are strings, this provides additional information about what can go in the string</td></tr><tr><td>missing</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#missing</td><td>string</td><td>What it means if the parameter is not provided</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/tools/CodeSystem/ig-parameters</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">logging<a name=\"ig-parameters-logging\"> </a></td><td>logging</td><td><div><p>Which kinds of log output messages to produce - the value is a code, from this list:</p>\n<ul>\n<li><code>init</code>: Messages describing the start up process (for debugging)</li>\n<li><code>progress</code>: Overall progress messages</li>\n<li><code>tx</code>: Messages describing the use of the terminology server (for debugging)</li>\n<li><code>generate</code>: Log when producing an individual resource (troubleshooting only - leave off)</li>\n<li><code>html</code>: Log when validating an html page (troubleshooting only - leave off)</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">generate<a name=\"ig-parameters-generate\"> </a></td><td>generate</td><td><div><p>Fine grained control over generation of resources:</p>\n<ul>\n<li><code>example-narratives</code>: generate narrative in examples if they don't have any (as opposed to conformance resources, which are always generated)</li>\n<li><code>genExamples</code>: produce extra examples (todo: document this)</li>\n</ul>\n<p>Except: you can't turn example-narratives off. Todo: decide why this exists. But you can suppress - see next item</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-narrative<a name=\"ig-parameters-no-narrative\"> </a></td><td>no-narrative</td><td><div><p>A resource to suppress narrative generation for (and Resource.text will be removed if found). Format is <code>(type)/(id)</code> e.g. <code>Patient/example</code>, or type or id may be <code>*</code> e.g. <code>Task/*</code> - do not generate narrative for any Task resource.</p>\n<p>Narrative Generation should never be suppressed for any canonical resource</p>\n<p>Note for HL7 users: the FMG will review which resources have narrative suppressed and why when publication approval is sought</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-validate<a name=\"ig-parameters-no-validate\"> </a></td><td>no-validate</td><td><div><p>A resource not to validate. Format is <code>(type)/(id)</code> e.g. <code>Patient/example</code>, or type or id may be <code>*</code> e.g. <code>Task/*</code> - do not validate any Task resource.</p>\n<p>Suppressing validation is generally a bad idea. There's two contexts where it might be useful: validation of really big resources that takes a long time, and examples that are purposefully wrong to demonstrate what not to do. But while it sounds good - don't bother me with problems I mean to introduce, it's too easy for other unintended problems to accumulate. So it's better to keep validation on.</p>\n<p>ote for HL7 users: the FMG will review which resources have validation suppressed and why when publication approval is sought. FMG would generally prefer to see explicit errors for resources that are wrong intentionally, and will OK publication in this case. <strong>It's going to reviewed either way.</strong></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-check-usage<a name=\"ig-parameters-no-check-usage\"> </a></td><td>no-check-usage</td><td><div><p>Do not check usage for extensions and data types - for IGs where they are being defined for use elsewhere</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-resource<a name=\"ig-parameters-path-resource\"> </a></td><td>path-resource</td><td><div><p>Relative path to a location in the IG repository from which to load resources. If the path ends in /*, then that means all sub-folders</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-binary<a name=\"ig-parameters-path-binary\"> </a></td><td>path-binary</td><td><div><p>Relative path to a location in the IG repository in which to look for binary adjunct files (see below)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">autoload-resources<a name=\"ig-parameters-autoload-resources\"> </a></td><td>autoload-resources</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">codesystem-property<a name=\"ig-parameters-codesystem-property\"> </a></td><td>codesystem-property</td><td><div><p>A 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 <code>http://hl7.org/fhir/concept-properties</code></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-pages<a name=\"ig-parameters-path-pages\"> </a></td><td>path-pages</td><td><div><p>A relative path in which pages can be found.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-data<a name=\"ig-parameters-path-data\"> </a></td><td>path-data</td><td><div><p>A relative path in which data files can be found (will go in _data for Jekyll).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-qa<a name=\"ig-parameters-path-qa\"> </a></td><td>path-qa</td><td><div><p>The relative path to the qa folder (generated fragments to check rendering in browser).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-tx-cache<a name=\"ig-parameters-path-tx-cache\"> </a></td><td>path-tx-cache</td><td><div><p>The relative path to the terminology cache.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-liquid<a name=\"ig-parameters-path-liquid\"> </a></td><td>path-liquid</td><td><div><p>A relative path that contains liquid templates for generating narrative</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-temp<a name=\"ig-parameters-path-temp\"> </a></td><td>path-temp</td><td><div><p>The relative path to use for jekyll processing.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-output<a name=\"ig-parameters-path-output\"> </a></td><td>path-output</td><td><div><p>The relative path where the output is generated.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-history<a name=\"ig-parameters-path-history\"> </a></td><td>path-history</td><td><div><p>The url where the history file is found (usually <code>(canonical)/history.html</code>). Used when checking links</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-expansion-params<a name=\"ig-parameters-path-expansion-params\"> </a></td><td>path-expansion-params</td><td><div><p>The relative path to a parameters resource that contains expansion parameters used when the IG publisher expands a value set</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-suppressed-warnings<a name=\"ig-parameters-path-suppressed-warnings\"> </a></td><td>path-suppressed-warnings</td><td><div><p>A 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)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-test<a name=\"ig-parameters-path-test\"> </a></td><td>path-test</td><td><div><p>Indicates a folder that contains useful testing collateral to include a /test folder in the package. If more than one value is provided, the contents are all added to the one folder (in order)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">html-exempt<a name=\"ig-parameters-html-exempt\"> </a></td><td>html-exempt</td><td><div><p>A mask that identifies specific HTML files exempt from having header / footer etc.</p>\n<p>Discuss with FHIR Product Manager before using in any HL7 IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">extension-domain<a name=\"ig-parameters-extension-domain\"> </a></td><td>extension-domain</td><td><div><p>An external domain from which extensions are allowed to come (else they'll be flagged as invalid when validating). <code>http://example.org</code> is always allowed</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">active-tables<a name=\"ig-parameters-active-tables\"> </a></td><td>active-tables</td><td><div><p>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: <code>\\<script src='fhir-table-scripts.js'>\\</script></code></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">special-url<a name=\"ig-parameters-special-url\"> </a></td><td>special-url</td><td><div><p>If 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. Each canonical url must be listed in full as present on the resource; it is not possible to specify a pattern.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">special-url-base<a name=\"ig-parameters-special-url-base\"> </a></td><td>special-url-base</td><td><div><p>A common alternative base URL for multiple canonical resources in the IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-openapi<a name=\"ig-parameters-template-openapi\"> </a></td><td>template-openapi</td><td><div><p>A relative path to the template openapi file to use when generating openapi files (e.g. populate openAPI security details)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-html<a name=\"ig-parameters-template-html\"> </a></td><td>template-html</td><td><div><p>A relative path to the template to use when rendering html pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-md<a name=\"ig-parameters-template-md\"> </a></td><td>template-md</td><td><div><p>A relative path to the template to use when rendering markdown pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-contact<a name=\"ig-parameters-apply-contact\"> </a></td><td>apply-contact</td><td><div><p>if true, overwrite all canonical resource contact details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-contact<a name=\"ig-parameters-default-contact\"> </a></td><td>default-contact</td><td><div><p>if true, populate all canonical resources that don't specify their own contact details with that found in the IG. Ignored if apply-contact is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-context<a name=\"ig-parameters-apply-context\"> </a></td><td>apply-context</td><td><div><p>if true, overwrite all canonical resource context details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-context<a name=\"ig-parameters-default-context\"> </a></td><td>default-context</td><td><div><p>if true, populate all canonical resources that don't specify their own context details with that found in the IG. Ignored if apply-context is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-copyright<a name=\"ig-parameters-apply-copyright\"> </a></td><td>apply-copyright</td><td><div><p>if true, overwrite all canonical resource copyright details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-copyright<a name=\"ig-parameters-default-copyright\"> </a></td><td>default-copyright</td><td><div><p>if true, populate all canonical resources that don't specify their own copyright details with that found in the IG. Ignored if apply-copyright is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-jurisdiction<a name=\"ig-parameters-apply-jurisdiction\"> </a></td><td>apply-jurisdiction</td><td><div><p>if true, overwrite all canonical resource jurisdiction details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-jurisdiction<a name=\"ig-parameters-default-jurisdiction\"> </a></td><td>default-jurisdiction</td><td><div><p>if true, populate all canonical resources that don't specify their own jurisdiction details with that found in the IG. Ignored if apply-jurisdiction is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-license<a name=\"ig-parameters-apply-license\"> </a></td><td>apply-license</td><td><div><p>if true, overwrite all canonical resource license details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-license<a name=\"ig-parameters-default-license\"> </a></td><td>default-license</td><td><div><p>if true, populate all canonical resources that don't specify their own license details with that found in the IG. Ignored if apply-license is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-publisher<a name=\"ig-parameters-apply-publisher\"> </a></td><td>apply-publisher</td><td><div><p>if true, overwrite all canonical resource publisher details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-publisher<a name=\"ig-parameters-default-publisher\"> </a></td><td>default-publisher</td><td><div><p>if true, populate all canonical resources that don't specify their own publisher details with that found in the IG. Ignored if apply-publisher is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-version<a name=\"ig-parameters-apply-version\"> </a></td><td>apply-version</td><td><div><p>if true, overwrite all canonical resource version details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-version<a name=\"ig-parameters-default-version\"> </a></td><td>default-version</td><td><div><p>if true, populate all canonical resources that don't specify their own version details with that found in the IG. Ignored if apply-version is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-wg<a name=\"ig-parameters-apply-wg\"> </a></td><td>apply-wg</td><td><div><p>if true, overwrite all canonical resource WG details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-wg<a name=\"ig-parameters-default-wg\"> </a></td><td>default-wg</td><td><div><p>if true, populate all canonical resources that don't specify their own WG details with that found in the IG. Ignored if apply-contact is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">propagate-status<a name=\"ig-parameters-propagate-status\"> </a></td><td>propagate-status</td><td><div><p>If true, indicates that the FMM and Standards Status declarations from top-level artifacts should be propagated to any dependencies that don't declare their own values. If different statuses or maturity level would propagate to a dependency from different artifacts, the 'highest' FMM or most mature standards status will apply (Normative or Informative, then STU, then Draft). Information does not propagate to artifacts marked as examples or as experimental.\nPropagation is based on references. E.g. the IG references everything (so its status will propagate everywhere by default). If there are higher statuses on certain CapabilityStatements, Operations or Profiles, those status will propagate to the artifacts they reference, such as other profiles, ValueSets or CodeSystems.\nPropagation only happens within the context of an IG. There is no propagation across artifacts present in other IG packages listed as dependencies.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">validation<a name=\"ig-parameters-validation\"> </a></td><td>validation</td><td><div><p>Fine grained control over validation flags when validating resources / IGs:</p>\n<ul>\n<li><code>check-must-support</code>: Does nothing! (for now?)</li>\n<li><code>allow-any-extensions</code>: Allow any extensions at all (and therefore miss accidental broken extension references)</li>\n<li><code>check-aggregation</code>: check that aggregation is correct (in IGs, bundles are often broken up for publishing / documentation purposes)</li>\n<li><code>no-broken-links</code>: forbid broken links in HTML pages - stop the build if any are found</li>\n<li><code>show-reference-messages</code>: when validating, instead of showing a summary of issues from validating the target of references, just show all the validation messages in detail</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">show-inherited-invariants<a name=\"ig-parameters-show-inherited-invariants\"> </a></td><td>show-inherited-invariants</td><td><div><p>faIf true, render inherited constraints in the full details and invariants viewlse</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">allow-extensible-warnings<a name=\"ig-parameters-allow-extensible-warnings\"> </a></td><td>allow-extensible-warnings</td><td><div><p>if true, show the warning when codes are not in extensible bindings</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">usage-stats-opt-out<a name=\"ig-parameters-usage-stats-opt-out\"> </a></td><td>usage-stats-opt-out</td><td><div><p>If true, usage stats (information about extensions, value sets, and invariants being used) is not sent to fhir.org (see e.g. <code>http://clinfhir.com/igAnalysis.html</code>).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">generate-version<a name=\"ig-parameters-generate-version\"> </a></td><td>generate-version</td><td><div><p>Request that the IG publisher generate packages for additional versions than the stated version e.g. the IG might be for authored against version 4.0, but also produce an R3 version.</p>\n<p>For each occurence of this parameter, the IG publisher will produce an extra package, with the filename id.ver.tgz where id is the main id of the ig, and ver is the parameter value. (note that this is different to the main package which is always called package.tgz).</p>\n<p>This parameter can have one one of following values:</p>\n<ul>\n<li>r2</li>\n<li>r2b</li>\n<li>r3</li>\n<li>r4</li>\n<li>r5</li>\n</ul>\n<p>This parameter should be used with great care, and only after consulting the FHIR Product director to consider all of it's ramifications. It's generally only appropriate for terminology resources.\nIt's not an error to generate the same version as the IG itself - this is typically done for consistency of use across versions</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">releaselabel<a name=\"ig-parameters-releaselabel\"> </a></td><td>releaselabel</td><td><div><p>The release label at the top of the page - values:</p>\n<ul>\n<li><code>ci-build</code> - the continuous integration build release (not stable)</li>\n<li><code>draft</code> - draft version</li>\n<li><code>qa-preview</code> - frozen snapshot for non-ballot feedback</li>\n<li><code>ballot</code> - frozen snapshot for ballot</li>\n<li><code>trial-use</code> - official release with 'trial use' status</li>\n<li><code>release</code> - official release for use</li>\n<li><code>update</code> - official release with 'trial use' status - posted as an un-ballotedSTU update</li>\n<li><code>normative+trial-use</code> - official release with mixture of trial use and normative content</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludexml<a name=\"ig-parameters-excludexml\"> </a></td><td>excludexml</td><td><div><p>Cause the publisher to exclude the generation of the xml format and to exclude the xml tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludejson<a name=\"ig-parameters-excludejson\"> </a></td><td>excludejson</td><td><div><p>Cause the publisher to exclude the generation of the json format and to exclude the json tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludettl<a name=\"ig-parameters-excludettl\"> </a></td><td>excludettl</td><td><div><p>Cause the publisher to exclude the generation of the ttl format and to exclude the ttl tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludemap<a name=\"ig-parameters-excludemap\"> </a></td><td>excludemap</td><td><div><p>If true, causes the mapping tab to be excluded from all StructureDefinition artifact pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludelogbinaryformat<a name=\"ig-parameters-excludelogbinaryformat\"> </a></td><td>excludelogbinaryformat</td><td><div><p>If true, causes the xml, json and ttl tabs to be excluded for Binary resources when they're examples of logical models</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">shownav<a name=\"ig-parameters-shownav\"> </a></td><td>shownav</td><td><div><p>Determines whether the next/previous navigation tabs are shown in the header and footer</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">copyrightyear<a name=\"ig-parameters-copyrightyear\"> </a></td><td>copyrightyear</td><td><div><p>The copyright year text to include in the implementation guide footer</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">fmm-definition<a name=\"ig-parameters-fmm-definition\"> </a></td><td>fmm-definition</td><td><div><p>Indicates the URL that provides a definition for the maturity levels declared in the current IG.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">version-comparison<a name=\"ig-parameters-version-comparison\"> </a></td><td>version-comparison</td><td><div><p>Control how the IG publisher does a comparison with a previously published version (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">version-comparison-master<a name=\"ig-parameters-version-comparison-master\"> </a></td><td>version-comparison-master</td><td><div><p>Provide this parameter to instruct the IG publisher to mark up the generated pages with the differences found for the version specified. This version can be listed in version-comparison too but it doesn't need to be. Note that the impact of this parameter is a work in progress</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">ipa-comparison<a name=\"ig-parameters-ipa-comparison\"> </a></td><td>ipa-comparison</td><td><div><p>Control how the IG publisher does a comparison with a IPA (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">ips-comparison<a name=\"ig-parameters-ips-comparison\"> </a></td><td>ips-comparison</td><td><div><p>Control how the IG publisher does a comparison with a IPS (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">bundle-references-resolve<a name=\"ig-parameters-bundle-references-resolve\"> </a></td><td>bundle-references-resolve</td><td><div><p>Whether to require that references in bundles resolve. <code>true</code> means references must resolve within implementation guides or an error is created.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">format-date<a name=\"ig-parameters-format-date\"> </a></td><td>format-date</td><td><div><p>String format to use when rendering date values from resources in the implementation guide.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">format-datetime<a name=\"ig-parameters-format-datetime\"> </a></td><td>format-datetime</td><td><div><p>String format to use when rendering date/time values from resources in the implementation guide.</p>\n<p>Note: see <a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html\">Patterns for Formatting and Parsing</a> for Java String formats</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-modifiers<a name=\"ig-parameters-no-modifiers\"> </a></td><td>no-modifiers</td><td><div><p>If set to <code>true</code>, it means that all profiles created within the implementation guide will have their differential modified to set maxOccurs=0 on all <code>isModifier</code> elements that are not explicitly mentioned in the original source differential.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">jekyll-timeout<a name=\"ig-parameters-jekyll-timeout\"> </a></td><td>jekyll-timeout</td><td><div><p>How long to let Jekyll run before giving up on it (seconds)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">suppressed-ids<a name=\"ig-parameters-suppressed-ids\"> </a></td><td>suppressed-ids</td><td><div><p>A comma separated list of resource ids to suppress ids when they are rendered in the Implementation Guide.</p>\n<p>This is useful because the IG publication process requires all resources to have ids, so they can be handled. But in some Implementation Guides, some examples should not have ids .e.g showing an example of posting a new resource. If the resource is listed here, the id will be removed in the publication (but not the package, where the resources must have ids).\nThe format is either type/id, or just id. Repeating parameters just add more to the list. If the parameter is present with the special value $examples, then all examples will have ids suppressed\nIf the parameter is not present, then all resources will have ids.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">tabbed-snapshots<a name=\"ig-parameters-tabbed-snapshots\"> </a></td><td>tabbed-snapshots</td><td><div><p>A boolean that indicates that the implementation guide leverages tabs to include alternate dictionary views and that tabs for differential, key and/or must-support tables should link to anchors specific to those tables rather than only to the default 'snapshot' keys.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">jira-code<a name=\"ig-parameters-jira-code\"> </a></td><td>jira-code</td><td><div><p>If your IG is published via HL7 and should your package ID diverge from the file name in the JIRA-Spec-Artifacts repository, this parameter will help point to the right file.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">r4-exclusion<a name=\"ig-parameters-r4-exclusion\"> </a></td><td>r4-exclusion</td><td><div><p>For an R4B IG, ignore this profile when considering conversion to R4, or for an R4 IG, omit this when generating the R4 specific package. Value is either '{type}/{id}' or '{url}'</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">r4b-exclusion<a name=\"ig-parameters-r4b-exclusion\"> </a></td><td>r4b-exclusion</td><td><div><p>For an R4 IG, ignore this profile when considering conversion to R4B, or for an R4B IG, omit this when generating the R4B specific package. Value is either '{type}/{id}' or '{url}'</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">produce-jekyll-data<a name=\"ig-parameters-produce-jekyll-data\"> </a></td><td>produce-jekyll-data</td><td><div><p>Produce the resources as .json in the jekyll _data folder. Note that Jekyll will fail if any of the resources contain non-ascii characters</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">page-factory<a name=\"ig-parameters-page-factory\"> </a></td><td>page-factory</td><td><div><p>Reference to a <a href=\"page-factories.html\">Page Factory</a></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">globals-in-artifacts<a name=\"ig-parameters-globals-in-artifacts\"> </a></td><td>globals-in-artifacts</td><td><div><p>If true, causes the list of global profiles to appear at the top of the Artifacts Summary page</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">noRootToc<a name=\"ig-parameters-noRootToc\"> </a></td><td>No root table-of-contents</td><td><div><p>If true, causes the ig to not inject a root 'toc' page if that's not already the root (only functions in templates that do this by default)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">artifactsOnRoot<a name=\"ig-parameters-artifactsOnRoot\"> </a></td><td>Artifacts on root</td><td><div><p>If true, causes artifact pages to be created as children of the IG's 'root' page rather than the 'artifacts' page (if the template supports doing that)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">conversion-version<a name=\"ig-parameters-conversion-version\"> </a></td><td>conversion-version</td><td><div><p>Defines an additional version of the FHIR definitions to load for version conversion maps. Value is either RX or V.V (e.g. R4 or 4.0). Additional versions are loaded with modified URLs (e.g. R4 is loaded to http://hl7.org.fhir/4.0)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">defaultVersion<a name=\"ig-parameters-defaultVersion\"> </a></td><td>defaultVersion</td><td><div><p>Lloyd to provide definition</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-usage-check<a name=\"ig-parameters-no-usage-check\"> </a></td><td>no-usage-check</td><td><div><p>No Warning in QA if there are extensions/profiles that are not used in this IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">i18n-default-lang<a name=\"ig-parameters-i18n-default-lang\"> </a></td><td>i18n-default-lang</td><td><div><p>The default language (e.g. <a href=\"http://hl7.org/fhir/R5/resource.html#Resource\">Resource.language</a>) to assume in the IG when the resource and/or the element context doesn't specify a language</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">i18n-lang<a name=\"ig-parameters-i18n-lang\"> </a></td><td>i18n-lang</td><td><div><p>A language to translate the IG into. note that i18n-default-lang is automatically a language, and doesn't need to be restated</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">translation-sources<a name=\"ig-parameters-translation-sources\"> </a></td><td>translation-sources</td><td><div><p>A folder in which to look for translation source files - .po or .xliff or .json</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">translation-supplements<a name=\"ig-parameters-translation-supplements\"> </a></td><td>translation-supplements</td><td><div><p>A folder in which to look for translation supplements - .po or .xliff or .json. This is deprecated - use translation-sources instead</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">display-warnings<a name=\"ig-parameters-display-warnings\"> </a></td><td>display-warnings</td><td><div><p>Instruct the terminology layer that wrong displays result in a warning not an error</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">logged-when-scanning<a name=\"ig-parameters-logged-when-scanning\"> </a></td><td>logged-when-scanning</td><td><div><p>Whether to report issues when scanning files for resources. Valid values are: true, false, stack</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">validation-duration-report-cutoff<a name=\"ig-parameters-validation-duration-report-cutoff\"> </a></td><td>validation-duration-report-cutoff</td><td><div><p>An integer value that specifies the a number of seconds. If any resource takes longer than that time, it will be reported in the log</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">viewDefinition<a name=\"ig-parameters-viewDefinition\"> </a></td><td>viewDefinition</td><td><div><p>A ViewDefinition to execute (path to file). Output is added in the package.db file as a generated table, and can be used in the page contents. See also <a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/sql.html\">documentation</a></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">fixed-value-format<a name=\"ig-parameters-fixed-value-format\"> </a></td><td>Fixed Value Format Code</td><td><div><p>A code that indicates how to format fixed and pattern values. Valid values for this parameter are json | json-all | xml | all-xml. The -all options relate to primitives - whether they are shown just as a value or as a formatted fragment</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">auto-oid-root<a name=\"ig-parameters-auto-oid-root\"> </a></td><td>OID root for automatically assigned OIDs</td><td><div><p>Defines the OID root for the IG. Must be globally unique. Contact the FHIR product director or deputy for an assignment, though you can assign your own if you wish. If this is present, any canonical resources that do not have OIDs assigned manually will have OIDs automatically assigned by the publisher. The OID assignments are stored in oids.ini next to the IG resource for the IG, and must be committed with other changes to the source.</p>\n</div></td></tr></table></div><div xml:lang=\"es\" lang=\"es\"><hr/><p><b>Spanish</b></p><hr/><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>repeats</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#repeats</td><td>boolean</td><td>Whether the parameter can repeat more than once</td></tr><tr><td>string-format</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#string-format</td><td>string</td><td>Description of the value domain for the values of the parameter. Note: all values are strings, this provides additional information about what can go in the string</td></tr><tr><td>missing</td><td>http://hl7.org/fhir/tools/CodeSystem/ig-parameters#missing</td><td>string</td><td>What it means if the parameter is not provided</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/tools/CodeSystem/ig-parameters</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">logging<a name=\"ig-parameters-logging\"> </a></td><td>logging</td><td><div><p>Which kinds of log output messages to produce - the value is a code, from this list:</p>\n<ul>\n<li><code>init</code>: Messages describing the start up process (for debugging)</li>\n<li><code>progress</code>: Overall progress messages</li>\n<li><code>tx</code>: Messages describing the use of the terminology server (for debugging)</li>\n<li><code>generate</code>: Log when producing an individual resource (troubleshooting only - leave off)</li>\n<li><code>html</code>: Log when validating an html page (troubleshooting only - leave off)</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">generate<a name=\"ig-parameters-generate\"> </a></td><td>generate</td><td><div><p>Fine grained control over generation of resources:</p>\n<ul>\n<li><code>example-narratives</code>: generate narrative in examples if they don't have any (as opposed to conformance resources, which are always generated)</li>\n<li><code>genExamples</code>: produce extra examples (todo: document this)</li>\n</ul>\n<p>Except: you can't turn example-narratives off. Todo: decide why this exists. But you can suppress - see next item</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-narrative<a name=\"ig-parameters-no-narrative\"> </a></td><td>no-narrative</td><td><div><p>A resource to suppress narrative generation for (and Resource.text will be removed if found). Format is <code>(type)/(id)</code> e.g. <code>Patient/example</code>, or type or id may be <code>*</code> e.g. <code>Task/*</code> - do not generate narrative for any Task resource.</p>\n<p>Narrative Generation should never be suppressed for any canonical resource</p>\n<p>Note for HL7 users: the FMG will review which resources have narrative suppressed and why when publication approval is sought</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-validate<a name=\"ig-parameters-no-validate\"> </a></td><td>no-validate</td><td><div><p>A resource not to validate. Format is <code>(type)/(id)</code> e.g. <code>Patient/example</code>, or type or id may be <code>*</code> e.g. <code>Task/*</code> - do not validate any Task resource.</p>\n<p>Suppressing validation is generally a bad idea. There's two contexts where it might be useful: validation of really big resources that takes a long time, and examples that are purposefully wrong to demonstrate what not to do. But while it sounds good - don't bother me with problems I mean to introduce, it's too easy for other unintended problems to accumulate. So it's better to keep validation on.</p>\n<p>ote for HL7 users: the FMG will review which resources have validation suppressed and why when publication approval is sought. FMG would generally prefer to see explicit errors for resources that are wrong intentionally, and will OK publication in this case. <strong>It's going to reviewed either way.</strong></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-check-usage<a name=\"ig-parameters-no-check-usage\"> </a></td><td>no-check-usage</td><td><div><p>Do not check usage for extensions and data types - for IGs where they are being defined for use elsewhere</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-resource<a name=\"ig-parameters-path-resource\"> </a></td><td>path-resource</td><td><div><p>Relative path to a location in the IG repository from which to load resources. If the path ends in /*, then that means all sub-folders</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-binary<a name=\"ig-parameters-path-binary\"> </a></td><td>path-binary</td><td><div><p>Relative path to a location in the IG repository in which to look for binary adjunct files (see below)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">autoload-resources<a name=\"ig-parameters-autoload-resources\"> </a></td><td>autoload-resources</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">codesystem-property<a name=\"ig-parameters-codesystem-property\"> </a></td><td>codesystem-property</td><td><div><p>A 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 <code>http://hl7.org/fhir/concept-properties</code></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-pages<a name=\"ig-parameters-path-pages\"> </a></td><td>path-pages</td><td><div><p>A relative path in which pages can be found.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-data<a name=\"ig-parameters-path-data\"> </a></td><td>path-data</td><td><div><p>A relative path in which data files can be found (will go in _data for Jekyll).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-qa<a name=\"ig-parameters-path-qa\"> </a></td><td>path-qa</td><td><div><p>The relative path to the qa folder (generated fragments to check rendering in browser).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-tx-cache<a name=\"ig-parameters-path-tx-cache\"> </a></td><td>path-tx-cache</td><td><div><p>The relative path to the terminology cache.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-liquid<a name=\"ig-parameters-path-liquid\"> </a></td><td>path-liquid</td><td><div><p>A relative path that contains liquid templates for generating narrative</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-temp<a name=\"ig-parameters-path-temp\"> </a></td><td>path-temp</td><td><div><p>The relative path to use for jekyll processing.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-output<a name=\"ig-parameters-path-output\"> </a></td><td>path-output</td><td><div><p>The relative path where the output is generated.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-history<a name=\"ig-parameters-path-history\"> </a></td><td>path-history</td><td><div><p>The url where the history file is found (usually <code>(canonical)/history.html</code>). Used when checking links</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-expansion-params<a name=\"ig-parameters-path-expansion-params\"> </a></td><td>path-expansion-params</td><td><div><p>The relative path to a parameters resource that contains expansion parameters used when the IG publisher expands a value set</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-suppressed-warnings<a name=\"ig-parameters-path-suppressed-warnings\"> </a></td><td>path-suppressed-warnings</td><td><div><p>A 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)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">path-test<a name=\"ig-parameters-path-test\"> </a></td><td>path-test</td><td><div><p>Indicates a folder that contains useful testing collateral to include a /test folder in the package. If more than one value is provided, the contents are all added to the one folder (in order)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">html-exempt<a name=\"ig-parameters-html-exempt\"> </a></td><td>html-exempt</td><td><div><p>A mask that identifies specific HTML files exempt from having header / footer etc.</p>\n<p>Discuss with FHIR Product Manager before using in any HL7 IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">extension-domain<a name=\"ig-parameters-extension-domain\"> </a></td><td>extension-domain</td><td><div><p>An external domain from which extensions are allowed to come (else they'll be flagged as invalid when validating). <code>http://example.org</code> is always allowed</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">active-tables<a name=\"ig-parameters-active-tables\"> </a></td><td>active-tables</td><td><div><p>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: <code>\\<script src='fhir-table-scripts.js'>\\</script></code></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">special-url<a name=\"ig-parameters-special-url\"> </a></td><td>special-url</td><td><div><p>If 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. Each canonical url must be listed in full as present on the resource; it is not possible to specify a pattern.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">special-url-base<a name=\"ig-parameters-special-url-base\"> </a></td><td>special-url-base</td><td><div><p>A common alternative base URL for multiple canonical resources in the IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-openapi<a name=\"ig-parameters-template-openapi\"> </a></td><td>template-openapi</td><td><div><p>A relative path to the template openapi file to use when generating openapi files (e.g. populate openAPI security details)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-html<a name=\"ig-parameters-template-html\"> </a></td><td>template-html</td><td><div><p>A relative path to the template to use when rendering html pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">template-md<a name=\"ig-parameters-template-md\"> </a></td><td>template-md</td><td><div><p>A relative path to the template to use when rendering markdown pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-contact<a name=\"ig-parameters-apply-contact\"> </a></td><td>apply-contact</td><td><div><p>if true, overwrite all canonical resource contact details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-contact<a name=\"ig-parameters-default-contact\"> </a></td><td>default-contact</td><td><div><p>if true, populate all canonical resources that don't specify their own contact details with that found in the IG. Ignored if apply-contact is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-context<a name=\"ig-parameters-apply-context\"> </a></td><td>apply-context</td><td><div><p>if true, overwrite all canonical resource context details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-context<a name=\"ig-parameters-default-context\"> </a></td><td>default-context</td><td><div><p>if true, populate all canonical resources that don't specify their own context details with that found in the IG. Ignored if apply-context is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-copyright<a name=\"ig-parameters-apply-copyright\"> </a></td><td>apply-copyright</td><td><div><p>if true, overwrite all canonical resource copyright details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-copyright<a name=\"ig-parameters-default-copyright\"> </a></td><td>default-copyright</td><td><div><p>if true, populate all canonical resources that don't specify their own copyright details with that found in the IG. Ignored if apply-copyright is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-jurisdiction<a name=\"ig-parameters-apply-jurisdiction\"> </a></td><td>apply-jurisdiction</td><td><div><p>if true, overwrite all canonical resource jurisdiction details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-jurisdiction<a name=\"ig-parameters-default-jurisdiction\"> </a></td><td>default-jurisdiction</td><td><div><p>if true, populate all canonical resources that don't specify their own jurisdiction details with that found in the IG. Ignored if apply-jurisdiction is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-license<a name=\"ig-parameters-apply-license\"> </a></td><td>apply-license</td><td><div><p>if true, overwrite all canonical resource license details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-license<a name=\"ig-parameters-default-license\"> </a></td><td>default-license</td><td><div><p>if true, populate all canonical resources that don't specify their own license details with that found in the IG. Ignored if apply-license is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-publisher<a name=\"ig-parameters-apply-publisher\"> </a></td><td>apply-publisher</td><td><div><p>if true, overwrite all canonical resource publisher details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-publisher<a name=\"ig-parameters-default-publisher\"> </a></td><td>default-publisher</td><td><div><p>if true, populate all canonical resources that don't specify their own publisher details with that found in the IG. Ignored if apply-publisher is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-version<a name=\"ig-parameters-apply-version\"> </a></td><td>apply-version</td><td><div><p>if true, overwrite all canonical resource version details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-version<a name=\"ig-parameters-default-version\"> </a></td><td>default-version</td><td><div><p>if true, populate all canonical resources that don't specify their own version details with that found in the IG. Ignored if apply-version is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">apply-wg<a name=\"ig-parameters-apply-wg\"> </a></td><td>apply-wg</td><td><div><p>if true, overwrite all canonical resource WG details with that found in the IG.</p>\n<p>(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">default-wg<a name=\"ig-parameters-default-wg\"> </a></td><td>default-wg</td><td><div><p>if true, populate all canonical resources that don't specify their own WG details with that found in the IG. Ignored if apply-contact is true.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">propagate-status<a name=\"ig-parameters-propagate-status\"> </a></td><td>propagate-status</td><td><div><p>If true, indicates that the FMM and Standards Status declarations from top-level artifacts should be propagated to any dependencies that don't declare their own values. If different statuses or maturity level would propagate to a dependency from different artifacts, the 'highest' FMM or most mature standards status will apply (Normative or Informative, then STU, then Draft). Information does not propagate to artifacts marked as examples or as experimental.\nPropagation is based on references. E.g. the IG references everything (so its status will propagate everywhere by default). If there are higher statuses on certain CapabilityStatements, Operations or Profiles, those status will propagate to the artifacts they reference, such as other profiles, ValueSets or CodeSystems.\nPropagation only happens within the context of an IG. There is no propagation across artifacts present in other IG packages listed as dependencies.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">validation<a name=\"ig-parameters-validation\"> </a></td><td>validation</td><td><div><p>Fine grained control over validation flags when validating resources / IGs:</p>\n<ul>\n<li><code>check-must-support</code>: Does nothing! (for now?)</li>\n<li><code>allow-any-extensions</code>: Allow any extensions at all (and therefore miss accidental broken extension references)</li>\n<li><code>check-aggregation</code>: check that aggregation is correct (in IGs, bundles are often broken up for publishing / documentation purposes)</li>\n<li><code>no-broken-links</code>: forbid broken links in HTML pages - stop the build if any are found</li>\n<li><code>show-reference-messages</code>: when validating, instead of showing a summary of issues from validating the target of references, just show all the validation messages in detail</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">show-inherited-invariants<a name=\"ig-parameters-show-inherited-invariants\"> </a></td><td>show-inherited-invariants</td><td><div><p>faIf true, render inherited constraints in the full details and invariants viewlse</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">allow-extensible-warnings<a name=\"ig-parameters-allow-extensible-warnings\"> </a></td><td>allow-extensible-warnings</td><td><div><p>if true, show the warning when codes are not in extensible bindings</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">usage-stats-opt-out<a name=\"ig-parameters-usage-stats-opt-out\"> </a></td><td>usage-stats-opt-out</td><td><div><p>If true, usage stats (information about extensions, value sets, and invariants being used) is not sent to fhir.org (see e.g. <code>http://clinfhir.com/igAnalysis.html</code>).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">generate-version<a name=\"ig-parameters-generate-version\"> </a></td><td>generate-version</td><td><div><p>Request that the IG publisher generate packages for additional versions than the stated version e.g. the IG might be for authored against version 4.0, but also produce an R3 version.</p>\n<p>For each occurence of this parameter, the IG publisher will produce an extra package, with the filename id.ver.tgz where id is the main id of the ig, and ver is the parameter value. (note that this is different to the main package which is always called package.tgz).</p>\n<p>This parameter can have one one of following values:</p>\n<ul>\n<li>r2</li>\n<li>r2b</li>\n<li>r3</li>\n<li>r4</li>\n<li>r5</li>\n</ul>\n<p>This parameter should be used with great care, and only after consulting the FHIR Product director to consider all of it's ramifications. It's generally only appropriate for terminology resources.\nIt's not an error to generate the same version as the IG itself - this is typically done for consistency of use across versions</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">releaselabel<a name=\"ig-parameters-releaselabel\"> </a></td><td>releaselabel</td><td><div><p>The release label at the top of the page - values:</p>\n<ul>\n<li><code>ci-build</code> - the continuous integration build release (not stable)</li>\n<li><code>draft</code> - draft version</li>\n<li><code>qa-preview</code> - frozen snapshot for non-ballot feedback</li>\n<li><code>ballot</code> - frozen snapshot for ballot</li>\n<li><code>trial-use</code> - official release with 'trial use' status</li>\n<li><code>release</code> - official release for use</li>\n<li><code>update</code> - official release with 'trial use' status - posted as an un-ballotedSTU update</li>\n<li><code>normative+trial-use</code> - official release with mixture of trial use and normative content</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludexml<a name=\"ig-parameters-excludexml\"> </a></td><td>excludexml</td><td><div><p>Cause the publisher to exclude the generation of the xml format and to exclude the xml tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludejson<a name=\"ig-parameters-excludejson\"> </a></td><td>excludejson</td><td><div><p>Cause the publisher to exclude the generation of the json format and to exclude the json tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludettl<a name=\"ig-parameters-excludettl\"> </a></td><td>excludettl</td><td><div><p>Cause the publisher to exclude the generation of the ttl format and to exclude the ttl tab from the implementation guide pages.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludemap<a name=\"ig-parameters-excludemap\"> </a></td><td>excludemap</td><td><div><p>If true, causes the mapping tab to be excluded from all StructureDefinition artifact pages</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">excludelogbinaryformat<a name=\"ig-parameters-excludelogbinaryformat\"> </a></td><td>excludelogbinaryformat</td><td><div><p>If true, causes the xml, json and ttl tabs to be excluded for Binary resources when they're examples of logical models</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">shownav<a name=\"ig-parameters-shownav\"> </a></td><td>shownav</td><td><div><p>Determines whether the next/previous navigation tabs are shown in the header and footer</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">copyrightyear<a name=\"ig-parameters-copyrightyear\"> </a></td><td>copyrightyear</td><td><div><p>The copyright year text to include in the implementation guide footer</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">fmm-definition<a name=\"ig-parameters-fmm-definition\"> </a></td><td>fmm-definition</td><td><div><p>Indicates the URL that provides a definition for the maturity levels declared in the current IG.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">version-comparison<a name=\"ig-parameters-version-comparison\"> </a></td><td>version-comparison</td><td><div><p>Control how the IG publisher does a comparison with a previously published version (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">version-comparison-master<a name=\"ig-parameters-version-comparison-master\"> </a></td><td>version-comparison-master</td><td><div><p>Provide this parameter to instruct the IG publisher to mark up the generated pages with the differences found for the version specified. This version can be listed in version-comparison too but it doesn't need to be. Note that the impact of this parameter is a work in progress</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">ipa-comparison<a name=\"ig-parameters-ipa-comparison\"> </a></td><td>ipa-comparison</td><td><div><p>Control how the IG publisher does a comparison with a IPA (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">ips-comparison<a name=\"ig-parameters-ips-comparison\"> </a></td><td>ips-comparison</td><td><div><p>Control how the IG publisher does a comparison with a IPS (see qa.html). Possible values:</p>\n<ul>\n<li><code>{last}</code> - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear</li>\n<li><code>{current}</code> - compare with the last full published version</li>\n<li><code>n/a</code> - don't do any comparison</li>\n<li><code>[v]</code> - a previous version where [v] is the version</li>\n</ul>\n</div></td></tr><tr><td style=\"white-space:nowrap\">bundle-references-resolve<a name=\"ig-parameters-bundle-references-resolve\"> </a></td><td>bundle-references-resolve</td><td><div><p>Whether to require that references in bundles resolve. <code>true</code> means references must resolve within implementation guides or an error is created.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">format-date<a name=\"ig-parameters-format-date\"> </a></td><td>format-date</td><td><div><p>String format to use when rendering date values from resources in the implementation guide.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">format-datetime<a name=\"ig-parameters-format-datetime\"> </a></td><td>format-datetime</td><td><div><p>String format to use when rendering date/time values from resources in the implementation guide.</p>\n<p>Note: see <a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html\">Patterns for Formatting and Parsing</a> for Java String formats</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-modifiers<a name=\"ig-parameters-no-modifiers\"> </a></td><td>no-modifiers</td><td><div><p>If set to <code>true</code>, it means that all profiles created within the implementation guide will have their differential modified to set maxOccurs=0 on all <code>isModifier</code> elements that are not explicitly mentioned in the original source differential.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">jekyll-timeout<a name=\"ig-parameters-jekyll-timeout\"> </a></td><td>jekyll-timeout</td><td><div><p>How long to let Jekyll run before giving up on it (seconds)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">suppressed-ids<a name=\"ig-parameters-suppressed-ids\"> </a></td><td>suppressed-ids</td><td><div><p>A comma separated list of resource ids to suppress ids when they are rendered in the Implementation Guide.</p>\n<p>This is useful because the IG publication process requires all resources to have ids, so they can be handled. But in some Implementation Guides, some examples should not have ids .e.g showing an example of posting a new resource. If the resource is listed here, the id will be removed in the publication (but not the package, where the resources must have ids).\nThe format is either type/id, or just id. Repeating parameters just add more to the list. If the parameter is present with the special value $examples, then all examples will have ids suppressed\nIf the parameter is not present, then all resources will have ids.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">tabbed-snapshots<a name=\"ig-parameters-tabbed-snapshots\"> </a></td><td>tabbed-snapshots</td><td><div><p>A boolean that indicates that the implementation guide leverages tabs to include alternate dictionary views and that tabs for differential, key and/or must-support tables should link to anchors specific to those tables rather than only to the default 'snapshot' keys.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">jira-code<a name=\"ig-parameters-jira-code\"> </a></td><td>jira-code</td><td><div><p>If your IG is published via HL7 and should your package ID diverge from the file name in the JIRA-Spec-Artifacts repository, this parameter will help point to the right file.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">r4-exclusion<a name=\"ig-parameters-r4-exclusion\"> </a></td><td>r4-exclusion</td><td><div><p>For an R4B IG, ignore this profile when considering conversion to R4, or for an R4 IG, omit this when generating the R4 specific package. Value is either '{type}/{id}' or '{url}'</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">r4b-exclusion<a name=\"ig-parameters-r4b-exclusion\"> </a></td><td>r4b-exclusion</td><td><div><p>For an R4 IG, ignore this profile when considering conversion to R4B, or for an R4B IG, omit this when generating the R4B specific package. Value is either '{type}/{id}' or '{url}'</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">produce-jekyll-data<a name=\"ig-parameters-produce-jekyll-data\"> </a></td><td>produce-jekyll-data</td><td><div><p>Produce the resources as .json in the jekyll _data folder. Note that Jekyll will fail if any of the resources contain non-ascii characters</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">page-factory<a name=\"ig-parameters-page-factory\"> </a></td><td>page-factory</td><td><div><p>Reference to a <a href=\"page-factories.html\">Page Factory</a></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">globals-in-artifacts<a name=\"ig-parameters-globals-in-artifacts\"> </a></td><td>globals-in-artifacts</td><td><div><p>If true, causes the list of global profiles to appear at the top of the Artifacts Summary page</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">noRootToc<a name=\"ig-parameters-noRootToc\"> </a></td><td>No root table-of-contents</td><td><div><p>If true, causes the ig to not inject a root 'toc' page if that's not already the root (only functions in templates that do this by default)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">artifactsOnRoot<a name=\"ig-parameters-artifactsOnRoot\"> </a></td><td>Artifacts on root</td><td><div><p>If true, causes artifact pages to be created as children of the IG's 'root' page rather than the 'artifacts' page (if the template supports doing that)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">conversion-version<a name=\"ig-parameters-conversion-version\"> </a></td><td>conversion-version</td><td><div><p>Defines an additional version of the FHIR definitions to load for version conversion maps. Value is either RX or V.V (e.g. R4 or 4.0). Additional versions are loaded with modified URLs (e.g. R4 is loaded to http://hl7.org.fhir/4.0)</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">defaultVersion<a name=\"ig-parameters-defaultVersion\"> </a></td><td>defaultVersion</td><td><div><p>Lloyd to provide definition</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">no-usage-check<a name=\"ig-parameters-no-usage-check\"> </a></td><td>no-usage-check</td><td><div><p>No Warning in QA if there are extensions/profiles that are not used in this IG</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">i18n-default-lang<a name=\"ig-parameters-i18n-default-lang\"> </a></td><td>i18n-default-lang</td><td><div><p>The default language (e.g. <a href=\"http://hl7.org/fhir/R5/resource.html#Resource\">Resource.language</a>) to assume in the IG when the resource and/or the element context doesn't specify a language</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">i18n-lang<a name=\"ig-parameters-i18n-lang\"> </a></td><td>i18n-lang</td><td><div><p>A language to translate the IG into. note that i18n-default-lang is automatically a language, and doesn't need to be restated</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">translation-sources<a name=\"ig-parameters-translation-sources\"> </a></td><td>translation-sources</td><td><div><p>A folder in which to look for translation source files - .po or .xliff or .json</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">translation-supplements<a name=\"ig-parameters-translation-supplements\"> </a></td><td>translation-supplements</td><td><div><p>A folder in which to look for translation supplements - .po or .xliff or .json. This is deprecated - use translation-sources instead</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">display-warnings<a name=\"ig-parameters-display-warnings\"> </a></td><td>display-warnings</td><td><div><p>Instruct the terminology layer that wrong displays result in a warning not an error</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">logged-when-scanning<a name=\"ig-parameters-logged-when-scanning\"> </a></td><td>logged-when-scanning</td><td><div><p>Whether to report issues when scanning files for resources. Valid values are: true, false, stack</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">validation-duration-report-cutoff<a name=\"ig-parameters-validation-duration-report-cutoff\"> </a></td><td>validation-duration-report-cutoff</td><td><div><p>An integer value that specifies the a number of seconds. If any resource takes longer than that time, it will be reported in the log</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">viewDefinition<a name=\"ig-parameters-viewDefinition\"> </a></td><td>viewDefinition</td><td><div><p>A ViewDefinition to execute (path to file). Output is added in the package.db file as a generated table, and can be used in the page contents. See also <a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/sql.html\">documentation</a></p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">fixed-value-format<a name=\"ig-parameters-fixed-value-format\"> </a></td><td>Fixed Value Format Code</td><td><div><p>A code that indicates how to format fixed and pattern values. Valid values for this parameter are json | json-all | xml | all-xml. The -all options relate to primitives - whether they are shown just as a value or as a formatted fragment</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\">auto-oid-root<a name=\"ig-parameters-auto-oid-root\"> </a></td><td>OID root for automatically assigned OIDs</td><td><div><p>Defines the OID root for the IG. Must be globally unique. Contact the FHIR product director or deputy for an assignment, though you can assign your own if you wish. If this is present, any canonical resources that do not have OIDs assigned manually will have OIDs automatically assigned by the publisher. The OID assignments are stored in oids.ini next to the IG resource for the IG, and must be committed with other changes to the source.</p>\n</div></td></tr></table></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/codesystem-use-markdown",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}
],
"url" : "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.1.16.9"
}
],
"version" : "0.2.0-snapshot",
"name" : "IGParameters",
"title" : "IG Parameter Codes",
"status" : "active",
"experimental" : false,
"date" : "2024-04-25T18:29:34+00:00",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "Ig Parameter Codes Defined by the FHIR Tooling. These parameter codes go in [ImplementationGuide.definition.parameter.code](http://hl7.org/fhir/R4/implementationguide-definitions.html#ImplementationGuide.definition.parameter.code)",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"caseSensitive" : true,
"content" : "complete",
"property" : [
{
"code" : "repeats",
"uri" : "http://hl7.org/fhir/tools/CodeSystem/ig-parameters#repeats",
"description" : "Whether the parameter can repeat more than once",
"type" : "boolean"
},
{
"code" : "string-format",
"uri" : "http://hl7.org/fhir/tools/CodeSystem/ig-parameters#string-format",
"description" : "Description of the value domain for the values of the parameter. Note: all values are strings, this provides additional information about what can go in the string",
"type" : "string"
},
{
"code" : "missing",
"uri" : "http://hl7.org/fhir/tools/CodeSystem/ig-parameters#missing",
"description" : "What it means if the parameter is not provided",
"type" : "string"
}
],
"concept" : [
{
"code" : "logging",
"display" : "logging",
"definition" : "Which kinds of log output messages to produce - the value is a code, from this list:\n\n* ```init```: Messages describing the start up process (for debugging)\n* ```progress```: Overall progress messages\n* ```tx```: Messages describing the use of the terminology server (for debugging)\n* ```generate```: Log when producing an individual resource (troubleshooting only - leave off)\n* ```html```: Log when validating an html page (troubleshooting only - leave off)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(list)"
},
{
"code" : "missing",
"valueString" : "no logging"
}
]
},
{
"code" : "generate",
"display" : "generate",
"definition" : "Fine grained control over generation of resources:\n\n* ```example-narratives```: generate narrative in examples if they don't have any (as opposed to conformance resources, which are always generated)\n* ```genExamples```: produce extra examples (todo: document this)\n\nExcept: you can't turn example-narratives off. Todo: decide why this exists. But you can suppress - see next item",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(list)"
},
{
"code" : "missing",
"valueString" : "no extra narrative"
}
]
},
{
"code" : "no-narrative",
"display" : "no-narrative",
"definition" : "A resource to suppress narrative generation for (and Resource.text will be removed if found). Format is ```(type)/(id)``` e.g. ```Patient/example```, or type or id may be ```*``` e.g. ```Task/*``` - do not generate narrative for any Task resource.\n\nNarrative Generation should never be suppressed for any canonical resource\n\nNote for HL7 users: the FMG will review which resources have narrative suppressed and why when publication approval is sought",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "mask(resource)"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "no-validate",
"display" : "no-validate",
"definition" : "A resource not to validate. Format is ```(type)/(id)``` e.g. ```Patient/example```, or type or id may be ```*``` e.g. ```Task/*``` - do not validate any Task resource.\n\nSuppressing validation is generally a bad idea. There's two contexts where it might be useful: validation of really big resources that takes a long time, and examples that are purposefully wrong to demonstrate what not to do. But while it sounds good - don't bother me with problems I mean to introduce, it's too easy for other unintended problems to accumulate. So it's better to keep validation on.\n\note for HL7 users: the FMG will review which resources have validation suppressed and why when publication approval is sought. FMG would generally prefer to see explicit errors for resources that are wrong intentionally, and will OK publication in this case. **It's going to reviewed either way.**",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "mask(resource)"
},
{
"code" : "missing",
"valueString" : "na"
}
]
},
{
"code" : "no-check-usage",
"display" : "no-check-usage",
"definition" : "Do not check usage for extensions and data types - for IGs where they are being defined for use elsewhere",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "do check usage"
}
]
},
{
"code" : "path-resource",
"display" : "path-resource",
"definition" : "Relative path to a location in the IG repository from which to load resources. If the path ends in /*, then that means all sub-folders",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "\\resources"
}
]
},
{
"code" : "path-binary",
"display" : "path-binary",
"definition" : "Relative path to a location in the IG repository in which to look for binary adjunct files (see below)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "autoload-resources",
"display" : "autoload-resources",
"definition" : "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.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "codesystem-property",
"display" : "codesystem-property",
"definition" : "A 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```",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "uri"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "path-pages",
"display" : "path-pages",
"definition" : "A relative path in which pages can be found.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "\\pages"
}
]
},
{
"code" : "path-data",
"display" : "path-data",
"definition" : "A relative path in which data files can be found (will go in _data for Jekyll).",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "no data files copied"
}
]
},
{
"code" : "path-qa",
"display" : "path-qa",
"definition" : "The relative path to the qa folder (generated fragments to check rendering in browser).",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "no qa is produced"
}
]
},
{
"code" : "path-tx-cache",
"display" : "path-tx-cache",
"definition" : "The relative path to the terminology cache.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "no value - txCache not in version control (slower builds)"
}
]
},
{
"code" : "path-liquid",
"display" : "path-liquid",
"definition" : "A relative path that contains liquid templates for generating narrative",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "path-temp",
"display" : "path-temp",
"definition" : "The relative path to use for jekyll processing.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "temp"
}
]
},
{
"code" : "path-output",
"display" : "path-output",
"definition" : "The relative path where the output is generated.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "output (which must be the case for the ci-build scripts)"
}
]
},
{
"code" : "path-history",
"display" : "path-history",
"definition" : "The url where the history file is found (usually ```(canonical)/history.html```). Used when checking links",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "url"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "path-expansion-params",
"display" : "path-expansion-params",
"definition" : "The relative path to a parameters resource that contains expansion parameters used when the IG publisher expands a value set",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "No expansion parameters"
}
]
},
{
"code" : "path-suppressed-warnings",
"display" : "path-suppressed-warnings",
"definition" : "A 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)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "No suppressed warnings"
}
]
},
{
"code" : "path-test",
"display" : "path-test",
"definition" : "Indicates a folder that contains useful testing collateral to include a /test folder in the package. If more than one value is provided, the contents are all added to the one folder (in order)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "No /test folder in the package"
}
]
},
{
"code" : "html-exempt",
"display" : "html-exempt",
"definition" : "A mask that identifies specific HTML files exempt from having header / footer etc.\n\nDiscuss with FHIR Product Manager before using in any HL7 IG",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "mask(file)"
},
{
"code" : "missing",
"valueString" : "No exempt files"
}
]
},
{
"code" : "extension-domain",
"display" : "extension-domain",
"definition" : "An external domain from which extensions are allowed to come (else they'll be flagged as invalid when validating). ```http://example.org``` is always allowed",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "url"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "active-tables",
"display" : "active-tables",
"definition" : "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: ```<script src='fhir-table-scripts.js'></script>```",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "special-url",
"display" : "special-url",
"definition" : "If 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. Each canonical url must be listed in full as present on the resource; it is not possible to specify a pattern.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "url"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "special-url-base",
"display" : "special-url-base",
"definition" : "A common alternative base URL for multiple canonical resources in the IG",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "url"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "template-openapi",
"display" : "template-openapi",
"definition" : "A relative path to the template openapi file to use when generating openapi files (e.g. populate openAPI security details)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "no template"
}
]
},
{
"code" : "template-html",
"display" : "template-html",
"definition" : "A relative path to the template to use when rendering html pages",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "?"
}
]
},
{
"code" : "template-md",
"display" : "template-md",
"definition" : "A relative path to the template to use when rendering markdown pages",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "?"
}
]
},
{
"code" : "apply-contact",
"display" : "apply-contact",
"definition" : "if true, overwrite all canonical resource contact details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-contact",
"display" : "default-contact",
"definition" : "if true, populate all canonical resources that don't specify their own contact details with that found in the IG. Ignored if apply-contact is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-context",
"display" : "apply-context",
"definition" : "if true, overwrite all canonical resource context details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-context",
"display" : "default-context",
"definition" : "if true, populate all canonical resources that don't specify their own context details with that found in the IG. Ignored if apply-context is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-copyright",
"display" : "apply-copyright",
"definition" : "if true, overwrite all canonical resource copyright details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-copyright",
"display" : "default-copyright",
"definition" : "if true, populate all canonical resources that don't specify their own copyright details with that found in the IG. Ignored if apply-copyright is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-jurisdiction",
"display" : "apply-jurisdiction",
"definition" : "if true, overwrite all canonical resource jurisdiction details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-jurisdiction",
"display" : "default-jurisdiction",
"definition" : "if true, populate all canonical resources that don't specify their own jurisdiction details with that found in the IG. Ignored if apply-jurisdiction is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-license",
"display" : "apply-license",
"definition" : "if true, overwrite all canonical resource license details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-license",
"display" : "default-license",
"definition" : "if true, populate all canonical resources that don't specify their own license details with that found in the IG. Ignored if apply-license is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-publisher",
"display" : "apply-publisher",
"definition" : "if true, overwrite all canonical resource publisher details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-publisher",
"display" : "default-publisher",
"definition" : "if true, populate all canonical resources that don't specify their own publisher details with that found in the IG. Ignored if apply-publisher is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-version",
"display" : "apply-version",
"definition" : "if true, overwrite all canonical resource version details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-version",
"display" : "default-version",
"definition" : "if true, populate all canonical resources that don't specify their own version details with that found in the IG. Ignored if apply-version is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "apply-wg",
"display" : "apply-wg",
"definition" : "if true, overwrite all canonical resource WG details with that found in the IG.\n\n(Note: the ig-template-base template, on which almost all IG templates are based, sets this to parameter to true unless it has been explicitly set.)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "default-wg",
"display" : "default-wg",
"definition" : "if true, populate all canonical resources that don't specify their own WG details with that found in the IG. Ignored if apply-contact is true.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "propagate-status",
"display" : "propagate-status",
"definition" : "If true, indicates that the FMM and Standards Status declarations from top-level artifacts should be propagated to any dependencies that don't declare their own values. If different statuses or maturity level would propagate to a dependency from different artifacts, the 'highest' FMM or most mature standards status will apply (Normative or Informative, then STU, then Draft). Information does not propagate to artifacts marked as examples or as experimental.\nPropagation is based on references. E.g. the IG references everything (so its status will propagate everywhere by default). If there are higher statuses on certain CapabilityStatements, Operations or Profiles, those status will propagate to the artifacts they reference, such as other profiles, ValueSets or CodeSystems.\nPropagation only happens within the context of an IG. There is no propagation across artifacts present in other IG packages listed as dependencies.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "validation",
"display" : "validation",
"definition" : "Fine grained control over validation flags when validating resources / IGs:\n\n* ```check-must-support```: Does nothing! (for now?)\n* ```allow-any-extensions```: Allow any extensions at all (and therefore miss accidental broken extension references)\n* ```check-aggregation```: check that aggregation is correct (in IGs, bundles are often broken up for publishing / documentation purposes)\n* ```no-broken-links```: forbid broken links in HTML pages - stop the build if any are found\n* ```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",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(list)"
},
{
"code" : "missing",
"valueString" : "none of the options"
}
]
},
{
"code" : "show-inherited-invariants",
"display" : "show-inherited-invariants",
"definition" : "faIf true, render inherited constraints in the full details and invariants viewlse",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "true"
}
]
},
{
"code" : "allow-extensible-warnings",
"display" : "allow-extensible-warnings",
"definition" : "if true, show the warning when codes are not in extensible bindings",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "usage-stats-opt-out",
"display" : "usage-stats-opt-out",
"definition" : "If 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```).",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "generate-version",
"display" : "generate-version",
"definition" : "Request that the IG publisher generate packages for additional versions than the stated version e.g. the IG might be for authored against version 4.0, but also produce an R3 version.\n\nFor each occurence of this parameter, the IG publisher will produce an extra package, with the filename id.ver.tgz where id is the main id of the ig, and ver is the parameter value. (note that this is different to the main package which is always called package.tgz). \n\nThis parameter can have one one of following values:\n\n* r2\n* r2b\n* r3\n* r4\n* r5\n\nThis parameter should be used with great care, and only after consulting the FHIR Product director to consider all of it's ramifications. It's generally only appropriate for terminology resources.\n It's not an error to generate the same version as the IG itself - this is typically done for consistency of use across versions",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(http://hl7.org/fhir/ValueSet/FHIR-version)"
},
{
"code" : "missing",
"valueString" : "n/a"
}
]
},
{
"code" : "releaselabel",
"display" : "releaselabel",
"definition" : "The release label at the top of the page - values:\n\n* ```ci-build``` - the continuous integration build release (not stable)\n* ```draft``` - draft version\n* ```qa-preview``` - frozen snapshot for non-ballot feedback\n* ```ballot``` - frozen snapshot for ballot\n* ```trial-use``` - official release with 'trial use' status\n* ```release``` - official release for use\n* ```update``` - official release with 'trial use' status - posted as an un-ballotedSTU update\n* ```normative+trial-use``` - official release with mixture of trial use and normative content",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "?"
}
]
},
{
"code" : "excludexml",
"display" : "excludexml",
"definition" : "Cause the publisher to exclude the generation of the xml format and to exclude the xml tab from the implementation guide pages.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "excludejson",
"display" : "excludejson",
"definition" : "Cause the publisher to exclude the generation of the json format and to exclude the json tab from the implementation guide pages.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "excludettl",
"display" : "excludettl",
"definition" : "Cause the publisher to exclude the generation of the ttl format and to exclude the ttl tab from the implementation guide pages.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "excludemap",
"display" : "excludemap",
"definition" : "If true, causes the mapping tab to be excluded from all StructureDefinition artifact pages",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "excludelogbinaryformat",
"display" : "excludelogbinaryformat",
"definition" : "If true, causes the xml, json and ttl tabs to be excluded for Binary resources when they're examples of logical models",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "true"
}
]
},
{
"code" : "shownav",
"display" : "shownav",
"definition" : "Determines whether the next/previous navigation tabs are shown in the header and footer",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "true"
}
]
},
{
"code" : "copyrightyear",
"display" : "copyrightyear",
"definition" : "The copyright year text to include in the implementation guide footer",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "?"
}
]
},
{
"code" : "fmm-definition",
"display" : "fmm-definition",
"definition" : "Indicates the URL that provides a definition for the maturity levels declared in the current IG.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "url"
},
{
"code" : "missing",
"valueString" : "maturity levels will not be rendered"
}
]
},
{
"code" : "version-comparison",
"display" : "version-comparison",
"definition" : "Control how the IG publisher does a comparison with a previously published version (see qa.html). Possible values:\n\n* ```{last}``` - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear\n* ```{current}``` - compare with the last full published version \n* ```n/a``` - don't do any comparison\n* ```[v]``` - a previous version where [v] is the version",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(list)"
},
{
"code" : "missing",
"valueString" : "last version with same status"
}
]
},
{
"code" : "version-comparison-master",
"display" : "version-comparison-master",
"definition" : "Provide this parameter to instruct the IG publisher to mark up the generated pages with the differences found for the version specified. This version can be listed in version-comparison too but it doesn't need to be. Note that the impact of this parameter is a work in progress",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "code(ig-versions)"
},
{
"code" : "missing",
"valueString" : "no annotations about versions in the produced content"
}
]
},
{
"code" : "ipa-comparison",
"display" : "ipa-comparison",
"definition" : "Control how the IG publisher does a comparison with a IPA (see qa.html). Possible values:\n\n* ```{last}``` - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear\n* ```{current}``` - compare with the last full published version \n* ```n/a``` - don't do any comparison\n* ```[v]``` - a previous version where [v] is the version",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(ips-versions)"
},
{
"code" : "missing",
"valueString" : "don't compare"
}
]
},
{
"code" : "ips-comparison",
"display" : "ips-comparison",
"definition" : "Control how the IG publisher does a comparison with a IPS (see qa.html). Possible values:\n\n* ```{last}``` - compare with the last published version (whatever it's status) - this is the default if the parameter doesn't appear\n* ```{current}``` - compare with the last full published version \n* ```n/a``` - don't do any comparison\n* ```[v]``` - a previous version where [v] is the version",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(list)"
},
{
"code" : "missing",
"valueString" : "don't compare"
}
]
},
{
"code" : "bundle-references-resolve",
"display" : "bundle-references-resolve",
"definition" : "Whether to require that references in bundles resolve. ```true``` means references must resolve within implementation guides or an error is created.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "true"
}
]
},
{
"code" : "format-date",
"display" : "format-date",
"definition" : "String format to use when rendering date values from resources in the implementation guide.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "yyyy-MM-dd"
}
]
},
{
"code" : "format-datetime",
"display" : "format-datetime",
"definition" : "String format to use when rendering date/time values from resources in the implementation guide.\n\nNote: see [Patterns for Formatting and Parsing](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html) for Java String formats",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "yyyy-MM-dd hh:mm:ssZZZ"
}
]
},
{
"code" : "no-modifiers",
"display" : "no-modifiers",
"definition" : "If set to ```true```, it means that all profiles created within the implementation guide will have their differential modified to set maxOccurs=0 on all ```isModifier``` elements that are not explicitly mentioned in the original source differential.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "false"
}
]
},
{
"code" : "jekyll-timeout",
"display" : "jekyll-timeout",
"definition" : "How long to let Jekyll run before giving up on it (seconds)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "integer"
},
{
"code" : "missing",
"valueString" : "300"
}
]
},
{
"code" : "suppressed-ids",
"display" : "suppressed-ids",
"definition" : "A comma separated list of resource ids to suppress ids when they are rendered in the Implementation Guide.\n\nThis is useful because the IG publication process requires all resources to have ids, so they can be handled. But in some Implementation Guides, some examples should not have ids .e.g showing an example of posting a new resource. If the resource is listed here, the id will be removed in the publication (but not the package, where the resources must have ids).\nThe format is either type/id, or just id. Repeating parameters just add more to the list. If the parameter is present with the special value $examples, then all examples will have ids suppressed\nIf the parameter is not present, then all resources will have ids.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "don't suppress ids"
}
]
},
{
"code" : "tabbed-snapshots",
"display" : "tabbed-snapshots",
"definition" : "A boolean that indicates that the implementation guide leverages tabs to include alternate dictionary views and that tabs for differential, key and/or must-support tables should link to anchors specific to those tables rather than only to the default 'snapshot' keys.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "Generate all table links to point to the 'snapshot' anchors"
}
]
},
{
"code" : "jira-code",
"display" : "jira-code",
"definition" : "If your IG is published via HL7 and should your package ID diverge from the file name in the JIRA-Spec-Artifacts repository, this parameter will help point to the right file.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "code(jira-codes)"
},
{
"code" : "missing",
"valueString" : "use package ID for locating spec file in JIRA-Spec-Artifacts"
}
]
},
{
"code" : "r4-exclusion",
"display" : "r4-exclusion",
"definition" : "For an R4B IG, ignore this profile when considering conversion to R4, or for an R4 IG, omit this when generating the R4 specific package. Value is either '{type}/{id}' or '{url}'",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "special"
},
{
"code" : "missing",
"valueString" : "don't ignore any profiles"
}
]
},
{
"code" : "r4b-exclusion",
"display" : "r4b-exclusion",
"definition" : "For an R4 IG, ignore this profile when considering conversion to R4B, or for an R4B IG, omit this when generating the R4B specific package. Value is either '{type}/{id}' or '{url}'",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "special"
},
{
"code" : "missing",
"valueString" : "don't ignore any profiles"
}
]
},
{
"code" : "produce-jekyll-data",
"display" : "produce-jekyll-data",
"definition" : "Produce the resources as .json in the jekyll _data folder. Note that Jekyll will fail if any of the resources contain non-ascii characters",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "don't produce data files for Jekyll"
}
]
},
{
"code" : "page-factory",
"display" : "page-factory",
"definition" : "Reference to a [Page Factory](page-factories.html)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "don't produce any pages"
}
]
},
{
"code" : "globals-in-artifacts",
"display" : "globals-in-artifacts",
"definition" : "If true, causes the list of global profiles to appear at the top of the Artifacts Summary page",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "don't put the globals fragment in the artifact summary"
}
]
},
{
"code" : "noRootToc",
"display" : "No root table-of-contents",
"definition" : "If true, causes the ig to not inject a root 'toc' page if that's not already the root (only functions in templates that do this by default)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "Insert a table-of-contents page as the root of the IG (if the template supports doing that)"
}
]
},
{
"code" : "artifactsOnRoot",
"display" : "Artifacts on root",
"definition" : "If true, causes artifact pages to be created as children of the IG's 'root' page rather than the 'artifacts' page (if the template supports doing that)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "Place artifact pages as children of the IG's 'root' page rather than 'artifacts' page (if the template supports doing that)"
}
]
},
{
"code" : "conversion-version",
"display" : "conversion-version",
"definition" : "Defines an additional version of the FHIR definitions to load for version conversion maps. Value is either RX or V.V (e.g. R4 or 4.0). Additional versions are loaded with modified URLs (e.g. R4 is loaded to http://hl7.org.fhir/4.0)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(http://hl7.org/fhir/ValueSet/FHIR-version)"
},
{
"code" : "missing",
"valueString" : "No other versions are loaded to support version conversion maps"
}
]
},
{
"code" : "defaultVersion",
"display" : "defaultVersion",
"definition" : "Lloyd to provide definition",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "Lloyd to define"
}
]
},
{
"code" : "no-usage-check",
"display" : "no-usage-check",
"definition" : "No Warning in QA if there are extensions/profiles that are not used in this IG",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "Usage check appliese"
}
]
},
{
"code" : "i18n-default-lang",
"display" : "i18n-default-lang",
"definition" : "The default language (e.g. [[[Resource.language]]]) to assume in the IG when the resource and/or the element context doesn't specify a language",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "code(http://hl7.org/fhir/ValueSet/all-languages)"
},
{
"code" : "missing",
"valueString" : "No default language - Multi-language services are not enabled"
}
]
},
{
"code" : "i18n-lang",
"display" : "i18n-lang",
"definition" : "A language to translate the IG into. note that i18n-default-lang is automatically a language, and doesn't need to be restated",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "code(http://hl7.org/fhir/ValueSet/all-languages)"
},
{
"code" : "missing",
"valueString" : "No additional languages"
}
]
},
{
"code" : "translation-sources",
"display" : "translation-sources",
"definition" : "A folder in which to look for translation source files - .po or .xliff or .json",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "No translation supplements"
}
]
},
{
"code" : "translation-supplements",
"display" : "translation-supplements",
"definition" : "A folder in which to look for translation supplements - .po or .xliff or .json. This is deprecated - use translation-sources instead",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relative-path"
},
{
"code" : "missing",
"valueString" : "No translation supplements"
}
]
},
{
"code" : "display-warnings",
"display" : "display-warnings",
"definition" : "Instruct the terminology layer that wrong displays result in a warning not an error",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "Wrong displays cause errors"
}
]
},
{
"code" : "logged-when-scanning",
"display" : "logged-when-scanning",
"definition" : "Whether to report issues when scanning files for resources. Valid values are: true, false, stack",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "true|false"
},
{
"code" : "missing",
"valueString" : "errors are reported, but no stack dump"
}
]
},
{
"code" : "validation-duration-report-cutoff",
"display" : "validation-duration-report-cutoff",
"definition" : "An integer value that specifies the a number of seconds. If any resource takes longer than that time, it will be reported in the log",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "integer"
},
{
"code" : "missing",
"valueString" : "default value is 0, in which case no reports will be generated"
}
]
},
{
"code" : "viewDefinition",
"display" : "viewDefinition",
"definition" : "A ViewDefinition to execute (path to file). Output is added in the package.db file as a generated table, and can be used in the page contents. See also [documentation](https://build.fhir.org/ig/FHIR/ig-guidance/sql.html)",
"property" : [
{
"code" : "repeats",
"valueBoolean" : true
},
{
"code" : "string-format",
"valueString" : "relativepath"
},
{
"code" : "missing",
"valueString" : "No view definitions"
}
]
},
{
"code" : "fixed-value-format",
"display" : "Fixed Value Format Code",
"definition" : "A code that indicates how to format fixed and pattern values. Valid values for this parameter are json | json-all | xml | all-xml. The -all options relate to primitives - whether they are shown just as a value or as a formatted fragment",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "string"
},
{
"code" : "missing",
"valueString" : "Default presentation is json"
}
]
},
{
"code" : "auto-oid-root",
"display" : "OID root for automatically assigned OIDs",
"definition" : "Defines the OID root for the IG. Must be globally unique. Contact the FHIR product director or deputy for an assignment, though you can assign your own if you wish. If this is present, any canonical resources that do not have OIDs assigned manually will have OIDs automatically assigned by the publisher. The OID assignments are stored in oids.ini next to the IG resource for the IG, and must be committed with other changes to the source.",
"property" : [
{
"code" : "repeats",
"valueBoolean" : false
},
{
"code" : "string-format",
"valueString" : "oid"
},
{
"code" : "missing",
"valueString" : "OIDs are not automatically assigned"
}
]
}
]
}
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.2.0-snapshot based on FHIR 5.0.0. Generated 2024-04-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change