0.1.0 - ci-build
SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteResultsBundle | Version: 0.1.0 | |||
| Draft as of 2026-11-05 | Computable Name: SenaiteResultsBundle | |||
A searchset Bundle returned by the SENAITE FHIR API in response to
a DiagnosticReport polling request. May contain one or more
DiagnosticReports — one per completed Sample matched by the search
criteria (typically _lastUpdated=gt<since>), plus any combined
report that covers several Samples sharing a requisition.
Each DiagnosticReport is the backbone for its results. A per-sample
report carries a basedOn reference to the originating ServiceRequest
(absent for a Sample created inside SENAITE); a combined report carries
one basedOn reference per ServiceRequest it covers. Both link their
Observations via result.
Per-sample and combined reports coexist: the same Sample can appear in
a per-sample report and in a combined report in one response.
DiagnosticReport.basedOn having more than one entry marks a combined
report. Consumers should ingest per-sample reports as the results and
treat a combined report as a document.
Observations are returned as sibling entries via _include=Observation:result.
Consumers can distinguish matched resources from included ones via
entry.search.mode: DiagnosticReport entries carry mode = #match
and Observation entries carry mode = #include.
Referenced resources already known to both systems (Patient, ServiceRequest, Practitioner, etc.) do not need to be included as entries. Their references within DiagnosticReport and Observation are plain relative references resolved out-of-band.
Bundle.type is searchset — this Bundle is always the direct
response to a FHIR search interaction.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: searchset (no extensions allowed) |
![]() ![]() |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref |
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
C | 1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport |
A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() ![]() |
C | 0..* | BackboneElement | Included Observations — one entry per analyte result Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation |
Measurements and simple assertions | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..0 | Persistent identifier for the bundle | ||
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: searchset (no extensions allowed) | |
![]() ![]() |
0..0 | Links related to this Bundle | ||
![]() ![]() |
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle | |
![]() ![]() ![]() ![]() |
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Fixed Value: match (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() ![]() |
0..* | BackboneElement | Included Observations — one entry per analyte result | |
![]() ![]() ![]() ![]() |
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation | Measurements and simple assertions | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Fixed Value: include (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() |
0..0 | Digital Signature | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d | ||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: searchset (no extensions allowed) | ||||
![]() ![]() |
C | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport |
A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Fixed Value: match (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Included Observations — one entry per analyte result Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation |
Measurements and simple assertions | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Fixed Value: include (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
This structure is derived from Bundle
Summary
Mandatory: 5 elements(1 nested mandatory element)
Fixed: 3 elements
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: searchset (no extensions allowed) |
![]() ![]() |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref |
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
C | 1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport |
A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() ![]() |
C | 0..* | BackboneElement | Included Observations — one entry per analyte result Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation |
Measurements and simple assertions | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..0 | Persistent identifier for the bundle | ||
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: searchset (no extensions allowed) | |
![]() ![]() |
0..0 | Links related to this Bundle | ||
![]() ![]() |
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() ![]() ![]() |
0..0 | Additional execution information (transaction/batch/history) | ||
![]() ![]() ![]() ![]() |
0..0 | Results of execution (transaction/batch/history) | ||
![]() ![]() ![]() |
1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle | |
![]() ![]() ![]() ![]() |
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Fixed Value: match (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() ![]() |
0..* | BackboneElement | Included Observations — one entry per analyte result | |
![]() ![]() ![]() ![]() |
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation | Measurements and simple assertions | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Fixed Value: include (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Search ranking (between 0 and 1) | ||
![]() ![]() |
0..0 | Digital Signature | ||
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d | ||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: searchset (no extensions allowed) | ||||
![]() ![]() |
C | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: relative-ref | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | One entry per completed Sample, plus any combined report — at least one per Bundle Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteDiagnosticReport |
A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Fixed Value: match (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Included Observations — one entry per analyte result Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..* | See link (Bundle) | Links related to this entry | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() |
1..1 | SenaiteObservation |
Measurements and simple assertions | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Fixed Value: include (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing cache validation | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | For managing cache currency | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For managing update contention | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | For conditional creates | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Status response code (text optional) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The location (if the operation returns a location) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The Etag for the resource (if relevant) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | instant | Server's date time modified | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
![]() ![]() |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:diagnosticReport.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:observation.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:diagnosticReport, Bundle.entry:observation | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| relative-ref | error | Bundle.entry.fullUrl | fullUrl in a transaction-response must be a relative ResourceType/id reference |
matches('^[A-Z][a-zA-Z]+/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
This structure is derived from Bundle
Summary
Mandatory: 5 elements(1 nested mandatory element)
Fixed: 3 elements
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron