Profile: Bundle (Submission)

Simplifier project page: Bundle (Submission)

Derived from: Bundle (R4)

Canonical_URLProfile_StatusProfile_VersionFHIR_Version
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Bundle-submissiondraft4.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..1codeBinding
timestampΣ0..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodS Σ1..1codeBinding
urlS Σ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusS Σ1..1string
locationS Σ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeS Σ0..1Resource
signatureΣ0..1Signature

Hybrid View

idS Σ0..1System.String
languageS0..1codeBindingFixed Value
identifierΣ0..1Identifier
typeS Σ1..1codeBinding
timestampΣ0..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodS Σ1..1codeBinding
urlS Σ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusS Σ1..1string
locationS Σ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeS Σ0..1Resource
signatureΣ0..1Signature

Snapshot View

idS Σ0..1System.String
languageS0..1codeBindingFixed Value
identifierΣ0..1Identifier
typeS Σ1..1codeBinding
timestampΣ0..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1Resource
modeΣ0..1codeBinding
scoreΣ0..1decimal
methodS Σ1..1codeBinding
urlS Σ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
statusS Σ1..1string
locationS Σ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeS Σ0..1Resource
signatureΣ0..1Signature

Table View

Bundle..
Bundle.id..
Bundle.language..
Bundle.type..
Bundle.entry..
Bundle.entry.fullUrl..
Bundle.entry.resource..
Bundle.entry.request..
Bundle.entry.request.method..
Bundle.entry.request.url..
Bundle.entry.response..
Bundle.entry.response.status..
Bundle.entry.response.location..
Bundle.entry.response.outcome..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "c49ef9ea-5fef-4f7c-9bfd-4c8028d8539d",
    "meta": {
        "lastUpdated": "2023-07-06T20:09:42.1576534+00:00"
    },
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Bundle-submission",
    "version": "4.0.0",
    "name": "Bundle",
    "title": "Bundle (Submission)",
    "status": "draft",
    "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",
                "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
            },
            {
                "id": "Bundle.entry.request",
                "path": "Bundle.entry.request",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.request.method",
                "path": "Bundle.entry.request.method",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.request.url",
                "path": "Bundle.entry.request.url",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response",
                "path": "Bundle.entry.response",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.status",
                "path": "Bundle.entry.response.status",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.location",
                "path": "Bundle.entry.response.location",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.outcome",
                "path": "Bundle.entry.response.outcome",
                "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.

A batch (type = "batch") consists of a series of zero or more entries. Each entry element SHALL contain either a request element, or a resource element (or both). Each entry in a batch has the details of an HTTP operation that informs the system processing the batch what to do with the entry. If the entry method is a 'PUT' or 'POST', then the entry SHALL contain a resource that becomes the body of the HTTP operation.

A batch response (type="batch-response") consists of a series of zero or more entries, one for each entry in the batch it is in response to. Each entry element SHALL contain a response element which indicates the outcome of the HTTP operation that the server performed for the entry.

Notes

The following rules apply to DHDR batch 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

meta.lastUpdated

  • the batch date
  • used to identify when the batch Bundle was assembled from the underlying resources

.type

  • declares that the Bundle contains a batch
  • populate with the values: bundle-batch for inbound batch and bundle-response for response to a batch

.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
  • all resources referenced in the MedicationDispense or MedicationAdministration SHALL be contained within the DHDR bundle

.entry.request

  • SHALL be populated for inbound batches

.entry.request.method

  • populate with the fixed value: POST

.entry.response

  • SHALL be populated in response to inbound batches

.entry.response.outcome

  • OperationOutcome resource SHALL be populated