Implementation Guide
ePA Medication Service
Version 1.2.0 - release

Resource Profile: Batch API eMP-Einträge - Request-Bundle

Official URL: https://gematik.de/fhir/epa-medication/StructureDefinition/epa-batch-emp-request-bundle Version: 1.2.0
Active as of 2025-09-12 Computable Name: EPABatchEmpRequestBundle

Copyright/Legal: gematik GmbH

Request-Bundle für die Batch-Operation zur Verarbeitung von eMP-Einträgen. Erlaubt sind ausschließlich FHIR-Operationen (POST) für den eMP. $emp-commit MUSS genau einmal vorkommen. Es sind keine direkten Ressourcen-CRUDs zulässig.

Usages:

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: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: transaction
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:addEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
.... entry:updateEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
.... entry:commit SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:commit.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... link 0..0
.... entry:addEmp S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0
.... entry:updateEmp S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0
.... entry:commit S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.url
Constraints: bdl-8, bdl-5
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - 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.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:addEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
.... entry:updateEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
.... entry:commit SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags|4.0.1
From the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:commit.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:commit.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: transaction
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:addEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
.... entry:updateEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
.... entry:commit SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:commit.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: transaction
... link 0..0
.... entry:addEmp S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0
.... entry:updateEmp S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0
.... entry:commit S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... fullUrl S 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... search 0..0
..... request S 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... method 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
...... url 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit
...... ifNoneMatch 0..0
...... ifModifiedSince 0..0
...... ifMatch 0..0
...... ifNoneExist 0..0
..... response 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Required Pattern: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.url
Constraints: bdl-8, bdl-5
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - 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.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:addEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpAddEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $add-emp-entry
.... entry:updateEmp SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpUpdateEMPEntryInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $update-emp-entry
.... entry:commit SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-8, bdl-5
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
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EPAOpEMPCommitInputParameters Operation Request or Response
..... request SΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Required Pattern: POST
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
Required Pattern: $emp-commit
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags|4.0.1
From the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:addEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:updateEmp.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:commit.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:commit.request.methodrequiredPattern Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commitfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

 

Other representations of profile: CSV, Excel, Schematron