Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot International flag

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

: CRMI Revise Operation - XML Representation

Draft as of 2023-03-12

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="crmi-revise"/>
  <text>
    <status value="extensions"/>
    <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>
</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>
</div></td></tr></table><div><p>[Request Body]:</p>
<pre><code class="language-json">{
  &quot;resourceType&quot;: &quot;Parameters&quot;,
  &quot;parameter&quot;: [
    {
      &quot;name&quot;: &quot;resource&quot;,
      &quot;resource&quot;: {
        &quot;resourceType&quot;: &quot;Library&quot;,
        &quot;id&quot;: &quot;38&quot;,
        &quot;url&quot;: &quot;http://ersd.aimsplatform.org/fhir/Library/SpecificationLibrary&quot;,
        &quot;name&quot;: &quot;NewSpecificationLibrary&quot;,
        ....
      }
    }
  ]
}
</code></pre>
</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-revise"/>
  <version value="1.0.0-ballot2"/>
  <name value="CRMIRevise"/>
  <title value="CRMI Revise"/>
  <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="Revises an existing resource with draft status.
A successful $revise will produce a Bundle containing the updated resource.
The updated resource must also have a status draft.

This operation is defined as a `PUT` of the artifact resource.

See [description of $revise operation](artifact-repository-service.html#revise)"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="revise"/>
  <comment
           value="[Request Body]:
```json
{
  &quot;resourceType&quot;: &quot;Parameters&quot;,
  &quot;parameter&quot;: [
    {
      &quot;name&quot;: &quot;resource&quot;,
      &quot;resource&quot;: {
        &quot;resourceType&quot;: &quot;Library&quot;,
        &quot;id&quot;: &quot;38&quot;,
        &quot;url&quot;: &quot;http://ersd.aimsplatform.org/fhir/Library/SpecificationLibrary&quot;,
        &quot;name&quot;: &quot;NewSpecificationLibrary&quot;,
        ....
      }
    }
  ]
}
```"/>
  <resource value="Resource"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="resource"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="A revised FHIR resource submitted for update."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The result is a Bundle containing the revised resource."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>