labcomplete AIS-Schnittstelle - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: Fehler
| Official URL: https://fhir.labcomplete.at/ais/v1/StructureDefinition/ais-error-message | Version: 0.1.0 | |||
| Draft as of 2026-10-29 | Computable Name: AisErrorMessage | |||
Copyright/Legal: © 2026 medcom GmbH. Alle Rechte vorbehalten. |
||||
Die Antwort fatal-error oder transient-error mit einer OperationOutcome; von labcomplete auf request-create und session-create, vom AIS auf print-job.
Usages:
- Examples for this Profil: Bundle/print-job-printer-unavailable, Bundle/request-create-error, Bundle/request-create-invalid and Bundle/session-create-unavailable
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, ais-message-id, ais-utc, ais-response-error |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 identifier |
C | 1..1 | Identifier | Persistent identifier for the bundle |
| type |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message (extensions allowed) |
| timestamp |
C | 1..1 | instant | When the bundle was assembled |
  Slices for entry |
C | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   entry:All Slices |
Content/Rules for all slices | |||
   modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
C | 0..1 | Resource | A resource in the bundle |
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
 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:header |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
0..1 | AisMessageHeader  |
A resource that describes a message that is exchanged between systems | |
 request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| 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:outcome |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
0..1 | AisOutcome |
Information about the success/failure of an action | |
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| 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) | |
| issues |
C | 0..1 | OperationOutcome(5.0.0)  |
Issues with the Bundle |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-message-id | error | Bundle | Bundle.identifier ist die messageId, eine UUID als urn:uuid; eine Antwort nennt sie in MessageHeader.response.identifier. |
identifier.system = 'urn:ietf:rfc:3986' and identifier.value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
| ais-utc | error | Bundle | Der Zeitpunkt der Nachricht ist in UTC angegeben. |
timestamp.toString().endsWith('Z')
|
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AisMessage
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: ais-response-error |
 Slices for entry |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:header |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
 resource |
0..1 | AisMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:outcome |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | AisOutcome | Information about the success/failure of an action | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, ais-message-id, ais-utc, ais-response-error | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| identifier |
C | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message (extensions allowed) | ||||
| timestamp |
C | 1..1 | instant | When the bundle was assembled | ||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
C | 0..* | BackboneElement | Links related to this Bundle | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
C | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
| url |
C | 1..1 | uri | Reference details for the link | ||||
| Slices for entry |
C | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
C | 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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:header |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
0..1 | AisMessageHeader |
A resource that describes a message that is exchanged between systems | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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:outcome |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
0..1 | AisOutcome |
Information about the success/failure of an action | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| issues |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-message-id | error | Bundle | Bundle.identifier ist die messageId, eine UUID als urn:uuid; eine Antwort nennt sie in MessageHeader.response.identifier. |
identifier.system = 'urn:ietf:rfc:3986' and identifier.value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
| ais-utc | error | Bundle | Der Zeitpunkt der Nachricht ist in UTC angegeben. |
timestamp.toString().endsWith('Z')
|
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AisMessage
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
- Kopf einer Nachricht (https://fhir.labcomplete.at/ais/v1/StructureDefinition/ais-message-header)
- Fehler (https://fhir.labcomplete.at/ais/v1/StructureDefinition/ais-outcome)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Bundle.entry
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, ais-message-id, ais-utc, ais-response-error |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| identifier |
C | 1..1 | Identifier | Persistent identifier for the bundle |
| type |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message (extensions allowed) |
| timestamp |
C | 1..1 | instant | When the bundle was assembled |
| Slices for entry |
C | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| entry:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
C | 0..1 | Resource | A resource in the bundle |
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| 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:header |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
0..1 | AisMessageHeader |
A resource that describes a message that is exchanged between systems | |
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| 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:outcome |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
0..1 | AisOutcome |
Information about the success/failure of an action | |
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| 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) | |
| issues |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-message-id | error | Bundle | Bundle.identifier ist die messageId, eine UUID als urn:uuid; eine Antwort nennt sie in MessageHeader.response.identifier. |
identifier.system = 'urn:ietf:rfc:3986' and identifier.value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
| ais-utc | error | Bundle | Der Zeitpunkt der Nachricht ist in UTC angegeben. |
timestamp.toString().endsWith('Z')
|
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AisMessage
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: ais-response-error |
| Slices for entry |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:header |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | AisMessageHeader | A resource that describes a message that is exchanged between systems | |
| entry:outcome |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | AisOutcome | Information about the success/failure of an action | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | AisMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, ais-message-id, ais-utc, ais-response-error | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| identifier |
C | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
C | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message (extensions allowed) | ||||
| timestamp |
C | 1..1 | instant | When the bundle was assembled | ||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
C | 0..* | BackboneElement | Links related to this Bundle | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
C | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
| url |
C | 1..1 | uri | Reference details for the link | ||||
| Slices for entry |
C | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
C | 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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:header |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
0..1 | AisMessageHeader |
A resource that describes a message that is exchanged between systems | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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:outcome |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
C | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
0..1 | AisOutcome |
Information about the success/failure of an action | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| 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 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
C | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache validation | |||||
| 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 | |||||
| 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) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| issues |
C | 0..1 | OperationOutcome(5.0.0) |
Issues with the Bundle | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Bundle.type | Base | required | Bundle Type | 📍5.0.0 | FHIR Std. |
| Bundle.link.relation | Base | required | Link Relation Types | 📍5.0.0 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:header.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.search.mode | Base | required | Search Entry Mode | 📍5.0.0 | FHIR Std. |
| Bundle.entry:outcome.request.method | Base | required | H T T P Verb | 📍5.0.0 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Beschreibung | Expression |
| ais-message-id | error | Bundle | Bundle.identifier ist die messageId, eine UUID als urn:uuid; eine Antwort nennt sie in MessageHeader.response.identifier. |
identifier.system = 'urn:ietf:rfc:3986' and identifier.value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
|
| ais-response-error | error | Bundle | Ein Fehler: response.code fatal-error oder transient-error, response.details nennt die OperationOutcome. |
(entry.first().resource.response.code = 'fatal-error' or entry.first().resource.response.code = 'transient-error') and entry.where(resource is OperationOutcome).fullUrl contains entry.first().resource.response.details.reference
|
| ais-utc | error | Bundle | Der Zeitpunkt der Nachricht ist in UTC angegeben. |
timestamp.toString().endsWith('Z')
|
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
(type = 'searchset') or entry.search.empty()
|
| bdl-5 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:header, Bundle.entry:outcome | fullUrl cannot be a version specific reference |
fullUrl.exists() implies fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource |
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
|
| bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history |
type = 'history' implies entry.request.method != 'PATCH'
|
| bdl-15 | error | Bundle | Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated |
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
|
| bdl-16 | error | Bundle | Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. |
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
|
| bdl-17 | error | Bundle | Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. |
type = 'document' implies issues.empty()
|
| bdl-18 | error | Bundle | Self link is required for searchsets. |
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
|
| bdl-3a | error | Bundle | For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements |
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
|
| bdl-3b | error | Bundle | For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH |
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3c | error | Bundle | For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH |
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
|
| bdl-3d | error | Bundle | For collections of type transaction-response or batch-response, all entries must contain response elements |
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AisMessage
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
- Kopf einer Nachricht (https://fhir.labcomplete.at/ais/v1/StructureDefinition/ais-message-header)
- Fehler (https://fhir.labcomplete.at/ais/v1/StructureDefinition/ais-outcome)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Bundle.entry
Other representations of profile: CSV, Excel, Schematron