FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions

: Guide Parameter Code - JSON Representation

Page standards status: Informative

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "guide-parameter-code",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <p>This code system \n              <code>http://hl7.org/fhir/guide-parameter-code</code> defines the following codes:\n            </p>\n            <table class=\"codes\">\n              <tr>\n                <td style=\"white-space:nowrap\">\n                  <b>Code</b>\n                </td>\n                <td>\n                  <b>Display</b>\n                </td>\n                <td>\n                  <b>Definition</b>\n                </td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">apply\n                  <a name=\"guide-parameter-code-apply\"> </a>\n                </td>\n                <td>Apply Metadata Value</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">path-resource\n                  <a name=\"guide-parameter-code-path-resource\"> </a>\n                </td>\n                <td>Resource Path</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">path-pages\n                  <a name=\"guide-parameter-code-path-pages\"> </a>\n                </td>\n                <td>Pages Path</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">path-tx-cache\n                  <a name=\"guide-parameter-code-path-tx-cache\"> </a>\n                </td>\n                <td>Terminology Cache Path</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">expansion-parameter\n                  <a name=\"guide-parameter-code-expansion-parameter\"> </a>\n                </td>\n                <td>Expansion Profile</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">rule-broken-links\n                  <a name=\"guide-parameter-code-rule-broken-links\"> </a>\n                </td>\n                <td>Broken Links Rule</td>\n                <td>The value of this string 0..1 parameter is either &quot;warning&quot; or &quot;error&quot; (default = &quot;error&quot;). If the value is &quot;warning&quot; then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.</td>\n              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">generate-xml\n                  <a name=\"guide-parameter-code-generate-xml\"> </a>\n                </td>\n                <td>Generate XML</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">generate-json\n                  <a name=\"guide-parameter-code-generate-json\"> </a>\n                </td>\n                <td>Generate JSON</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">generate-turtle\n                  <a name=\"guide-parameter-code-generate-turtle\"> </a>\n                </td>\n                <td>Generate Turtle</td>\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              </tr>\n              <tr>\n                <td style=\"white-space:nowrap\">html-template\n                  <a name=\"guide-parameter-code-html-template\"> </a>\n                </td>\n                <td>HTML Template</td>\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              </tr>\n            </table>\n          </div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "packageId",
          "valueId" : "hl7.fhir.uv.xver-r5.r4"
        },
        {
          "url" : "version",
          "valueString" : "0.0.1-snapshot-2"
        }
      ],
      "url" : "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }
  ],
  "url" : "http://hl7.org/fhir/guide-parameter-code",
  "version" : "5.0.0",
  "name" : "GuideParameterCode",
  "title" : "Guide Parameter Code",
  "status" : "active",
  "experimental" : true,
  "date" : "2025-09-13T16:55:28-04:00",
  "publisher" : "FHIR Infrastructure",
  "contact" : [
    {
      "name" : "FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "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)."
    }
  ]
}