Bundle - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
entrytrueData Type Entry in the bundle - will have a resource, or information
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 Structure


  
{
  "resourceType" : "Bundle",
  // from Resource: id, meta, implicitRules, and language
  "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!  http://www.iana.org/assignments/link-relations/link-relations.xhtml
    "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 return code for entry
      "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
    }
  }],
  "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/dstu2/Bundle?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
compositionreferenceentry.resource
messagereferenceentry.resource
typetexttype