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

• Narrative Content
• XML
• JSON

: Get Package - XML Representation

Draft as of 2019-11-01

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="get-package"/>
  <text>
    <status value="extensions"/>
    <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>
</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>
</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>
</div></td></tr></table><div><p>This operation is used to retrieve a FHIR package</p>
</div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/>
  </extension>
  <url value="http://hl7.org/fhir/uv/crmi/OperationDefinition/get-package"/>
  <version value="1.0.0-snapshot"/>
  <name value="GetPackage"/>
  <title value="Get Package"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2019-11-01T09:29:23+11:00"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="Retrieves a FHIR package given the package id and version."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="get-package"/>
  <comment value="This operation is used to retrieve a FHIR package"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="id"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="string"/>
  </parameter>
  <parameter>
    <name value="version"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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 value="string"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="Binary"/>
  </parameter>
</OperationDefinition>