This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) 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 Revise Operation - JSON Representation

Draft as of 2023-03-12

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-revise",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Resource/$revise</p><p>URL: [base]/Resource/[id]/$revise</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>resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>A revised FHIR resource submitted for update.</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/bundle.html\">Bundle</a></td><td/><td><div><p>The result is a Bundle containing the revised resource.</p>\n</div></td></tr></table><div><p>[Request Body]:</p>\n<pre><code class=\"language-json\">{\n  &quot;resourceType&quot;: &quot;Parameters&quot;,\n  &quot;parameter&quot;: [\n    {\n      &quot;name&quot;: &quot;resource&quot;,\n      &quot;resource&quot;: {\n        &quot;resourceType&quot;: &quot;Library&quot;,\n        &quot;id&quot;: &quot;38&quot;,\n        &quot;url&quot;: &quot;http://ersd.aimsplatform.org/fhir/Library/SpecificationLibrary&quot;,\n        &quot;name&quot;: &quot;NewSpecificationLibrary&quot;,\n        ....\n      }\n    }\n  ]\n}\n</code></pre>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-revise",
  "version" : "1.0.0-ballot2",
  "name" : "CRMIRevise",
  "title" : "CRMI Revise",
  "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" : "Revises an existing resource with draft status.\nA successful $revise will produce a Bundle containing the updated resource.\nThe updated resource must also have a status draft.\n\nThis operation is defined as a `PUT` of the artifact resource.\n\nSee [description of $revise operation](artifact-repository-service.html#revise)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "revise",
  "comment" : "[Request Body]:\n```json\n{\n  \"resourceType\": \"Parameters\",\n  \"parameter\": [\n    {\n      \"name\": \"resource\",\n      \"resource\": {\n        \"resourceType\": \"Library\",\n        \"id\": \"38\",\n        \"url\": \"http://ersd.aimsplatform.org/fhir/Library/SpecificationLibrary\",\n        \"name\": \"NewSpecificationLibrary\",\n        ....\n      }\n    }\n  ]\n}\n```",
  "resource" : [
    "Resource"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "resource",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A revised FHIR resource submitted for update.",
      "type" : "Resource"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The result is a Bundle containing the revised resource.",
      "type" : "Bundle"
    }
  ]
}