Bundle - FHIR Resource (r4)

This Bundle Resource uses the FHIR API standard for access and structure.

Validate an Bundle FHIR Resource (r4)

Bundle Attributes

AttributeField is listTypeDescription

Description: Persistent identifier for the bundle

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (Bundle) identifier FHIR attribute

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": "searchset"

Learn more about the (Bundle) type FHIR attribute

Description: When the bundle was assembled

FHIR Version: r4

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"timestamp":

Learn more about the (Bundle) timestamp FHIR attribute

Description: C? If search, the total number of matches

FHIR Version: r4

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"total": 3

Learn more about the (Bundle) total FHIR attribute

Description: Links related to this Bundle

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"link": [
  {
    "relation": "self",
    "url": "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2"
  },
  {
    "relation": "next",
    "url": "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2"
  }
]

Learn more about the (Bundle) link FHIR attribute

Description: Entry in the bundle - will have a resource or information

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"entry": [
  {
    "fullUrl": "https://example.com/base/MedicationRequest/3123",
    "resource": {
      "resourceType": "MedicationRequest",
      "id": "3123",
      "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 3123</p><p><b>status</b>: unknown</p><p><b>intent</b>: order</p><p><b>medication</b>: <a>Medication/example</a></p><p><b>subject</b>: <a>Patient/347</a></p></div>"
      },
      "status": "unknown",
      "intent": "order",
      "medicationReference": {
        "reference": "Medication/example"
      },
      "subject": {
        "reference": "Patient/347"
      }
    },
    "search": {
      "mode": "match",
      "score": 1
    }
  },
  {
    "fullUrl": "https://example.com/base/Medication/example",
    "resource": {
      "resourceType": "Medication",
      "id": "example",
      "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
      }
    },
    "search": {
      "mode": "include"
    }
  }
]

Learn more about the (Bundle) entry FHIR attribute

Description: Digital Signature

FHIR Version: r4

Attribute Type : Signature

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"signature":

Learn more about the (Bundle) signature FHIR attribute

Bundle Example

{
  "resourceType": "Bundle",
  "id": "bundle-example",
  "meta": {
    "lastUpdated": "2014-08-18T01:43:30Z"
  },
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication&_count=2"
    },
    {
      "relation": "next",
      "url": "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://example.com/base/MedicationRequest/3123",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "3123",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 3123</p><p><b>status</b>: unknown</p><p><b>intent</b>: order</p><p><b>medication</b>: <a>Medication/example</a></p><p><b>subject</b>: <a>Patient/347</a></p></div>"
        },
        "status": "unknown",
        "intent": "order",
        "medicationReference": {
          "reference": "Medication/example"
        },
        "subject": {
          "reference": "Patient/347"
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    },
    {
      "fullUrl": "https://example.com/base/Medication/example",
      "resource": {
        "resourceType": "Medication",
        "id": "example",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
        }
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

Bundle Structure

{
  "resourceType" : "Bundle",
  // from Resource: id, meta, implicitRules, and language
  "identifier" : { Identifier }, // Persistent identifier for the bundle
  "type" : "<code>", // R!  document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
  "timestamp" : "<instant>", // When the bundle was assembled
  "total" : "<unsignedInt>", // C? If search, the total number of matches
  "link" : [{ // Links related to this Bundle
    "relation" : "<string>", // R!  See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
    "url" : "<uri>" // R!  Reference details for the link
  }],
  "entry" : [{ // Entry in the bundle - will have a resource or information
    "link" : [{ Content as for Bundle.link }], // Links related to this entry
    "fullUrl" : "<uri>", // URI for resource (Absolute URL server address or URI for UUID/OID)
    "resource" : { Resource }, // A resource in the bundle
    "search" : { // C? Search related information
      "mode" : "<code>", // match | include | outcome - why this is in the result set
      "score" : <decimal> // Search ranking (between 0 and 1)
    },
    "request" : { // C? Additional execution information (transaction/batch/history)
      "method" : "<code>", // R!  GET | HEAD | POST | PUT | DELETE | PATCH
      "url" : "<uri>", // R!  URL for HTTP equivalent of this entry
      "ifNoneMatch" : "<string>", // For managing cache currency
      "ifModifiedSince" : "<instant>", // For managing cache currency
      "ifMatch" : "<string>", // For managing update contention
      "ifNoneExist" : "<string>" // For conditional creates
    },
    "response" : { // C? Results of execution (transaction/batch/history)
      "status" : "<string>", // R!  Status response code (text optional)
      "location" : "<uri>", // The location (if the operation returns a location)
      "etag" : "<string>", // The Etag for the resource (if relevant)
      "lastModified" : "<instant>", // Server's date time modified
      "outcome" : { Resource } // OperationOutcome with hints and warnings (for batch/transaction)
    }
  }],
  "signature" : { Signature } // Digital Signature
}

Bundle Search Parameters

The following search parameters can be used to query Bundle resources. Just submit them like so:

https://api.1up.health/fhir/r4/Bundle?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`composition TU`	`reference`	`entry[0].resource`
`identifier TU`	`text`	`identifier`
`message TU`	`reference`	`entry[0].resource`
`timestamp TU`	`date`	`timestamp`
`type TU`	`text`	`type`