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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10 |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit |
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Pattern Value: transactionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:addEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:updateEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:commit.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | fullUrl cannot be a version specific reference : 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) | |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.url |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit | ||||
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1 From the FHIR Standard | ||||
Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1 From the FHIR Standard | ||||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard
| ||||
Bundle.type | required | Pattern Value: transactionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 From the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:addEmp.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:addEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:updateEmp.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:updateEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:commit.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:commit.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | fullUrl cannot be a version specific reference : 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) | |
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: 3 elements(2 nested mandatory elements)
Must-Support: 17 elements
Prohibited: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-12, bdl-1, bdl-2, bdl-11, bdl-10 |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit |
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Pattern Value: transactionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:addEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:updateEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | |
Bundle.entry:commit.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | fullUrl cannot be a version specific reference : 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) | |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Bundle | Contains a collection of resources | |
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() |
S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.url |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpAddEMPEntryInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $add-emp-entry | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpUpdateEMPEntryInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $update-emp-entry | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | EPAOpEMPCommitInputParameters | Operation Request or Response | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry Required Pattern: $emp-commit | ||||
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1 From the FHIR Standard | ||||
Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1 From the FHIR Standard | ||||
Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 From the FHIR Standard
| ||||
Bundle.type | required | Pattern Value: transactionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 From the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:addEmp.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:addEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:updateEmp.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:updateEmp.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard | ||||
Bundle.entry:commit.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 From the FHIR Standard | ||||
Bundle.entry:commit.request.method | required | Pattern Value: POSThttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | 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&resource.meta.versionId).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:addEmp, Bundle.entry:updateEmp, Bundle.entry:commit | fullUrl cannot be a version specific reference : 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) | |
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: 3 elements(2 nested mandatory elements)
Must-Support: 17 elements
Prohibited: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron