This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. The current version which supercedes this version is 5.2.0. For a full list of available versions, see the Directory of published versions
Source view
{ "resourceType" : "CodeSystem", "id" : "guide-parameter-code", "meta" : { "lastUpdated" : "2020-04-09T21:10:28.568+00:00" }, "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n \n <h2>GuideParameterCode</h2>\n \n <div>\n \n <p>Code of parameter that is input to the guide.</p>\n\n \n </div>\n \n <p>This code system http://terminology.hl7.org/CodeSystem/guide-parameter-code defines the following codes:</p>\n \n <table class=\"codes\">\n \n <tr>\n \n <td style=\"white-space:nowrap\">\n \n <b>Code</b>\n \n </td>\n \n <td>\n \n <b>Display</b>\n \n </td>\n \n <td>\n \n <b>Definition</b>\n \n </td>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">apply\n \n <a name=\"guide-parameter-code-apply\"> </a>\n \n </td>\n \n <td>Apply Metadata Value</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">path-resource\n \n <a name=\"guide-parameter-code-path-resource\"> </a>\n \n </td>\n \n <td>Resource Path</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">path-pages\n \n <a name=\"guide-parameter-code-path-pages\"> </a>\n \n </td>\n \n <td>Pages Path</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">path-tx-cache\n \n <a name=\"guide-parameter-code-path-tx-cache\"> </a>\n \n </td>\n \n <td>Terminology Cache Path</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">expansion-parameter\n \n <a name=\"guide-parameter-code-expansion-parameter\"> </a>\n \n </td>\n \n <td>Expansion Profile</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">rule-broken-links\n \n <a name=\"guide-parameter-code-rule-broken-links\"> </a>\n \n </td>\n \n <td>Broken Links Rule</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">generate-xml\n \n <a name=\"guide-parameter-code-generate-xml\"> </a>\n \n </td>\n \n <td>Generate XML</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">generate-json\n \n <a name=\"guide-parameter-code-generate-json\"> </a>\n \n </td>\n \n <td>Generate JSON</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">generate-turtle\n \n <a name=\"guide-parameter-code-generate-turtle\"> </a>\n \n </td>\n \n <td>Generate Turtle</td>\n \n <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>\n \n </tr>\n \n <tr>\n \n <td style=\"white-space:nowrap\">html-template\n \n <a name=\"guide-parameter-code-html-template\"> </a>\n \n </td>\n \n <td>HTML Template</td>\n \n <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>\n \n </tr>\n \n </table>\n \n </div>" }, "url" : "http://terminology.hl7.org/CodeSystem/guide-parameter-code", "identifier" : [ { "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.1.1421" } ], "version" : "4.2.0", "name" : "GuideParameterCode", "title" : "GuideParameterCode", "status" : "draft", "experimental" : false, "date" : "2020-04-09T21:10:28+00:00", "publisher" : "HL7 (FHIR Project)", "contact" : [ { "telecom" : [ { "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" } ] } ], "description" : "Code of parameter that is input to the guide.", "caseSensitive" : true, "valueSet" : "http://terminology.hl7.org/ValueSet/guide-parameter-code", "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)." } ] }