Operation-resource-meta.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "Resource-meta",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Trial Use"
    }
  ],
  "url": "http://hl7.org/fhir/OperationDefinition/Resource-meta",
  "name": "Access a list of profiles, tags, and security labels",
  "status": "draft",
  "kind": "operation",
  "date": "2018-04-03T12:05:46+10:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:  \n\n* system-wide: a list of all profiles, tags and security labels in use by the system \n* resource-type level: A list of all profiles, tags, and security labels for the resource type \n* individual resource level: A list of all profiles, tags, and security labels for the current version of the resource.  Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)",
  "code": "meta",
  "comment": "At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principal use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons",
  "resource": [
    "Resource"
  ],
  "system": true,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The meta returned by the operation",
      "type": "Meta"
    }
  ]
}