Terminology
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
| Responsible Owner: FHIR Infrastructure Work Group | Standards Status : Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification )
Definition
for
Code
System
GuideParameterCode
SystemGuideParameterCode
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------[] a fhir:CodeSystem; fhir:Resource.id [ fhir:value "guide-parameter-code"]; fhir:Resource.meta [ fhir:Meta.lastUpdated [ fhir:value "2019-11-01T09:29:23.356+11:00" ] ]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ]; fhir:Extension.value [ fhir:value "fhir" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "trial-use" ] ], [ fhir:index 2; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ]; fhir:Extension.value [ fhir:value "1" ] ]; fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/guide-parameter-code"]; fhir:CodeSystem.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.997" ] ]; fhir:CodeSystem.version [ fhir:value "4.0.1"]; fhir:CodeSystem.name [ fhir:value "GuideParameterCode"]; fhir:CodeSystem.title [ fhir:value "GuideParameterCode"]; fhir:CodeSystem.status [ fhir:value "draft"]; fhir:CodeSystem.experimental [ fhir:value "false"]; fhir:CodeSystem.date [ fhir:value "2019-11-01T09:29:23+11:00"]; fhir:CodeSystem.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:CodeSystem.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:index 1; fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]<http://hl7.org/fhir/CodeSystem/guide-parameter-code> a fhir:CodeSystem ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "guide-parameter-code"] ; # fhir:meta [ fhir:lastUpdated [ fhir:v "2025-11-10T15:17:08.817+00:00"^^xsd:dateTime ] ] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem guide-parameter-code</b></p><a name=\"guide-parameter-code\"> </a><a name=\"hcguide-parameter-code\"> </a><p>This case-sensitive 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>"^^rdf:XMLLiteral ] ] ; # fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-wg> ] ; fhir:value [ a fhir:Code ; fhir:v "fhir" ]]; fhir:CodeSystem.description [ fhir:value "Code of parameter that is input to the guide."]; fhir:CodeSystem.caseSensitive [ fhir:value "true"]; fhir:CodeSystem.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/guide-parameter-code"]; fhir:CodeSystem.content [ fhir:value "complete"]; fhir:CodeSystem.concept [ fhir:index 0; fhir:CodeSystem.code [ fhir:value "apply" ]; fhir:CodeSystem.display [ fhir:value "Apply Metadata Value" ]; fhir:CodeSystem.definition [ fhir:value "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." ] ], [ fhir:index 1; fhir:CodeSystem.code [ fhir:value "path-resource" ]; fhir:CodeSystem.display [ fhir:value "Resource Path" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 2; fhir:CodeSystem.code [ fhir:value "path-pages" ]; fhir:CodeSystem.display [ fhir:value "Pages Path" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 3; fhir:CodeSystem.code [ fhir:value "path-tx-cache" ]; fhir:CodeSystem.display [ fhir:value "Terminology Cache Path" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 4; fhir:CodeSystem.code [ fhir:value "expansion-parameter" ]; fhir:CodeSystem.display [ fhir:value "Expansion Profile" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 5; fhir:CodeSystem.code [ fhir:value "rule-broken-links" ]; fhir:CodeSystem.display [ fhir:value "Broken Links Rule" ]; fhir:CodeSystem.definition [ fhir:value "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." ] ], [ fhir:index 6; fhir:CodeSystem.code [ fhir:value "generate-xml" ]; fhir:CodeSystem.display [ fhir:value "Generate XML" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 7; fhir:CodeSystem.code [ fhir:value "generate-json" ]; fhir:CodeSystem.display [ fhir:value "Generate JSON" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 8; fhir:CodeSystem.code [ fhir:value "generate-turtle" ]; fhir:CodeSystem.display [ fhir:value "Generate Turtle" ]; fhir:CodeSystem.definition [ fhir: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." ] ], [ fhir:index 9; fhir:CodeSystem.code [ fhir:value "html-template" ]; fhir:CodeSystem.display [ fhir:value "HTML Template" ]; fhir:CodeSystem.definition [ fhir: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)." ] ] .] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status> ] ; fhir:value [ a fhir:Code ; fhir:v "normative" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm> ] ; fhir:value [ a fhir:Integer ; fhir:v 4 ] ] ) ; # fhir:url [ fhir:v "http://hl7.org/fhir/guide-parameter-code"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/guide-parameter-code> ] ; # fhir:identifier ( [ fhir:system [ fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ; fhir:l <urn:ietf:rfc:3986> ] ; fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.4.642.4.997" ] ] ) ; # fhir:version [ fhir:v "6.0.0-ballot3"] ; # fhir:name [ fhir:v "GuideParameterCode"] ; # fhir:title [ fhir:v "Guide Parameter Code"] ; # fhir:status [ fhir:v "active"] ; # fhir:experimental [ fhir:v false] ; # fhir:publisher [ fhir:v "HL7 International"] ; # fhir:description [ fhir:v "GuideParameterCode"] ; # fhir:jurisdiction ( [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ; fhir:l <http://unstats.un.org/unsd/methods/m49/m49.htm> ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] ) ; # fhir:caseSensitive [ fhir:v true] ; # fhir:hierarchyMeaning [] ; # fhir:content [ fhir:v "complete"] ; # fhir:concept ( [ fhir:code [ fhir:v "apply" ] ; fhir:display [ fhir:v "Apply Metadata Value" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "path-resource" ] ; fhir:display [ fhir:v "Resource Path" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "path-pages" ] ; fhir:display [ fhir:v "Pages Path" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "path-tx-cache" ] ; fhir:display [ fhir:v "Terminology Cache Path" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "expansion-parameter" ] ; fhir:display [ fhir:v "Expansion Profile" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "rule-broken-links" ] ; fhir:display [ fhir:v "Broken Links Rule" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "generate-xml" ] ; fhir:display [ fhir:v "Generate XML" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "generate-json" ] ; fhir:display [ fhir:v "Generate JSON" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "generate-turtle" ] ; fhir:display [ fhir:v "Generate Turtle" ] ; fhir:definition [ fhir:v "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." ] ] [ fhir:code [ fhir:v "html-template" ] ; fhir:display [ fhir:v "HTML Template" ] ; fhir:definition [ fhir:v "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
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Mon,
Nov
1,
2019
09:32+1100.
QA
Page
10,
2025
15:19+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change