STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Codesystem-bundle-type.xml

Raw XML (canonical form)

Definition for Code System BundleType

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="bundle-type"/>
  <meta>
    <lastUpdated value="2016-12-06T12:22:34.981+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>BundleType</h2>
      <div>
        <p>Indicates the purpose of a bundle - how it was intended to be used.</p>

      </div>
      <p>This code system http://hl7.org/fhir/bundle-type defines the following codes:</p>
      <table class="codes">
        <tr>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
        <tr>
          <td>document
            <a name="bundle-type-document"> </a>
          </td>
          <td>Document</td>
          <td>The bundle is a document. The first resource is a Composition.</td>
        </tr>
        <tr>
          <td>message
            <a name="bundle-type-message"> </a>
          </td>
          <td>Message</td>
          <td>The bundle is a message. The first resource is a MessageHeader.</td>
        </tr>
        <tr>
          <td>transaction
            <a name="bundle-type-transaction"> </a>
          </td>
          <td>Transaction</td>
          <td>The bundle is a transaction - intended to be processed by a server as an atomic commit.</td>
        </tr>
        <tr>
          <td>transaction-response
            <a name="bundle-type-transaction-response"> </a>
          </td>
          <td>Transaction Response</td>
          <td>The bundle is a transaction response. Because the response is a transaction response,
             the transaction has succeeded, and all responses are error free.</td>
        </tr>
        <tr>
          <td>batch
            <a name="bundle-type-batch"> </a>
          </td>
          <td>Batch</td>
          <td>The bundle is a transaction - intended to be processed by a server as a group of actions.</td>
        </tr>
        <tr>
          <td>batch-response
            <a name="bundle-type-batch-response"> </a>
          </td>
          <td>Batch Response</td>
          <td>The bundle is a batch response. Note that as a batch, some responses may indicate failure
             and others success.</td>
        </tr>
        <tr>
          <td>history
            <a name="bundle-type-history"> </a>
          </td>
          <td>History List</td>
          <td>The bundle is a list of resources from a history interaction on a server.</td>
        </tr>
        <tr>
          <td>searchset
            <a name="bundle-type-searchset"> </a>
          </td>
          <td>Search Results</td>
          <td>The bundle is a list of resources returned as a result of a search/query interaction,
             operation, or message.</td>
        </tr>
        <tr>
          <td>collection
            <a name="bundle-type-collection"> </a>
          </td>
          <td>Collection</td>
          <td>The bundle is a set of resources collected into a single package for ease of distribution.</td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/bundle-type"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.327"/>
  </identifier>
  <version value="1.8.0"/>
  <name value="BundleType"/>
  <status value="draft"/>
  <experimental value="false"/>
  <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>
  <date value="2016-12-06T12:22:34+11:00"/>
  <description value="Indicates the purpose of a bundle - how it was intended to be used."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/bundle-type"/>
  <content value="complete"/>
  <concept>
    <code value="document"/>
    <display value="Document"/>
    <definition value="The bundle is a document. The first resource is a Composition."/>
  </concept>
  <concept>
    <code value="message"/>
    <display value="Message"/>
    <definition value="The bundle is a message. The first resource is a MessageHeader."/>
  </concept>
  <concept>
    <code value="transaction"/>
    <display value="Transaction"/>
    <definition value="The bundle is a transaction - intended to be processed by a server as an atomic commit."/>
  </concept>
  <concept>
    <code value="transaction-response"/>
    <display value="Transaction Response"/>
    <definition value="The bundle is a transaction response. Because the response is a transaction response,
     the transaction has succeeded, and all responses are error free."/>
  </concept>
  <concept>
    <code value="batch"/>
    <display value="Batch"/>
    <definition value="The bundle is a transaction - intended to be processed by a server as a group of actions."/>
  </concept>
  <concept>
    <code value="batch-response"/>
    <display value="Batch Response"/>
    <definition value="The bundle is a batch response. Note that as a batch, some responses may indicate failure
     and others success."/>
  </concept>
  <concept>
    <code value="history"/>
    <display value="History List"/>
    <definition value="The bundle is a list of resources from a history interaction on a server."/>
  </concept>
  <concept>
    <code value="searchset"/>
    <display value="Search Results"/>
    <definition value="The bundle is a list of resources returned as a result of a search/query interaction,
     operation, or message."/>
  </concept>
  <concept>
    <code value="collection"/>
    <display value="Collection"/>
    <definition value="The bundle is a set of resources collected into a single package for ease of distribution."/>
  </concept>
</CodeSystem>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.