Bundle - FHIR Resource (stu3)


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

Validate an Bundle FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
entrytrueData Type Entry in the bundle - will have a resource, or information
identifierfalseIdentifier Persistent identifier for the bundle
linktrueData Type Links related to this Bundle
signaturefalseSignature Digital Signature
totalfalseunsignedInt C? If search, the total number of matches
typefalsecode document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

Bundle Example

{
  "resourceType": "Bundle",
  "meta": {
    "lastUpdated": "2014-08-18T01:43:30Z"
  },
  "link": [
    {
      "url": "https://example.com/base/MedicationRequest?patient=347&_include=MedicationRequest.medication",
      "relation": "self"
    },
    {
      "url": "https://example.com/base/MedicationRequest?patient=347&searchId=ff15fd40-ff71-4b48-b366-09c706bed9d0&page=2",
      "relation": "next"
    }
  ],
  "entry": [
    {
      "search": {
        "score": 1,
        "mode": "match"
      },
      "resource": {
        "resourceType": "MedicationRequest",
        "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>intent</b>: order</p><p><b>medication</b>: <a>Medication/example</a></p><p><b>subject</b>: <a>Patient/347</a></p></div>"
        },
        "medicationReference": {
          "reference": "Medication/example"
        },
        "intent": "order",
        "id": "3123",
        "subject": {
          "reference": "Patient/347"
        }
      },
      "fullUrl": "https://example.com/base/MedicationRequest/3123"
    },
    {
      "search": {
        "mode": "include"
      },
      "resource": {
        "resourceType": "Medication",
        "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>"
        },
        "id": "example"
      },
      "fullUrl": "https://example.com/base/Medication/example"
    }
  ],
  "total": 3,
  "type": "searchset",
  "id": "bundle-example"
}

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
  "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>", // Absolute URL for resource (server address, or 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? Transaction Related Information
      "method" : "<code>", // R!  GET | POST | PUT | DELETE
      "url" : "<uri>", // R!  URL for HTTP equivalent of this entry
      "ifNoneMatch" : "<string>", // For managing cache currency
      "ifModifiedSince" : "<instant>", // For managing update contention
      "ifMatch" : "<string>", // For managing update contention
      "ifNoneExist" : "<string>" // For conditional creates
    },
    "response" : { // C? Transaction Related Information
      "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 the like so:

https://api.1up.health/fhir/stu3/Bundle?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
compositionreferenceentry[0].resource
identifiertextidentifier
messagereferenceentry[0].resource
typetexttype