3.82 StructureDefinition: Interaction Bundle - Clear Message Queue Response
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response
3.82.1 Scope and Usage
This will be structured as a bundle that contains an entry response for each requested entry where the status value of success or failed will be positional in accordance to the request. There is no Identifier returned.
A HTTP 200 success parent bundle result is returned with a Bundle.entry.response.status value of a successful result "202 Accepted" and/or a failed result of HTTP 4xx, 5xx, or other error text.
For further details refer to the appropriate section within the functional specification documents on how to reconcile and handle these errors when they occur during the polling process, the retrieval of held and deferred bundles or when returning retrieved deferred bundles back to PrescribeIT®.
3.82.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Shared Health Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Bundle | 0..* | Shared Health Bundle | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. |
 id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT® system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT® system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
 profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| profile (profile) | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
 tag(version) | 1..1 | Coding | Binding: SharedSpecificationVersion (20210501) (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. Usage Note: Only these 2 situations are not enforced by FHIR Validator:
|
  system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
 code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| type | 1..1 | code | Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch-response Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: batch-response |
| entry | 1..* | BackboneElement | bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| response | 1..1 | BackboneElement | Definition: Additional information about how this entry should be processed as part of a transaction. |
| status | 1..1 | string | Definition: The status code returned by processing this entry. The status may start with a 3 digit HTTP code (e.g. 202, 404, etc.) and may contain the standard HTTP description associated with the status code or may contain other codes and descriptions of errors returned by PrescribeIT®. Errors codes from the ‘Shared Issue Details’ subset may be returned instead of HTTP codes. Conformance Rule: Any status value that does not being with ‘202 accepted’ should be treated as a failure. |
| extension (statusTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: Usage: The French translation of the status code will only be returned in certain scenarios. If French text is needed for the display and it is not provided you should use fall back and use the English text that is provided. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (statusTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
This structure is derived from Shared Health Bundle
Summary
Mandatory: 8 elements (3 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Slices
This structure defines the following Slices:
- The element Bundle.meta.profile is sliced based on the value of value:value
This structure is derived from Shared Health Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Bundle | S | 0..* | Shared Health Bundle | Contains a collection of resources |
 meta | S | 1..1 | Meta | Metadata about the resource |
 profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
  profile:profile | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
 tag:version | S | 1..1 | Coding | Tags applied to this resource |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: batch-response |
| total | 0..0 | |||
| entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | S | 1..1 | BackboneElement | Transaction Related Information |
| status | S | 1..1 | string | Status response code (text optional) |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| url | S | 1..1 | uri | identifies the meaning of the extension |
| value[x] | S | 1..1 | string | Value of extension |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| location | 0..0 | |||
| etag | 0..1 | string | The etag for the resource (if relevant) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Shared Health Bundle | Contains a collection of resources |
 id | SΣ | 0..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | SΣ | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| tag:version | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| type | SΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch-response |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | 0..* | See link (Bundle) | Links related to this entry | |
| response | SΣI | 1..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | SΣ | 1..1 | string | Status response code (text optional) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| etag | Σ | 0..1 | string | The etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Bundle | 0..* | Shared Health Bundle | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. |
| id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT® system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT® system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
| profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| profile (profile) | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (20210501) (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. Usage Note: Only these 2 situations are not enforced by FHIR Validator:
|
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| type | 1..1 | code | Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch-response Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: batch-response |
| entry | 1..* | BackboneElement | bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| response | 1..1 | BackboneElement | Definition: Additional information about how this entry should be processed as part of a transaction. |
| status | 1..1 | string | Definition: The status code returned by processing this entry. The status may start with a 3 digit HTTP code (e.g. 202, 404, etc.) and may contain the standard HTTP description associated with the status code or may contain other codes and descriptions of errors returned by PrescribeIT®. Errors codes from the ‘Shared Issue Details’ subset may be returned instead of HTTP codes. Conformance Rule: Any status value that does not being with ‘202 accepted’ should be treated as a failure. |
| extension (statusTranslation) | 0..1 | translation | Definition: An expression of the original string in an alternate language. Comments: Usage: The French translation of the status code will only be returned in certain scenarios. If French text is needed for the display and it is not provided you should use fall back and use the English text that is provided. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
| value[x] | 1..1 | string | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| extension (statusTranslationLanguage) | 1..1 | language | Definition: The language in which the string is expressed. |
This structure is derived from Shared Health Bundle
Summary
Mandatory: 8 elements (3 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
- http://hl7.org/fhir/StructureDefinition/iso21090-ST-language
Slices
This structure defines the following Slices:
- The element Bundle.meta.profile is sliced based on the value of value:value
Differential View
This structure is derived from Shared Health Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | S | 0..* | Shared Health Bundle | Contains a collection of resources |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:profile | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
| tag:version | S | 1..1 | Coding | Tags applied to this resource |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| type | S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: batch-response |
| total | 0..0 | |||
| entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| fullUrl | 0..0 | |||
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 0..0 | |||
| response | S | 1..1 | BackboneElement | Transaction Related Information |
| status | S | 1..1 | string | Status response code (text optional) |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| url | S | 1..1 | uri | identifies the meaning of the extension |
| value[x] | S | 1..1 | string | Value of extension |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| location | 0..0 | |||
| etag | 0..1 | string | The etag for the resource (if relevant) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Shared Health Bundle | Contains a collection of resources |
| id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | SΣ | 1..* | (Slice Definition) | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| tag:version | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| type | SΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used. Fixed Value: batch-response |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | 0..* | See link (Bundle) | Links related to this entry | |
| response | SΣI | 1..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | SΣ | 1..1 | string | Status response code (text optional) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-translation | S | 0..1 | string | translation URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation" |
| value[x] | S | 1..1 | string | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| iso21090-ST-language | S | 1..1 | code | language URL: http://hl7.org/fhir/StructureDefinition/iso21090-ST-language Binding: http://tools.ietf.org/html/bcp47 (required): A human language. |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| etag | Σ | 0..1 | string | The etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.82.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Bundle.meta.security | extensible | All Security Labels |
| Bundle.meta.tag | example | |
| Bundle.meta.tag:version | required | SharedSpecificationVersion |
| Bundle.language | required | http://tools.ietf.org/html/bcp47 |
| Bundle.type | required | Fixed Value: batch-response |
| Bundle.entry.search.mode | required | SearchEntryMode |
| Bundle.entry.request.method | required | HTTPVerb |
3.82.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-7 | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId : entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-3 | Bundle | entry.request only for some types of bundles : entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history' | |
| bdl-4 | Bundle | entry.response only for some types of bundles : entry.response.empty() or type = 'batch-response' or type = 'transaction-response' | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-6 | Bundle.entry | The fullUrl element must be present when a resource is present, and not present otherwise : fullUrl.empty() xor resource.exists() |