Release 5 Preview #3

Codesystem-bundle-type.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code System BundleType

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="bundle-type"/> 
  <meta> 
    <lastUpdated value="2020-09-21T18:14:19.896+00:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system http://hl7.org/fhir/bundle-type defines the following codes:</p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">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 style="white-space:nowrap">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 style="white-space:nowrap">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 style="white-space:nowrap">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 style="white-space:nowrap">batch
            <a name="bundle-type-batch"> </a> 
          </td> 
          <td> Batch</td> 
          <td> The bundle is a set of actions - intended to be processed by a server as a group of independent
             actions.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">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 style="white-space:nowrap">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 style="white-space:nowrap">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 style="white-space:nowrap">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
             that imposes no processing obligations or behavioral rules beyond persistence.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">subscription-notification
            <a name="bundle-type-subscription-notification"> </a> 
          </td> 
          <td> Subscription Notification</td> 
          <td> The bundle has been generated by a Subscription to communicate information to a client.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <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.621"/> 
  </identifier> 
  <version value="4.5.0"/> 
  <name value="BundleType"/> 
  <title value="BundleType"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2020-09-21T18:14:19+00:00"/> 
  <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="Indicates the purpose of a bundle - how it is 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 set of actions - intended to be processed by a server as a group of independent
     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
     that imposes no processing obligations or behavioral rules beyond persistence."/> 
  </concept> 
  <concept> 
    <code value="subscription-notification"/> 
    <display value="Subscription Notification"/> 
    <definition value="The bundle has been generated by a Subscription to communicate information to a client."/> 
  </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.