Operation-resource-meta-add.xml

Operation Definition

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

      </div> 
      <p> URL: [base]/Resource/[id]/$meta-add</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 add to the existing resource. Note that profiles,
                 tags, and security labels are sets, and duplicates are not created.  The identity of a
                 tag or security label is the system+code. When matching existing tags during adding, 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-add"/> 
  <name value="Add profiles, tags, and security labels to 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 adds the profiles, tags, and security labels found in
   it to the nominated resource.   This operation can also be used on historical entries
   - to update them without creating a different historical version"/> 
  <code value="meta-add"/> 
  <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 add to the existing resource. Note that profiles,
     tags, and security labels are sets, and duplicates are not created.  The identity of a
     tag or security label is the system+code. When matching existing tags during adding, 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>