Left: | Catalog Item Transaction Request (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionResponse) |
Right: | Catalog Item Transaction Request (http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionResponse) |
Error | StructureDefinition.version | Values for version differ: '0.1.0' vs 'current' |
Information | StructureDefinition.date | Values for date differ: '2020-08-09T15:19:11+00:00' vs '2023-07-08T20:53:25+00:00' |
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '4.0.1' vs '5.0.0' |
Warning | Bundle.id | Elements differ in comments: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.' vs 'Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.' |
Warning | Bundle.implicitRules | Elements differ in comments: 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.' vs 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.' |
Warning | Bundle.language | Elements differ in binding.description: 'A human language.' vs 'IETF language tag for a human language' |
Warning | Bundle.type | Elements differ in short: 'document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection' vs 'document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification' |
Warning | Bundle.total | Elements differ in definition: 'If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.' vs 'If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.' |
Warning | Bundle.link | Elements differ in comments: 'Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS]). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read] directly. This specification defines some specific uses of Bundle.link for [searching] and [paging], but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.' vs 'Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS]). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read] directly. This specification defines some specific uses of Bundle.link for [searching] and [paging], but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.' |
Warning | Bundle.link.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | Bundle.link.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Bundle.entry.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | Bundle.entry.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Bundle.entry.fullUrl | Elements differ in short: 'URI for resource (Absolute URL server address or URI for UUID/OID)' vs 'URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)' |
Warning | Bundle.entry.fullUrl | Elements differ in definition: 'The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified.' vs 'The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation.' |
Warning | Bundle.entry.resource | Elements differ in definition: 'The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.' vs 'The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.' |
Warning | Bundle.entry.search.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | Bundle.entry.search.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Bundle.entry.search.mode | Elements differ in short: 'match | include | outcome - why this is in the result set' vs 'match | include - why this is in the result set' |
Warning | Bundle.entry.request.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | Bundle.entry.request.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Bundle.entry.request.ifNoneMatch | Elements differ in short: 'For managing cache currency' vs 'For managing cache validation' |
Warning | Bundle.entry.response.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
Warning | Bundle.entry.response.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Bundle.signature | Elements differ in definition: 'Digital Signature - base64 encoded. XML-DSig or a JWT.' vs 'Digital Signature - base64 encoded. XML-DSig or a JWS.' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Bundle | ||
copyright | |||
date | 2020-08-09T15:19:11+00:00 | 2023-07-08T20:53:25+00:00 |
|
description | This profile constrains the Bundle resource to convey a response to a transaction request about creating/updating/deleting/patching items and/or supporting resources in a catalog. | ||
experimental | |||
fhirVersion | 4.0.1 | 5.0.0 |
|
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | ItemTransactionResponse | ||
publisher | HL7 International - Orders and Observations Work Group | ||
purpose | |||
status | draft | ||
title | Catalog Item Transaction Request | ||
type | Bundle | ||
url | http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionResponse | ||
version | 0.1.0 | current |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources | C | 0..* | Bundle | Contains a collection of resources | |||||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
| ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| ||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language |
| ||||||
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ΣC | 0..1 | Identifier | Persistent identifier for the bundle | |||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction-response | ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: ?? (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction-response |
| ||||
timestamp | Σ | 0..1 | instant | When the bundle was assembled | ΣC | 0..1 | instant | When the bundle was assembled | |||||
total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ΣC | 0..1 | unsignedInt | If search, the total number of matches |
| ||||
link | Σ | 0..* | BackboneElement | Links related to this Bundle | ΣC | 0..* | BackboneElement | Links related to this Bundle |
| ||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: ?? (required) | |||||
url | Σ | 1..1 | uri | Reference details for the link | ΣC | 1..1 | uri | Reference details for the link | |||||
entry | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 | ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
link | Σ | 0..* | See link | Links related to this entry | Σ | 0..* | See link (Bundle) | Links related to this entry | |||||
fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| ||||
resource | Σ | 1..1 | Resource | A resource in the bundle | ΣC | 1..1 | Resource | A resource in the bundle |
| ||||
search | ΣC | 0..0 | ΣC | 0..0 | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: ?? (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 | code | match | include - why this is in the result set Binding: ?? (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) | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | |||||
request | ΣC | 0..0 | ΣC | 0..0 | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: ?? (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | |||||
ifNoneMatch | Σ | 0..1 | string | For managing cache currency | Σ | 0..1 | string | For managing cache validation |
| ||||
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | Σ | 0..1 | instant | For managing cache currency | |||||
ifMatch | Σ | 0..1 | string | For managing update contention | Σ | 0..1 | string | For managing update contention | |||||
ifNoneExist | Σ | 0..1 | string | For conditional creates | Σ | 0..1 | string | For conditional creates | |||||
response | ΣC | 1..1 | BackboneElement | Results of execution (transaction/batch/history) | ΣC | 1..1 | BackboneElement | Results of execution (transaction/batch/history) | |||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations |
| ||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
status | Σ | 1..1 | string | Status response code (text optional) | Σ | 1..1 | string | Status response code (text optional) | |||||
location | Σ | 0..1 | uri | The location (if the operation returns a location) | Σ | 0..1 | uri | The location (if the operation returns a location) | |||||
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | Σ | 0..1 | string | The Etag for the resource (if relevant) | |||||
lastModified | Σ | 0..1 | instant | Server's date time modified | Σ | 0..1 | instant | Server's date time modified | |||||
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
signature | ΣTU | 0..1 | Signature | Digital Signature | ΣTU | 0..1 | Signature | Digital Signature |
| ||||
issues | ΣCTU | 0..1 | ?? | Issues with the Bundle |
| ||||||||
Documentation for this format |