This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Definition for Code SystemGuideParameterCode
{ "resourceType" : "CodeSystem", "id" : "guide-parameter-code", "meta" : { "lastUpdated" : "2023-03-01T23:03:57.298+11:00", "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"] }, "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/guide-parameter-code</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\">apply<a name=\"guide-parameter-code-apply\"> </a></td><td>Apply Metadata Value</td><td>If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.</td></tr><tr><td style=\"white-space:nowrap\">path-resource<a name=\"guide-parameter-code-path-resource\"> </a></td><td>Resource Path</td><td>The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.</td></tr><tr><td style=\"white-space:nowrap\">path-pages<a name=\"guide-parameter-code-path-pages\"> </a></td><td>Pages Path</td><td>The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.</td></tr><tr><td style=\"white-space:nowrap\">path-tx-cache<a name=\"guide-parameter-code-path-tx-cache\"> </a></td><td>Terminology Cache Path</td><td>The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.</td></tr><tr><td style=\"white-space:nowrap\">expansion-parameter<a name=\"guide-parameter-code-expansion-parameter\"> </a></td><td>Expansion Profile</td><td>The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.</td></tr><tr><td style=\"white-space:nowrap\">rule-broken-links<a name=\"guide-parameter-code-rule-broken-links\"> </a></td><td>Broken Links Rule</td><td>The value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.</td></tr><tr><td style=\"white-space:nowrap\">generate-xml<a name=\"guide-parameter-code-generate-xml\"> </a></td><td>Generate XML</td><td>The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.</td></tr><tr><td style=\"white-space:nowrap\">generate-json<a name=\"guide-parameter-code-generate-json\"> </a></td><td>Generate JSON</td><td>The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.</td></tr><tr><td style=\"white-space:nowrap\">generate-turtle<a name=\"guide-parameter-code-generate-turtle\"> </a></td><td>Generate Turtle</td><td>The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.</td></tr><tr><td style=\"white-space:nowrap\">html-template<a name=\"guide-parameter-code-html-template\"> </a></td><td>HTML Template</td><td>The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).</td></tr></table></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }], "url" : "http://hl7.org/fhir/guide-parameter-code", "identifier" : [{ "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.4.997" }], "version" : "5.0.0-draft-final", "name" : "GuideParameterCode", "title" : "Guide Parameter Code", "status" : "active", "experimental" : true, "publisher" : "HL7 International", "description" : "GuideParameterCode", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" }] }], "caseSensitive" : true, "content" : "complete", "concept" : [{ "code" : "apply", "display" : "Apply Metadata Value", "definition" : "If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext." }, { "code" : "path-resource", "display" : "Resource Path", "definition" : "The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type." }, { "code" : "path-pages", "display" : "Pages Path", "definition" : "The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder." }, { "code" : "path-tx-cache", "display" : "Terminology Cache Path", "definition" : "The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control." }, { "code" : "expansion-parameter", "display" : "Expansion Profile", "definition" : "The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT." }, { "code" : "rule-broken-links", "display" : "Broken Links Rule", "definition" : "The value of this string 0..1 parameter is either \"warning\" or \"error\" (default = \"error\"). If the value is \"warning\" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links." }, { "code" : "generate-xml", "display" : "Generate XML", "definition" : "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML." }, { "code" : "generate-json", "display" : "Generate JSON", "definition" : "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON." }, { "code" : "generate-turtle", "display" : "Generate Turtle", "definition" : "The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle." }, { "code" : "html-template", "display" : "HTML Template", "definition" : "The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating)." }] }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0-draft-final generated on Wed, Mar 1, 2023 23:04+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change