Terminology Change Set Exchange
1.0.0 - STU1 International flag

Terminology Change Set Exchange, published by HL7 International / Terminology Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/termchangeset-ig/ and changes regularly. See the Directory of published versions

: ChangeSet TerminologyCapabilities Example - XML Representation

Page standards status: Informative

Raw xml | Download


<TerminologyCapabilities xmlns="http://hl7.org/fhir">
  <id value="ChangeSetTerminologyCapabilitiesExample"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/termchangeset/StructureDefinition/changeset-terminologycapabilities-profile"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: TerminologyCapabilities ChangeSetTerminologyCapabilitiesExample</b></p><a name="ChangeSetTerminologyCapabilitiesExample"> </a><a name="hcChangeSetTerminologyCapabilitiesExample"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-changeset-terminologycapabilities-profile.html">Change Set TerminologyCapabilities (TerminologyCapabilities)</a></p></div><p><b>Update Methods</b>: <span title="Codes:{http://hl7.org/fhir/uv/termchangeset/CodeSystem/update-methods-codesystem RF2}">Release Format 2</span></p><p><b>Update Methods</b>: <span title="Codes:{http://hl7.org/fhir/uv/termchangeset/CodeSystem/update-methods-codesystem FHIRChangeSet}">FHIR ChangeSet</span></p><p><b>StructureDefinition Work Group</b>: vocab</p><p><b>url</b>: <a href="TerminologyCapabilities-ChangeSetTerminologyCapabilitiesExample.html">TerminologyCapabilities ChangeSet TerminologyCapabilities Example</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: ChangeSet TerminologyCapabilities Example</p><p><b>status</b>: Active</p><p><b>date</b>: 2025-07-16 12:34:07+0000</p><p><b>publisher</b>: HL7 International / Terminology Infrastructure</p><p><b>contact</b>: <a href="http://www.hl7.org/Special/committees/Vocab">http://www.hl7.org/Special/committees/Vocab</a></p><p><b>jurisdiction</b>: <span title="Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}">Global (Whole world)</span></p><p><b>kind</b>: Instance</p><h3>Implementations</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Description</b></td><td><b>Url</b></td></tr><tr><td style="display: none">*</td><td>TX.FHIR.ORG Terminology Server</td><td><a href="http://tx.fhir.org/r4/">http://tx.fhir.org/r4/</a></td></tr></table><blockquote><p><b>codeSystem</b></p><p><b>uri</b>: <code>http://cap.org/eCP</code></p><h3>Versions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>4.000.001</td></tr></table></blockquote><blockquote><p><b>codeSystem</b></p><p><b>uri</b>: <a href="http://hl7.org/fhir/R4/codesystem-cdshooks-indicator.html">Indicator</a></p><h3>Versions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>4.0.1</td></tr></table></blockquote><blockquote><p><b>codeSystem</b></p><p><b>uri</b>: <code>http://devices.fhir.org/CodeSystem/MDC-concept-status</code></p></blockquote><blockquote><p><b>codeSystem</b></p><p><b>uri</b>: <code>http://devices.fhir.org/CodeSystem/MDC-designation-use</code></p></blockquote><blockquote><p><b>expansion</b></p><blockquote><p><b>parameter</b></p><p><b>name</b>: cache-id</p><p><b>documentation</b>: This server supports caching terminology resources between calls. Clients only need to send value sets and codesystems once; there after they are automatically in scope for calls with the same cache-id. The cache is retained for 30 min from last call</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: tx-resource</p><p><b>documentation</b>: Additional valuesets needed for evaluation e.g. value sets referred to from the import statement of the value set being expanded</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: _incomplete</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: abstract</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: activeOnly</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: check-system-version</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: count</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: default-to-latest-version</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: displayLanguage</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: excludeNested</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: excludeNotForUI</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: excludePostCoordinated</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: force-system-version</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: inactive</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: includeAlternateCodes</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: includeDefinition</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: includeDesignations</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: incomplete-ok</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: limitedExpansion</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: mode</p><p><b>documentation</b>: =lenient-display-validation</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: no-cache</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: offset</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: profile</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: property</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: system-version</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: valueSetMode</p><p><b>documentation</b>: = CHECK_MEMBERSHIP_ONLY | NO_MEMBERSHIP_CHECK</p></blockquote></blockquote></div>
  </text>
  <extension
             url="http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods">
    <valueCodeableConcept>
      <coding>
        <system
                value="http://hl7.org/fhir/uv/termchangeset/CodeSystem/update-methods-codesystem"/>
        <code value="RF2"/>
        <display value="Release Format 2"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension
             url="http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods">
    <valueCodeableConcept>
      <coding>
        <system
                value="http://hl7.org/fhir/uv/termchangeset/CodeSystem/update-methods-codesystem"/>
        <code value="FHIRChangeSet"/>
        <display value="FHIR ChangeSet"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/>
  </extension>
  <url value="http://tx.fhir.org/r4/TerminologyCapabilities/tx"/>
  <version value="1.0.0"/>
  <name value="ChangeSet TerminologyCapabilities Example"/>
  <status value="active"/>
  <date value="2025-07-16T12:34:07.198Z"/>
  <publisher value="HL7 International / Terminology Infrastructure"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/Vocab"/>
    </telecom>
  </contact>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <kind value="instance"/>
  <implementation>
    <description value="TX.FHIR.ORG Terminology Server"/>
    <url value="http://tx.fhir.org/r4/"/>
  </implementation>
  <codeSystem>
    <uri value="http://cap.org/eCP"/>
    <version>
      <code value="4.000.001"/>
    </version>
  </codeSystem>
  <codeSystem>
    <uri value="http://cds-hooks.hl7.org/CodeSystem/indicator"/>
    <version>
      <code value="4.0.1"/>
    </version>
  </codeSystem>
  <codeSystem>
    <uri value="http://devices.fhir.org/CodeSystem/MDC-concept-status"/>
  </codeSystem>
  <codeSystem>
    <uri value="http://devices.fhir.org/CodeSystem/MDC-designation-use"/>
  </codeSystem>
  <expansion>
    <parameter>
      <name value="cache-id"/>
      <documentation
                     value="This server supports caching terminology resources between calls. Clients only need to send value sets and codesystems once; there after they are automatically in scope for calls with the same cache-id. The cache is retained for 30 min from last call"/>
    </parameter>
    <parameter>
      <name value="tx-resource"/>
      <documentation
                     value="Additional valuesets needed for evaluation e.g. value sets referred to from the import statement of the value set being expanded"/>
    </parameter>
    <parameter>
      <name value="_incomplete"/>
    </parameter>
    <parameter>
      <name value="abstract"/>
    </parameter>
    <parameter>
      <name value="activeOnly"/>
    </parameter>
    <parameter>
      <name value="check-system-version"/>
    </parameter>
    <parameter>
      <name value="count"/>
    </parameter>
    <parameter>
      <name value="default-to-latest-version"/>
    </parameter>
    <parameter>
      <name value="displayLanguage"/>
    </parameter>
    <parameter>
      <name value="excludeNested"/>
    </parameter>
    <parameter>
      <name value="excludeNotForUI"/>
    </parameter>
    <parameter>
      <name value="excludePostCoordinated"/>
    </parameter>
    <parameter>
      <name value="force-system-version"/>
    </parameter>
    <parameter>
      <name value="inactive"/>
    </parameter>
    <parameter>
      <name value="includeAlternateCodes"/>
    </parameter>
    <parameter>
      <name value="includeDefinition"/>
    </parameter>
    <parameter>
      <name value="includeDesignations"/>
    </parameter>
    <parameter>
      <name value="incomplete-ok"/>
    </parameter>
    <parameter>
      <name value="limitedExpansion"/>
    </parameter>
    <parameter>
      <name value="mode"/>
      <documentation value="=lenient-display-validation"/>
    </parameter>
    <parameter>
      <name value="no-cache"/>
    </parameter>
    <parameter>
      <name value="offset"/>
    </parameter>
    <parameter>
      <name value="profile"/>
    </parameter>
    <parameter>
      <name value="property"/>
    </parameter>
    <parameter>
      <name value="system-version"/>
    </parameter>
    <parameter>
      <name value="valueSetMode"/>
      <documentation value="= CHECK_MEMBERSHIP_ONLY | NO_MEMBERSHIP_CHECK"/>
    </parameter>
  </expansion>
</TerminologyCapabilities>