Operation-resource-meta.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-meta"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Resource-meta"/>
  <name value="Access a list of profiles, tags, and security labels"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="This operation retrieves a summary of the profiles, tags, and security labels for the
   given scope. E.g. for each scope:  * system-wide: a list of all profiles, tags and security
   labels in use by the system * resource-type level: A list of all profiles, tags, and security
   labels for the resource type * 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)"/>
  <status value="draft"/>
  <date value="2015-02-23T09:07:27+11:00"/>
  <kind value="operation"/>
  <code value="meta"/>
  <notes value="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 principle 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"/>
  <system value="true"/>
  <type value="Resource"/>
  <instance value="true"/>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The meta returned by the operation"/>
    <type value="Meta"/>
  </parameter>
</OperationDefinition>