This page is part of the Da Vinci Clinical Documentation Exchange (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
SD.2 StructureDefinition-cdex-transaction-bundle
title: StructureDefinition-cdex-transaction-bundle-intro layout: default active: StructureDefinition-cdex-transaction-bundle-intro —
SD.2.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-transaction-bundle
Published on Thu Jun 20 16:38:59 EDT 2019 as a active by .
This profile builds on Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | |||
type | 1..1 | code | Fixed Value: transaction | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Contains a collection of resources | |
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: transaction |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | ΣI | 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 | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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..* | Unknown reference to #Bundle.link Links related to this entry | |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 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 | outcome - why this is in the result set Binding: SearchEntryMode (required) |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 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 | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 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 |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | |||
type | 1..1 | code | Fixed Value: transaction | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Contains a collection of resources | |
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: transaction |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | ΣI | 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 | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response 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..* | Unknown reference to #Bundle.link Links related to this entry | |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 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 | outcome - why this is in the result set Binding: SearchEntryMode (required) |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 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 | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 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 |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron