FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "StructureDefinition-snapshot" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Generate Snapshot

OPERATION: Generate Snapshot

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot

Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition.

If the operation is not called at the instance level, either definition or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.

URL: [base]/StructureDefinition/$snapshot

URL: [base]/StructureDefinition/[id]/$snapshot

Parameters

Use Name Cardinality Type Binding Documentation
IN definition 0..1 StructureDefinition

The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion

IN url 0..1 string
( token)

The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.

OUT return 1..1 StructureDefinition

The structure definition with a snapshot


{
  "resourceType" : "OperationDefinition",
  "id" : "StructureDefinition-snapshot",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:44.629Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Generate Snapshot</h2>\n <p>OPERATION: Generate Snapshot</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot</pre>\n <div>\n <p>Generates a \n <a href=\"structuredefinition.html\">StructureDefinition</a> instance with a snapshot, based on a differential in a specified \n <a href=\"structuredefinition.html\">StructureDefinition</a>.\n </p>\n\n <p>If the operation is not called at the instance level, either \n <em>definition</em> or \n <em>url</em> 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.\n </p>\n\n </div>\n <p>URL: [base]/StructureDefinition/$snapshot</p>\n <p>URL: [base]/StructureDefinition/[id]/$snapshot</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>definition</td>\n <td>0..1</td>\n <td>\n <a href=\"structuredefinition.html\">StructureDefinition</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The \n <a href=\"structuredefinition.html\">StructureDefinition</a> is provided directly as part of the request. Servers may choose not to accept profiles in this fashion\n </p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>url</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n <br/>(\n <a href=\"search.html#token\">token</a>)\n </td>\n <td/>\n <td>\n <div>\n <p>The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>return</td>\n <td>1..1</td>\n <td>\n <a href=\"structuredefinition.html\">StructureDefinition</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The structure definition with a snapshot</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div/>\n </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 5
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot",
  "version" : "4.0.0",
  "name" : "Generate Snapshot",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "Generates a [StructureDefinition](structuredefinition.html) instance with a snapshot, based on a differential in a specified [StructureDefinition](structuredefinition.html). \n\nIf the operation is not called at the instance level, either *definition* or *url* 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.",
  "code" : "snapshot",
  "resource" : [
    "StructureDefinition"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "definition",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The [StructureDefinition](structuredefinition.html) is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
      "type" : "StructureDefinition"
    },
    {
      "name" : "url",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The StructureDefinition's canonical URL (i.e. 'StructureDefinition.url'). The server must know the structure definition, or be able to retrieve it from other known repositories.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The structure definition with a snapshot",
      "type" : "StructureDefinition"
    }
  ]
}