R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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

2.25.1.4 Operation $meta-delete on Resource

FHIR Infrastructure Work Group Maturity Level: 5Trial Use Compartments: N/A

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

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Resource-meta-delete

Formal Definition (as a OperationDefinition).

URL: [base]/[Resource]/[id]/$meta-delete

This is not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
meta1..1Meta

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

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Meta

Resulting meta for the resource

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

2.25.1.4.1 Examples

Remove the 'current patient' tag from a resource (Request):


POST /fhir/Patient/example/$meta-delete
[Other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="meta"/>
    <valueMeta>
      <tag>
        <system value="http://example.org/codes/tags"/>
        <code value="current"/>
        <display value="Current Inpatient"/>
      </tag>
    </valueMeta>
  </parameter>
</Parameters>

All the tags, profiles, and security labels used on patient resources (Response):


HTTP/1.1 200 OK
[other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="return"/>
    <valueMeta>
      <profile value="http://hl7.org/fhir/StructureDefinition/daf-patient"/>
      <tag>
        <system value="http://example.org/codes/tags"/>
        <code value="record-lost"/>
        <display value="Patient File Lost"/>
      </tag>    
    </valueMeta>
  </parameter>
</Parameters>

 

For more information about operations, including how they are invoked, see Operations.