Profiles & Operations Index > Profile: Bundle

Profile: Bundle

Simplifier project page: Bundle

Derived from: Bundle (R4)

Canonical_URLProfile_StatusProfile_VersionFHIR_Version
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Bundledraft4.0.04.0.1

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idS Σ0..1System.String
languageS0..1codeBindingFixed Value
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampS Σ0..1instant
totalS Σ I0..1unsignedInt
relationS Σ1..1string
urlS Σ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Hybrid View

idS Σ0..1System.String
languageS0..1codeBindingFixed Value
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampS Σ0..1instant
totalS Σ I0..1unsignedInt
relationS Σ1..1string
urlS Σ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Snapshot View

idS Σ0..1System.String
languageS0..1codeBindingFixed Value
identifierΣ0..1Identifier
typeS Σ1..1codeBindingFixed Value
timestampS Σ0..1instant
totalS Σ I0..1unsignedInt
relationS Σ1..1string
urlS Σ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodΣ1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Table View

Bundle..
Bundle.id..
Bundle.language..
Bundle.type..
Bundle.timestamp..
Bundle.total..
Bundle.link..
Bundle.link.relation..
Bundle.link.url..
Bundle.entry..
Bundle.entry.fullUrl..
Bundle.entry.resource..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "c49ef9ea-5fef-4f7c-9bfd-4c8028d8539d",
    "meta": {
        "lastUpdated": "2023-04-11T18:07:14.5140765+00:00"
    },
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Bundle",
    "version": "4.0.0",
    "name": "Bundle",
    "title": "Bundle",
    "status": "draft",
    "date": "2021-11-24T18:45:16.3227669Z",
    "description": "A special type of resource for collections of resources.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Bundle",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Bundle",
                "path": "Bundle",
                "mustSupport": true
            },
            {
                "id": "Bundle.id",
                "path": "Bundle.id",
                "mustSupport": true
            },
            {
                "id": "Bundle.language",
                "path": "Bundle.language",
                "fixedCode": "en",
                "mustSupport": true
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "fixedCode": "searchset",
                "mustSupport": true
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "mustSupport": true
            },
            {
                "id": "Bundle.total",
                "path": "Bundle.total",
                "mustSupport": true
            },
            {
                "id": "Bundle.link",
                "path": "Bundle.link",
                "mustSupport": true
            },
            {
                "id": "Bundle.link.relation",
                "path": "Bundle.link.relation",
                "mustSupport": true
            },
            {
                "id": "Bundle.link.url",
                "path": "Bundle.link.url",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "mustSupport": true
            }
        ]
    }
}

Usage

A Bundle resource is used to package together a collection of FHIR instances to be sent from one system to another. The Bundle SHALL have an entry for each of the FHIR Resources required to convey information about the business event.

If DHDR response returns medication records, the bundle will contain:

  • a list of MedicationDispense contained resources (Medication, MedicationRequest, PractitionerRole, Practitioner, Organization) and referenced patient resource
  • a list of MedicationAdministration contained resources (Medication, MedicationRequest, PractitionerRole, Practitioner) and referenced patient, location, organization and encounter resources

Notes

The following rules apply to DHDR searchset type Bundles.

.id

  • used to uniquely identify a bundle response
  • populate this element with a UUID each time a response is returned by DHDR

.language

  • language in which the resource is written
  • populate with the fixed value:en

.timestamp

  • the date/time when the bundle was assembled

.type

  • declares that the Bundle contains a searchset result
  • populate with a fixed value: searchset

Note: A set of search results (type = searchset) consists of a series of zero or more entries. Each entry element will contain a resource. Bundle.total may be used to return the total number of resources that match the search, and that may be returned by following the next link.

.link

  • a series of links that provide context to this bundle. This is used to support paging.

.link.relation

  • self for the link to the this Bundle next for the link to the next page

.entry

  • each entry contains a DHDR FHIR Resource required to convey information about the business event

.entry.fullUrl

  • each entry in the Bundle SHALL have a fullUrl which is the identity of the resource in the entry
  • if a persistent identity for the resource is not available to use in the Bundle, a UUID SHOULD be used (urn:uuid:...)

.entry.resource

  • SHALL be populated with the resource for this entry

.entry.request

  • SHALL NOT be populated

.entry.response

  • SHALL NOT be populated