R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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

Codesystem-guide-parameter-code.xml

FHIR Infrastructure Work Group Maturity Level : N/A Ballot Status : Informative

Raw XML ( canonical form + also see XML Format Specification )

Definition for Code System GuideParameterCode

<?xml version="1.0" encoding="UTF-8"?>


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="guide-parameter-code"/> 
  <meta> 
    

    <lastUpdated value="2018-08-19T21:48:56.559+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> GuideParameterCode</h2> 
      <div> 
        

        <p> Code of parameter that is input to the guide.</p> 

      </div> 
      <p> This code system http://hl7.org/fhir/guide-parameter-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-business-version
            <a name="guide-parameter-code-apply-business-version"> </a> 
          </td> 
          <td> Apply Business Version</td> 
          <td> If the value of this boolean 0..1 parameter is &quot;true&quot; then all conformance resources
             will have any specified [Resource].version overwritten with the ImplementationGuide.version

             will have any specified [Resource].version overwritten with the ImplementationGuide.version.</td> 

        </tr> 
        <tr> 
          <td style="white-space:nowrap">apply-jurisdiction
            <a name="guide-parameter-code-apply-jurisdiction"> </a> 
          </td> 
          <td> Apply Jurisdiction</td> 
          <td> If the value of this boolean 0..1 parameter is &quot;true&quot; then all conformance resources
             will have any specified [Resource].jurisdiction overwritten with the ImplementationGuide.jurisdictio
            n

            n.</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

             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

             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

             on the local system, not under version control.</td> 

        </tr> 
        <tr> 
          expansion-profile
            

          <td style="white-space:nowrap">expansion-parameter
            <a name="guide-parameter-code-expansion-parameter"> </a> 
          </td> 
          <td> Expansion Profile</td> 
          The value of this string 0..1 parameter is a path to the ExpansionProfile used when expanding
             value sets for this implementation guide. This is particularly used to specify the versions
             of published terminologies such as SNOMED CT

          <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 &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

             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

             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

             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

             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)

             template for each generated page (see templating).</td> 

        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  

  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueString value="Trial Use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/guide-parameter-code"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.997"/> 
  </identifier> 
  

  <version value="3.5.0"/> 
  <name value="GuideParameterCode"/> 
  <title value="GuideParameterCode"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  

  <date value="2018-08-19T21:48:56+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  

  <description value="Code of parameter that is input to the guide."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/guide-parameter-code"/> 
  <content value="complete"/> 
  <concept> 
    <code value="apply-business-version"/> 
    <display value="Apply Business Version"/> 
    <definition value="If the value of this boolean 0..1 parameter is &quot;true&quot; then all conformance resources
     will have any specified [Resource].version overwritten with the ImplementationGuide.version

     will have any specified [Resource].version overwritten with the ImplementationGuide.version."/> 

  </concept> 
  <concept> 
    <code value="apply-jurisdiction"/> 
    <display value="Apply Jurisdiction"/> 
    <definition value="If the value of this boolean 0..1 parameter is &quot;true&quot; then all conformance resources
     will have any specified [Resource].jurisdiction overwritten with the ImplementationGuide.jurisdictio
    n

    n."/> 

  </concept> 
  <concept> 
    <code value="path-resource"/> 
    <display value="Resource Path"/> 
    <definition value="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

     that is to be scanned to load resources. Scope is (if present) a particular resource type."/> 

  </concept> 
  <concept> 
    <code value="path-pages"/> 
    <display value="Pages Path"/> 
    <definition value="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

     that contains files that are part of the html content processed by the builder."/> 

  </concept> 
  <concept> 
    <code value="path-tx-cache"/> 
    <display value="Terminology Cache Path"/> 
    <definition value="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

     on the local system, not under version control."/> 

  </concept> 
  <concept> 
    

    <code value="expansion-parameter"/> 
    <display value="Expansion Profile"/> 
    The value of this string 0..1 parameter is a path to the ExpansionProfile used when expanding
     value sets for this implementation guide. This is particularly used to specify the versions
     of published terminologies such as SNOMED CT

    <definition value="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."/> 

  </concept> 
  <concept> 
    <code value="rule-broken-links"/> 
    <display value="Broken Links Rule"/> 
    <definition value="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

     links."/> 

  </concept> 
  <concept> 
    <code value="generate-xml"/> 
    <display value="Generate XML"/> 
    <definition value="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

     in XML format. If not present, the Publication Tool decides whether to generate XML."/> 

  </concept> 
  <concept> 
    <code value="generate-json"/> 
    <display value="Generate JSON"/> 
    <definition value="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

     in JSON format. If not present, the Publication Tool decides whether to generate JSON."/> 

  </concept> 
  <concept> 
    <code value="generate-turtle"/> 
    <display value="Generate Turtle"/> 
    <definition value="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

     in Turtle format. If not present, the Publication Tool decides whether to generate Turtle."/> 

  </concept> 
  <concept> 
    <code value="html-template"/> 
    <display value="HTML Template"/> 
    <definition value="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)

     template for each generated page (see templating)."/> 

  </concept> 


</

CodeSystem

>



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.