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 - JSON Representation

Draft as of 2023-03-12

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-artifact-diff",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-artifact-diff",
  "version" : "1.0.0-snapshot",
  "name" : "CRMIArtifactDiff",
  "title" : "CRMI Artifact Diff",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2023-03-12",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "artifact-diff",
  "comment" : "The operation is only valid between two resources of the same type and can optionally include expanding all ValueSets in the dependency tree.",
  "resource" : [
    "Library",
    "PlanDefinition",
    "ValueSet"
  ],
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "source",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The canonical reference of the source artifact to compare against",
      "type" : "canonical"
    },
    {
      "name" : "target",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A canonical reference of the target artifact which is being compared.",
      "type" : "canonical"
    },
    {
      "name" : "compareComputable",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Whether or not to compare computable content such as ValueSet.compose.include entries.",
      "type" : "boolean"
    },
    {
      "name" : "compareExecutable",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Whether or not to compare computable content such as ValueSet.expansion.contains entries.",
      "type" : "boolean"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The differential in [FHIR Patch format](https://www.hl7.org/fhir/fhirpatch.html).",
      "type" : "Parameters"
    }
  ]
}