This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON

: Get Package - JSON Representation

Active as of 2024-05-31

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "get-package",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/$get-package</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The id of the package to retrieve. The server must know the package or be able to use a package feed to resolve the package id</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The version of the library to be used for packaging. If a version is not specified, the latest version available to the server is returned. This value may also be the special values <code>current</code>, indicating the current version for the package, and <code>dev</code>, indicating a pre-release version</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td><div><p>The requested package as a Binary resource. Note that servers may perform additional processing of the contents of the package to support target environments appropriate for their usage, so long as those modifications do not materially impact the contents of the package.</p>\n</div></td></tr></table><div><p>This operation is used to retrieve a FHIR package</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/get-package",
  "version" : "1.0.0",
  "name" : "GetPackage",
  "title" : "Get Package",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-05-31T17:02:28+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "Retrieves a FHIR package given the package id and version.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "get-package",
  "comment" : "This operation is used to retrieve a FHIR package",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The id of the package to retrieve. The server must know the package or be able to use a package feed to resolve the package id",
      "type" : "string"
    },
    {
      "name" : "version",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The version of the library to be used for packaging. If a version is not specified, the latest version available to the server is returned. This value may also be the special values `current`, indicating the current version for the package, and `dev`, indicating a pre-release version",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The requested package as a Binary resource. Note that servers may perform additional processing of the contents of the package to support target environments appropriate for their usage, so long as those modifications do not materially impact the contents of the package.",
      "type" : "Binary"
    }
  ]
}