Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/bundle-type (JSON)

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

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

Definition for Code SystemBundleType

{
  "resourceType" : "CodeSystem",
  "id" : "bundle-type",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/bundle-type</code> 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>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/bundle-type",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.621"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.613"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.327"
  }],
  "version" : "5.0.0",
  "name" : "BundleType",
  "title" : "Bundle Type",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Indicates the purpose of a bundle - how it is intended to be used.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/bundle-type",
  "content" : "complete",
  "concept" : [{
    "code" : "document",
    "display" : "Document",
    "definition" : "The bundle is a document. The first resource is a Composition."
  },
  {
    "code" : "message",
    "display" : "Message",
    "definition" : "The bundle is a message. The first resource is a MessageHeader."
  },
  {
    "code" : "transaction",
    "display" : "Transaction",
    "definition" : "The bundle is a transaction - intended to be processed by a server as an atomic commit."
  },
  {
    "code" : "transaction-response",
    "display" : "Transaction Response",
    "definition" : "The bundle is a transaction response. Because the response is a transaction response, the transaction has succeeded, and all responses are error free."
  },
  {
    "code" : "batch",
    "display" : "Batch",
    "definition" : "The bundle is a set of actions - intended to be processed by a server as a group of independent actions."
  },
  {
    "code" : "batch-response",
    "display" : "Batch Response",
    "definition" : "The bundle is a batch response. Note that as a batch, some responses may indicate failure and others success."
  },
  {
    "code" : "history",
    "display" : "History List",
    "definition" : "The bundle is a list of resources from a history interaction on a server."
  },
  {
    "code" : "searchset",
    "display" : "Search Results",
    "definition" : "The bundle is a list of resources returned as a result of a search/query interaction, operation, or message."
  },
  {
    "code" : "collection",
    "display" : "Collection",
    "definition" : "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."
  },
  {
    "code" : "subscription-notification",
    "display" : "Subscription Notification",
    "definition" : "The bundle has been generated by a Subscription to communicate information to a client."
  }]
}

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.