R6 Ballot (2nd Draft)

Publish-box (todo)

2.1.27.5.8.4 Operation $meta-delete on Resource

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

This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource.

The canonical 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:
Name Scope Cardinality Type Binding Profile Documentation
meta 1..1 Meta

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:
Name Scope Cardinality Type Binding Profile Documentation
return 1..1 Meta

Resulting meta for the resource

2.1.27.5.8.4.1 Examples

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


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>

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


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.