Page Status: updated 2022-03-25

Bundle

Page index

Introduction

The Bundle resource is used when handling a set of resources, usually in a reply from other resources, e.g. a search set. For that kind of usage see the HL7 FHIR documentation. This page focuses on when Bundle is used in a request similar to an endpoint. In this use case is however the endpoint [base] instead of [base]/Bundle.

The only scenario when Bundle is used in this way in the National Medication List is when managing multiple medication dispenses in a dispatch via the profile NLLDispatch.

Overview

identifierΣ0..1Identifier
typeS Σ1..1codeBinding
timestampΣ0..1instant
totalΣ I0..1unsignedInt
relationΣ1..1string
urlΣ1..1uri
fullUrlS Σ0..1uri
resourceS Σ0..1NLLMedicationDispense, NLLDispensePaperPrescription
methodS Σ1..1codeBinding
urlS Σ1..1uri
ifNoneMatchΣ0..0string
ifModifiedSinceΣ0..0instant
ifMatchΣ0..0string
ifNoneExistΣ0..0string
statusS Σ1..1string
locationS Σ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature

Details

Description of all elements can be found here, Element descriptions.

Error handling

If an error is detected on one of the medication dispense resources in the bundle the whole set of dispenses are rejected with an HTTP status of 4xx. The returned OperationOutcome will contain information about the detected issues and errors.

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) no
Insert (POST) yes POST is used both for creating and updating a bundle of medication dispenses
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) no

A new medication dispense is created by setting entry.request.method to POST. An existing medication dispense is updated by setting entry.request.method to PUT.

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Search is not supported for this resource.

Other operations

Operation Comment
$verify

Invocations

URL: [base]/$verify

URL: [base]/MedicationRequest/$verify URL: [base]/MedicationDispense/$verify

This operation does NOT change content

Parameters (In)

NameCardinalityTypeDocumentation
resource0..1MedicationRequest(NLLMedicationRequest)

The MedicationRequest to be verified. This type of verification must be directed to the medication request end-point [base]/MedicationRequest/$verify.

resource0..1MedicationDispense(NLLMedicationDispense)

The MedicationDispense to be verified. This type of verification must be directed to the medication dispense end-point [base]/MedicationDispense/$verify.

resource0..1MedicationDispense(NLLDispensePaperPrescription)

The MedicationDispense to be verified. This type of verification must be directed to the medication dispense end-point [base]/MedicationDispense/$verify.

resource0..1Bundle(NLLDispatch)

A Bundle containing the MedicationDispenses to be verified. This type of verification must be directed to the service base end-point [base]/$verify.

Return Values (Out)

NameCardinalityTypeDocumentation
detectedIssues1..1boolean

Has the value 'true' if any AFF errors or warnings are detected, otherwise 'false'

issues0..1OperationOutcome(NLLOperationOutcome)

If the Automatic Format and Constitution Control (sv. Automatiska format- och författningskontroller AFF-kontroller) returns any errors or warnings, these are displayed as DetectedIssues in an OperationOutcome. No OperationOutcome will be returened if there are no issues.

Must be invoked with a HTTP POST. This operation is invoked on MedicationDispense and MedicationRequest resources to verify them according to the Automatic Format and Constitution Control (sv. Automatiska format- och författningskontroller AFF-kontroller). It is also possible to verify a set of MedicationDispenses by using $verify on the service base and providing a NLLDispatch. It is important that the content of the resource parameter matches the end-point of the request.