This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-snapshot: STU1 Draft) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON

: CRMI Artifact Diff Operation - XML Representation

Draft as of 2023-03-12

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="crmi-artifact-diff"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/$artifact-diff</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>source</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>The canonical reference of the source artifact to compare against</p>
</div></td></tr><tr><td>IN</td><td>target</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>A canonical reference of the target artifact which is being compared.</p>
</div></td></tr><tr><td>IN</td><td>compareComputable</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Whether or not to compare computable content such as ValueSet.compose.include entries.</p>
</div></td></tr><tr><td>IN</td><td>compareExecutable</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Whether or not to compare computable content such as ValueSet.expansion.contains entries.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>The differential in <a href="https://www.hl7.org/fhir/fhirpatch.html">FHIR Patch format</a>.</p>
</div></td></tr></table><div><p>The operation is only valid between two resources of the same type and can optionally include expanding all ValueSets in the dependency tree.</p>
</div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-artifact-diff"/>
  <version value="1.0.0-snapshot"/>
  <name value="CRMIArtifactDiff"/>
  <title value="CRMI Artifact Diff"/>
  <status value="draft"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2023-03-12"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="Describes the differences between two knowledge artifacts in [FHIR Patch format](https://www.hl7.org/fhir/fhirpatch.html) by recursively resolving dependencies to get a holistic diff."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="artifact-diff"/>
  <comment
           value="The operation is only valid between two resources of the same type and can optionally include expanding all ValueSets in the dependency tree."/>
  <resource value="Library"/>
  <resource value="PlanDefinition"/>
  <resource value="ValueSet"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="source"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The canonical reference of the source artifact to compare against"/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="target"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="A canonical reference of the target artifact which is being compared."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="compareComputable"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Whether or not to compare computable content such as ValueSet.compose.include entries."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="compareExecutable"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Whether or not to compare computable content such as ValueSet.expansion.contains entries."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The differential in [FHIR Patch format](https://www.hl7.org/fhir/fhirpatch.html)."/>
    <type value="Parameters"/>
  </parameter>
</OperationDefinition>