Patsiendi elulõpu tahteavaldus
0.1.0 - trial-use

Patsiendi elulõpu tahteavaldus, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-ahd/ and changes regularly. See the Directory of published versions

Resource Profile: AHD trustee's data bundle (Bundle)

Official URL: https://fhir.ee/ahd/StructureDefinition/ahd-trustee-signed-bundle Version: 0.1.0
Draft as of 2026-10-12 Computable Name: AHDTrusteeSignedBundle

Bundle of data consisting of information who the trustee is and their signature agreeing to be the patient's representative.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 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
Bundle.type This element is included in summaries. 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.
Required Pattern: collection
Bundle.timestamp This element is included in summaries. C 1..1 instant When the bundle was assembled
Bundle.Slices for entry This element is included in summaries. C 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed 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
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:trustee This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:trustee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:trustee.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:trustee.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:provenance This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:provenance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Who, What, When for a set of resources
Bundle.Slices for entry.entry:provenance.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:provenance.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.response.status This element is included in summaries. 1..1 string Status response code (text optional)

doco Documentation for this format

Terminology Bindings

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:trustee.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

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:trustee, Bundle.entry:provenance 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:trustee, Bundle.entry:provenance 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()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.id 0..0 Logical id of this artifact
Bundle.meta
Bundle.meta.id 0..0 Unique id for inter-element referencing
Bundle.meta.extension 0..0 Extension
Bundle.meta.versionId 0..0 Version specific identifier
Bundle.meta.lastUpdated 0..0 When the resource version last changed
Bundle.meta.source 0..0 Identifies where the resource comes from
Bundle.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Bundle.meta.security 0..0 Security Labels applied to this resource
Bundle.meta.tag 0..0 Tags applied to this resource
Bundle.implicitRules 0..0 A set of rules under which this content was created
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: collection
Bundle.timestamp 1..1 instant When the bundle was assembled
Bundle.total 0..0 If search, the total number of matches
Bundle.link 0..0 Links related to this Bundle
Bundle.Slices for entry 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..0 Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..0 Extension
Bundle.Slices for entry.entry:All Slices.modifierExtension 0..0 Extension
Bundle.Slices for entry.entry:All Slices.link 0..0 Links related to this entry
Bundle.Slices for entry.entry:All Slices.resource 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search 0..0 Search related information
Bundle.Slices for entry.entry:All Slices.request 0..0 Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:provenance 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Who, What, When for a set of resources
Bundle.signature 0..0 Digital Signature
Bundle.issues 0..0 Issues with the Bundle

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 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
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Bundle.type This element is included in summaries. 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.
Required Pattern: collection
Bundle.timestamp This element is included in summaries. C 1..1 instant When the bundle was assembled
Bundle.Slices for entry This element is included in summaries. C 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed 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
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:trustee This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:trustee.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:trustee.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:trustee.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:trustee.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:trustee.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:trustee.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:trustee.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:trustee.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:trustee.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:trustee.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:trustee.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:trustee.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:trustee.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:trustee.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:provenance This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:provenance.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:provenance.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Who, What, When for a set of resources
Bundle.Slices for entry.entry:provenance.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:provenance.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:provenance.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:provenance.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:provenance.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:provenance.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:provenance.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:provenance.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:provenance.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:provenance.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:provenance.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:provenance.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)

doco Documentation for this format

Terminology Bindings

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.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:trustee.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:trustee.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

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:trustee, Bundle.entry:provenance 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:trustee, Bundle.entry:provenance 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()

This structure is derived from Bundle

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 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
Bundle.type This element is included in summaries. 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.
Required Pattern: collection
Bundle.timestamp This element is included in summaries. C 1..1 instant When the bundle was assembled
Bundle.Slices for entry This element is included in summaries. C 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed 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
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:trustee This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:trustee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:trustee.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:trustee.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:provenance This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:provenance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Who, What, When for a set of resources
Bundle.Slices for entry.entry:provenance.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:provenance.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.response.status This element is included in summaries. 1..1 string Status response code (text optional)

doco Documentation for this format

Terminology Bindings

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:trustee.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

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:trustee, Bundle.entry:provenance 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:trustee, Bundle.entry:provenance 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()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 0..* Bundle Contains a collection of resources
Bundle.id 0..0 Logical id of this artifact
Bundle.meta
Bundle.meta.id 0..0 Unique id for inter-element referencing
Bundle.meta.extension 0..0 Extension
Bundle.meta.versionId 0..0 Version specific identifier
Bundle.meta.lastUpdated 0..0 When the resource version last changed
Bundle.meta.source 0..0 Identifies where the resource comes from
Bundle.meta.profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Bundle.meta.security 0..0 Security Labels applied to this resource
Bundle.meta.tag 0..0 Tags applied to this resource
Bundle.implicitRules 0..0 A set of rules under which this content was created
Bundle.language 0..0 Language of the resource content
Bundle.identifier 0..0 Persistent identifier for the bundle
Bundle.type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: collection
Bundle.timestamp 1..1 instant When the bundle was assembled
Bundle.total 0..0 If search, the total number of matches
Bundle.link 0..0 Links related to this Bundle
Bundle.Slices for entry 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by profile:resource
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id 0..0 Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension 0..0 Extension
Bundle.Slices for entry.entry:All Slices.modifierExtension 0..0 Extension
Bundle.Slices for entry.entry:All Slices.link 0..0 Links related to this entry
Bundle.Slices for entry.entry:All Slices.resource 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search 0..0 Search related information
Bundle.Slices for entry.entry:All Slices.request 0..0 Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response 0..0 Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:provenance 1..1 BackboneElement Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Who, What, When for a set of resources
Bundle.signature 0..0 Digital Signature
Bundle.issues 0..0 Issues with the Bundle

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Bundle 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
Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Bundle.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Bundle.meta.profile This element is included in summaries. 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
Bundle.type This element is included in summaries. 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.
Required Pattern: collection
Bundle.timestamp This element is included in summaries. C 1..1 instant When the bundle was assembled
Bundle.Slices for entry This element is included in summaries. C 2..2 BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed 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
Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. C 1..1 Resource A resource in the bundle
Bundle.Slices for entry.entry:trustee This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:trustee.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:trustee.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:trustee.resource 0..1 AHDTrustee Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well A person that is related to a patient, but who is not a direct target of care
Bundle.Slices for entry.entry:trustee.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:trustee.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:trustee.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:trustee.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:trustee.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:trustee.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:trustee.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:trustee.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:trustee.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:trustee.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:trustee.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:trustee.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:trustee.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:trustee.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:trustee.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:trustee.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:trustee.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:provenance This element is included in summaries. C 1..1 BackboneElement Entry in the bundle - will have a resource or information
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
Bundle.Slices for entry.entry:provenance.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
Bundle.Slices for entry.entry:provenance.fullUrl This element is included in summaries. C 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Bundle.Slices for entry.entry:provenance.resource 0..1 AHDTrusteeSignatureProvenance Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Who, What, When for a set of resources
Bundle.Slices for entry.entry:provenance.search This element is included in summaries. C 0..1 BackboneElement Search related information
Bundle.Slices for entry.entry:provenance.search.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.search.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.search.mode This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:provenance.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.request.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.request.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.request.method This element is included in summaries. 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.
Bundle.Slices for entry.entry:provenance.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:provenance.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache validation
Bundle.Slices for entry.entry:provenance.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
Bundle.Slices for entry.entry:provenance.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
Bundle.Slices for entry.entry:provenance.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
Bundle.Slices for entry.entry:provenance.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:provenance.response.id 0..1 string Unique id for inter-element referencing
Bundle.Slices for entry.entry:provenance.response.extension 0..* Extension Additional content defined by implementations
Bundle.Slices for entry.entry:provenance.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:provenance.response.status This element is included in summaries. 1..1 string Status response code (text optional)
Bundle.Slices for entry.entry:provenance.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
Bundle.Slices for entry.entry:provenance.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:provenance.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
Bundle.Slices for entry.entry:provenance.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)

doco Documentation for this format

Terminology Bindings

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.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:trustee.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:trustee.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​search.mode Base required Search Entry Mode 📍5.0.0 FHIR Std.
Bundle.entry:provenance.​request.method Base required H T T P Verb 📍5.0.0 FHIR Std.

Constraints

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:trustee, Bundle.entry:provenance 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:trustee, Bundle.entry:provenance 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()

This structure is derived from Bundle

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry (Closed)

 

Other representations of profile: CSV, Excel, Schematron