This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions 
SD.12 StructureDefinition-eicr-document-bundle
This Bundle profile represents an eICR Document Bundle. It contains the eICR Composition.
SD.12.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle
Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.
This profile builds on Bundle
Summary
Mandatory: 3 elements
Must-Support: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Bundle.entry is sliced based on the value of profile:$this.resource
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | ||
  id | S | 1..1 | string | eICR Document Bundle id |
| type | S | 1..1 | code | Fixed Value: document |
  entry | S | 0..* | (Slice Definition) | Slice: Unordered, Open by profile:$this.resource |
   entry:sliceEICRComposition | S | 1..1 | BackboneElement | |
 resource | S | 1..1 | Eicr_Composition | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
 id | SΣ | 1..1 | string | eICR Document Bundle id |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| identifier | ΣI | 0..1 | Identifier | Persistent identifier for the bundle |
| type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: document |
| timestamp | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
 url | ΣI | 1..1 | uri | Reference details for the link |
| entry | SΣI | 0..* | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource 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 |
 entry:All Slices | Content/Rules for all slices | |||
  id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| entry:sliceEICRComposition | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | SI | 1..1 | Eicr_Composition | eICR Composition Profile |
 search | ΣI | 0..1 | BackboneElement | Search related information |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | ΣI | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Summary
Mandatory: 3 elements
Must-Support: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Bundle.entry is sliced based on the value of profile:$this.resource
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | ||
| id | S | 1..1 | string | eICR Document Bundle id |
| type | S | 1..1 | code | Fixed Value: document |
| entry | S | 0..* | (Slice Definition) | Slice: Unordered, Open by profile:$this.resource |
| entry:sliceEICRComposition | S | 1..1 | BackboneElement | |
| resource | S | 1..1 | Eicr_Composition | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| id | SΣ | 1..1 | string | eICR Document Bundle id |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| identifier | ΣI | 0..1 | Identifier | Persistent identifier for the bundle |
| type | SΣI | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: document |
| timestamp | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relation | ΣI | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| url | ΣI | 1..1 | uri | Reference details for the link |
| entry | SΣI | 0..* | (Slice Definition) | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource 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 |
| entry:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| entry:sliceEICRComposition | SΣI | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| link | ΣI | 0..* | Unknown reference to #Bundle.link Links related to this entry | |
| fullUrl | ΣI | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| resource | SI | 1..1 | Eicr_Composition | eICR Composition Profile |
| search | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| mode | ΣI | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | ΣI | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required) |
| url | ΣI | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | ΣI | 0..1 | string | For managing cache currency |
| ifModifiedSince | ΣI | 0..1 | instant | For managing cache currency |
| ifMatch | ΣI | 0..1 | string | For managing update contention |
| ifNoneExist | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | ΣI | 1..1 | string | Status response code (text optional) |
| location | ΣI | 0..1 | uri | The location (if the operation returns a location) |
| etag | ΣI | 0..1 | string | The Etag for the resource (if relevant) |
| lastModified | ΣI | 0..1 | instant | Server's date time modified |
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | ΣI | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
