FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Operation-resource-meta-delete.xml

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form)

Jump past Narrative

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-meta-delete"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Delete profiles, tags, and security labels for a resource</h2> 
      <p> OPERATION: Delete profiles, tags, and security labels for a resource</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Resource-meta-delete</pre> 
      <div> 
        <p> This operation takes a meta, and deletes the profiles, tags, and security labels found
           in it from the nominated resource.   This operation can also be used on historical entries</p> 

      </div> 
      <p> URL: [base]/Resource/[id]/$meta-delete</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</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> meta</td> 
          <td> 1..1</td> 
          <td> Meta</td> 
          <td/>  
          <td> 
            <div> 
              <p> Profiles, tags, and security labels to delete from the existing resource. It is not an
                 error if these tags, profiles, and labels do not exist.  The identity of a tag or security
                 label is the system+code. When matching existing tags during deletion, version and display
                 are ignored. For profiles, matching is based on the full URL</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td> 1..1</td> 
          <td> Meta</td> 
          <td/>  
          <td> 
            <div> 
              <p> Resulting meta for the resource</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> This operation is special in that executing this operation does not cause a new version
           of the resource to be created. The meta is updated directly. This is because the content
           in meta does not affect the meaning of the resource, and the security labels (in particular)
           are used to apply access rules to existing versions of resources</p> 

      </div> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/Resource-meta-delete"/> 
  <name value="Delete profiles, tags, and security labels for a resource"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2019-10-24T11:53:00+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="This operation takes a meta, and deletes the profiles, tags, and security labels found
   in it from the nominated resource.   This operation can also be used on historical entries"/> 
  <code value="meta-delete"/> 
  <comment value="This operation is special in that executing this operation does not cause a new version
   of the resource to be created. The meta is updated directly. This is because the content
   in meta does not affect the meaning of the resource, and the security labels (in particular)
   are used to apply access rules to existing versions of resources"/> 
  <resource value="Resource"/> 
  <system value="false"/> 
  <type value="false"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="meta"/> 
    <use value="in"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="Profiles, tags, and security labels to delete from the existing resource. It is not an
     error if these tags, profiles, and labels do not exist.  The identity of a tag or security
     label is the system+code. When matching existing tags during deletion, version and display
     are ignored. For profiles, matching is based on the full URL"/> 
    <type value="Meta"/> 
  </parameter> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="Resulting meta for the resource"/> 
    <type value="Meta"/> 
  </parameter> 
</OperationDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.