Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #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

2.27.6.3 Operation $meta-add on Resource

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

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

The official URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

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

This is not an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
meta1..1Meta

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

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Meta

Resulting meta for the resource

2.27.6.3.1 Examples

Request: Add a 'paper record lost' tag to a resource


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

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="meta"/>
    <valueMeta>
      <tag>
        <system value="http://example.org/codes/tags"/>
        <code value="record-lost"/>
        <display value="Patient File Lost"/>
      </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="current"/>
        <display value="Current Inpatient"/>
      </tag>
      <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.