Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Bundle

Guidance for populating and consuming the Bundle profile

Introduction

The headings below list the elements of the Bundle profile and describe how to populate and consume them.

Bundle elements

The logical identifier of the Bundle profile.

meta.profile

Data type: uri Optionality: Mandatory Cardinality: 1..*

The Bundle profile URL.

Fixed value https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Searchset-Bundle-1.

type

Data type: type Optionality: Mandatory Cardinality: 1..1

The type of the Bundle.

Fixed value of searchset.

id

Data type: id Optionality: Mandatory Cardinality: 1..1

A logical id for the bundle. This MUST be set to the same value as the Ssp-TraceID header in the request.

entry

Data type: BackboneElement Optionality: Required Cardinality: 0..*

Items that make up the Bundle.

See below for subelements of this BackboneElement.

entry.resource

Data type: Resource Optionality: Mandatory Cardinality: 0..1

A resource carried within the Bundle. This can be any type of resource, for example Patient, Organization, DocumentReference.

entry.fullUrl

Data type: uri Optionality: Mandatory Cardinality: 1..1

The fullUrl for the resource, this MUST be an absolute URL. The URL will not resolve in the case of resources that don’t have a read endpoint, for example, Practitioner. These non-resolvable URLs are used to assist consumers in resolving references within Bundle resources.

Bundle elements not in use

The following elements SHALL NOT be populated:

id

Data type: Id

meta.versionId

Data type: Id

meta.lastUpdated

Data type: Instant

All content is available under the Open Government Licence v3.0, except where otherwise stated