View raw Markdown
type: codesystemcodesystem: bundle-type

Bundle Type

Concepts

CodeDisplayDefinition
documentDocumentThe bundle is a document. The first resource is a Composition.
messageMessageThe bundle is a message. The first resource is a MessageHeader.
transactionTransactionThe bundle is a transaction - intended to be processed by a server as an atomic commit.
transaction-responseTransaction ResponseThe bundle is a transaction response. Because the response is a transaction response, the transaction has succeeded, and all responses are error free.
batchBatchThe bundle is a set of actions - intended to be processed by a server as a group of independent actions.
batch-responseBatch ResponseThe bundle is a batch response. Note that as a batch, some responses may indicate failure and others success.
historyHistory ListThe bundle is a list of resources from a history interaction on a server.
searchsetSearch ResultsThe bundle is a list of resources returned as a result of a search/query interaction, operation, or message.
collectionCollectionThe 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.
subscription-notificationSubscription NotificationThe bundle has been generated by a Subscription to communicate information to a client.

CodeSystem XML

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="bundle-type"/>
  <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-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.4.621"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.613"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.2.327"/>
  </identifier>
  <version value="6.0.0"/>
  <name value="BundleType"/>
  <title value="Bundle Type"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2021-01-05T10:01:24+11: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>