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.json

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

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

Definition for Code System GuideParameterCode

{
  "resourceType": "CodeSystem",
  "id": "guide-parameter-code",
  "meta": {
    "lastUpdated": "2018-04-03T12:05:46.262+10:00"

  "resourceType" : "CodeSystem",
  "id" : "guide-parameter-code",
  "meta" : {
    "lastUpdated" : "2018-08-19T21:48:56.559+10:00"

  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"

  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"

  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Trial Use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    }
  ],
  "url": "http://hl7.org/fhir/guide-parameter-code",
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:2.16.840.1.113883.4.642.1.997"

  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"

  },
  "version": "3.3.0",
  "name": "GuideParameterCode",
  "status": "draft",
  "experimental": false,
  "date": "2018-04-03T12:05:46+10: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://hl7.org/fhir/ValueSet/guide-parameter-code",
  "content": "complete",
  "concept": [
    {
      "code": "apply-business-version",
      "display": "Apply Business Version",
      "definition": "If the value of this boolean 0..1 parameter is \"true\" then all conformance resources will have any specified [Resource].version overwritten with the ImplementationGuide.version"
    },
    {
      "code": "apply-jurisdiction",
      "display": "Apply Jurisdiction",
      "definition": "If the value of this boolean 0..1 parameter is \"true\" then all conformance resources will have any specified [Resource].jurisdiction overwritten with the ImplementationGuide.jurisdiction"
    },
    {
      "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-profile",
      "display": "Expansion Profile",
      "definition": "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"
    },
    {
      "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"

  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueString" : "Trial Use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1
  }],
  "url" : "http://hl7.org/fhir/guide-parameter-code",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.997"
  }],
  "version" : "3.5.0",
  "name" : "GuideParameterCode",
  "title" : "GuideParameterCode",
  "status" : "draft",
  "experimental" : false,
  "date" : "2018-08-19T21:48:56+10:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"

    },
    {
      "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)"
    }
  ]

      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Code of parameter that is input to the guide.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/guide-parameter-code",
  "content" : "complete",
  "concept" : [{
    "code" : "apply-business-version",
    "display" : "Apply Business Version",
    "definition" : "If the value of this boolean 0..1 parameter is \"true\" then all conformance resources will have any specified [Resource].version overwritten with the ImplementationGuide.version."
  },
  {
    "code" : "apply-jurisdiction",
    "display" : "Apply Jurisdiction",
    "definition" : "If the value of this boolean 0..1 parameter is \"true\" then all conformance resources will have any specified [Resource].jurisdiction overwritten with the ImplementationGuide.jurisdiction."
  },
  {
    "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.