2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-resource-meta-change.json

Raw JSON (canonical form)

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "Resource-meta-change",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/Resource-meta-change",
  "name": "Add or delete profiles, tags, and security labels for a resource",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "This operation takes a meta, and either adds or deletes the profiles, tags, and security labels found in it to or from the nominated resource. \n\nThis operation can also be used on historical entries",
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "kind": "operation",
  "code": "meta-change",
  "notes": "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 resources",
  "system": false,
  "instance": true,
  "parameter": [
    {
      "name": "meta",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Profiles, tags, and security labels to add to or delete from the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. E.g. Profiles are unique by URL, and tags and security labels are unique by system+code",
      "type": "Meta"
    },
    {
      "name": "mode",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Whether to add or delete. The default action is add the labels",
      "type": "code"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Resulting meta for the resource",
      "type": "Meta"
    }
  ]
}

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.