FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work Group Maturity Level: 0Informative Use Context: Any

The canonical URL for this profile is:

http://hl7.org/fhir/StructureDefinition/batch-response-bundle

This profile holds all the requirements and constraints related to a FHIR batch response.

This profile was published on Wed, Mar 11, 2015 00:00+0000 as a draft by Health Level Seven, Inc. - FHIR Core WG.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Bundle.

Summary

Mandatory: 0 element (+1 nested mandatory element)
Prohibited: 3 elements

This indicates the differences between this profile and the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle Bundle
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: batch-response
... total 0..0
... entry
.... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
.... search 0..0
.... request 0..0

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C icon0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier ΣC icon0..1IdentifierPersistent identifier for the bundle
... type ΣC icon1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: Bundle Type (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: batch-response
... timestamp ΣC icon0..1instantWhen the bundle was assembled
... link ΣC icon0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣC icon1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types (required)
.... url ΣC icon1..1uriReference details for the link
... entry ΣC icon0..*BackboneElementEntry 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
.... resource ΣC icon0..1ResourceA resource in the bundle
.... response ΣC icon0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature
... issues ΣC icon0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format icon
<!-- BatchResponseBundle -->doco

<Bundle xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <identifier><!-- I 0..1 Identifier Persistent identifier for the bundle --></identifier>
 <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification   -->
 <timestamp value="[instant]"/><!-- I 0..1 When the bundle was assembled -->
 <total value="[unsignedInt]"/><!-- I 0..0 If search, the total number of matches -->
 <link> I 0..* BackboneElement  <!-- I 0..* Links related to this Bundle -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1   -->
  <url value="[uri]"/><!-- I 1..1 Reference details for the link -->
 </link>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 0..0 BackboneElement  <!-- I 0..0 Additional execution information (transaction/batch/history) -->
  </request>
  <response> I 0..1 BackboneElement  <!-- I 0..1 Results of execution (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <status value="[string]"/><!-- I 1..1 Status response code (text optional) -->
   <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) -->
   <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) -->
   <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified -->
   <outcome><!-- 0..1 Resource 
       OperationOutcome with hints and warnings (for batch/transaction) --></outcome>
  </response>
 </entry>
 <signature><!-- I 0..1 Signature Digital Signature --></signature>
 <issues><!-- 0..1 Resource Issues with the Bundle --></issues>
</Bundle>
{ // BatchResponseBundle
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "identifier" : { Identifier }, // IPersistent identifier for the bundle
    "type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
    "timestamp" : "<instant>", // IWhen the bundle was assembled
    "link" : [{ BackboneElement }], // ILinks related to this Bundle
    "entry" : [{ BackboneElement }], // IEntry in the bundle - will have a resource or information
    "signature" : { Signature }, // IDigital Signature
    "issues" : { Resource(OperationOutcome) } //Issues with the Bundle
  }

This structure is derived from Bundle.

Summary

Mandatory: 0 element (+1 nested mandatory element)
Prohibited: 3 elements

Differential View

This indicates the differences between this profile and the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle Bundle
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: batch-response
... total 0..0
... entry
.... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
.... search 0..0
.... request 0..0

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C icon0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier ΣC icon0..1IdentifierPersistent identifier for the bundle
... type ΣC icon1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: Bundle Type (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: batch-response
... timestamp ΣC icon0..1instantWhen the bundle was assembled
... link ΣC icon0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣC icon1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types (required)
.... url ΣC icon1..1uriReference details for the link
... entry ΣC icon0..*BackboneElementEntry 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
.... resource ΣC icon0..1ResourceA resource in the bundle
.... response ΣC icon0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature
... issues ΣC icon0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format icon

XML Template

<!-- BatchResponseBundle -->doco

<Bundle xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <identifier><!-- I 0..1 Identifier Persistent identifier for the bundle --></identifier>
 <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification   -->
 <timestamp value="[instant]"/><!-- I 0..1 When the bundle was assembled -->
 <total value="[unsignedInt]"/><!-- I 0..0 If search, the total number of matches -->
 <link> I 0..* BackboneElement  <!-- I 0..* Links related to this Bundle -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1   -->
  <url value="[uri]"/><!-- I 1..1 Reference details for the link -->
 </link>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 0..0 BackboneElement  <!-- I 0..0 Additional execution information (transaction/batch/history) -->
  </request>
  <response> I 0..1 BackboneElement  <!-- I 0..1 Results of execution (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <status value="[string]"/><!-- I 1..1 Status response code (text optional) -->
   <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) -->
   <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) -->
   <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified -->
   <outcome><!-- 0..1 Resource 
       OperationOutcome with hints and warnings (for batch/transaction) --></outcome>
  </response>
 </entry>
 <signature><!-- I 0..1 Signature Digital Signature --></signature>
 <issues><!-- 0..1 Resource Issues with the Bundle --></issues>
</Bundle>

JSON Template

{ // BatchResponseBundle
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "identifier" : { Identifier }, // IPersistent identifier for the bundle
    "type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
    "timestamp" : "<instant>", // IWhen the bundle was assembled
    "link" : [{ BackboneElement }], // ILinks related to this Bundle
    "entry" : [{ BackboneElement }], // IEntry in the bundle - will have a resource or information
    "signature" : { Signature }, // IDigital Signature
    "issues" : { Resource(OperationOutcome) } //Issues with the Bundle
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
Bundle.languageAll LanguagesrequiredAll Languages
Bundle.typeBundle TyperequiredBundle Type
Bundle.link.relationLink Relation TypesrequiredLink Relation Types
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
. .