Bundle.profile.xml

StructureDefinition for bundle

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Bundle"/>
  <meta>
    <lastUpdated value="2015-04-03T14:24:32.000+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
  <name value="Bundle"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Bundle Resource"/>
  <status value="draft"/>
  <date value="2015-04-03T14:24:32+11:00"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="Bundle"/>
      <short value="Contains a collection of resources"/>
      <definition value="A container for a collection of resources."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
      <constraint>
        <key value="bdl-2"/>
        <name value="entry.search"/>
        <severity value="error"/>
        <human value="entry.search only when a search"/>
        <xpath value="not(f:entry/f:search) or (f:type/@value = 'searchset')"/>
      </constraint>
      <constraint>
        <key value="bdl-1"/>
        <name value="total"/>
        <severity value="error"/>
        <human value="total only when a search or history"/>
        <xpath value="not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"/>
      </constraint>
      <constraint>
        <key value="bdl-3"/>
        <name value="entry.transaction"/>
        <severity value="error"/>
        <human value="entry.transaction when (and only when) a transaction"/>
        <xpath value="not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history')"/>
      </constraint>
      <constraint>
        <key value="bdl-4"/>
        <name value="entry.transactionResponse"/>
        <severity value="error"/>
        <human value="entry.transactionResponse when (and only when) a transaction-response"/>
        <xpath value="not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response')"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="Bundle.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="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."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="Bundle.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="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 as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="Bundle.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="Bundle.type"/>
      <short value="document | message | transaction | transaction-response | history | searchset | collection"/>
      <definition value="Indicates the purpose of this bundle- how it was intended to be used."/>
      <comments value="It's possible to use a bundle for other purposes (e.g. a document can be accepted as a
       transaction). This is primarily defined so that there can be specific rules for some of
       the bundle types."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="BundleType"/>
        <strength value="required"/>
        <description value="Indicates the purpose of a bundle- how it was intended to be used"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/bundle-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.base"/>
      <short value="Stated Base URL"/>
      <definition value="The base URL for the service that provided these resources. All relative URLs are relative
       to this one (equivalent to xml:base)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.total"/>
      <short value="If search, the total number of matches"/>
      <definition value="If a set of search matches, this is the total number of matches for the search (as opposed
       to the number of results in this bundle)."/>
      <comments value="Only used if the bundle is a search result set."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="unsignedInt"/>
      </type>
      <condition value="bdl-1"/>
    </element>
    <element>
      <path value="Bundle.link"/>
      <name value="link"/>
      <short value="Links related to this Bundle"/>
      <definition value="A series of links that provide context to this bundle."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="Bundle.link.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.link.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.link.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 that contains it. Usually
       modifier elements provide negation or qualification. In order 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 is allowed to 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."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.link.relation"/>
      <short value="http://www.iana.org/assignments/link-relations/link-relations.xhtml"/>
      <definition value="A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-r
      elations/link-relations.xhtml]]."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.link.url"/>
      <short value="Reference details for the link"/>
      <definition value="The reference details for the link."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry"/>
      <short value="Entry in the bundle - will have a resource, or information"/>
      <definition value="An entry in a bundle resource - will either contain a resource, or information about a
       resource (transactions and history only)."/>
      <min value="0"/>
      <max value="*"/>
      <constraint>
        <key value="bdl-5"/>
        <name value="entry.resource"/>
        <severity value="error"/>
        <human value="must be a resource unless there's a transaction or transaction response"/>
        <xpath value="f:resource or f:transaction or f:transactionResponse"/>
      </constraint>
    </element>
    <element>
      <path value="Bundle.entry.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 that contains it. Usually
       modifier elements provide negation or qualification. In order 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 is allowed to 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."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.base"/>
      <short value="Base URL, if different to bundle base"/>
      <definition value="The Base URL for the resource, if different to the base URL specified for the bundle as
       a whole."/>
      <comments value="This allows bundles to be composed of resources from multiple servers (collated search,
       documents etc)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.link"/>
      <short value="Links related to this entry"/>
      <definition value="A series of links that provide context to this entry."/>
      <min value="0"/>
      <max value="*"/>
      <nameReference value="link"/>
    </element>
    <element>
      <path value="Bundle.entry.resource"/>
      <short value="Resources in this bundle"/>
      <definition value="The Resources for the entry."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.search"/>
      <short value="Search related information"/>
      <definition value="Information about the search process that lead to the creation of this entry."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-2"/>
    </element>
    <element>
      <path value="Bundle.entry.search.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.search.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.search.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 that contains it. Usually
       modifier elements provide negation or qualification. In order 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 is allowed to 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."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.search.mode"/>
      <short value="match | include - why this is in the result set"/>
      <definition value="Why this entry is in the result set - whether it's included as a match or because of an
       _include requirement."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="SearchEntryMode"/>
        <strength value="required"/>
        <description value="Why an entry is in the result set - whether it's included as a match or because of an
         _include requirement"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/search-entry-mode"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.entry.search.score"/>
      <short value="Search ranking (between 0 and 1)"/>
      <definition value="When searching, the server's search ranking score for the entry."/>
      <comments value="Servers are not required to return a ranking score. 1 is most relevant, and 0 is least
       relevant. Often, search results are sorted by score, but the client may specify a different
       sort order."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction"/>
      <short value="Transaction Related Information"/>
      <definition value="Additional information about how this entry should be processed as part of a transaction."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-3"/>
    </element>
    <element>
      <path value="Bundle.entry.transaction.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transaction.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transaction.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 that contains it. Usually
       modifier elements provide negation or qualification. In order 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 is allowed to 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."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transaction.method"/>
      <short value="GET | POST | PUT | DELETE"/>
      <definition value="The HTTP verb for this entry in either a update history, or a transaction/ transaction
       response."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="HTTPVerb"/>
        <strength value="required"/>
        <description value="HTTP verbs (in the HTTP command line)"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/http-verb"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.entry.transaction.url"/>
      <short value="The URL for the transaction"/>
      <definition value="A search URL for this resource that specifies how the resource is matched to an existing
       resource when processing a transaction (see transaction documentation)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifNoneMatch"/>
      <short value="For managing cache currency"/>
      <definition value="If the ETag values match, return a 304 Not modified status. See the read/vread interaction
       documentation."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifMatch"/>
      <short value="For managing update contention"/>
      <definition value="Only perform the operation if the Etag value matches. For more information, see the API
       section &quot;Managing Resource Contention&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifModifiedSince"/>
      <short value="For managing update contention"/>
      <definition value="Only perform the operation if the last updated date matches. For more information, see
       the API section &quot;Managing Resource Contention&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifNoneExist"/>
      <short value="For conditional creates"/>
      <definition value="Instruct the server not to perform the create if a specified resource already exists.
       For further information, see &quot;Conditional Create&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse"/>
      <short value="Transaction Related Information"/>
      <definition value="Additional information about how this entry should be processed as part of a transaction."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-4"/>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 that contains it. Usually
       modifier elements provide negation or qualification. In order 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 is allowed to 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."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.status"/>
      <short value="Status return code for entry"/>
      <definition value="The status code returned by processing this entry."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.location"/>
      <short value="The location, if the operation returns a location"/>
      <definition value="The location header created by processing this operation."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.etag"/>
      <short value="The etag for the resource (if relevant)"/>
      <definition value="The etag for the resource, it the operation for the entry produced a versioned resource."/>
      <comments value="This has to match the version id in the header if a resource is included."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.lastModified"/>
      <short value="Server's date time modified"/>
      <definition value="The date/time that the resource was modified on the server."/>
      <comments value="This has to match the same time in the meta header if a resource is included."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Bundle.signature"/>
      <short value="XML Digital Signature (base64 encoded)"/>
      <definition value="XML Digital Signature - base64 encoded."/>
      <comments value="This is base 64 encoded to address issues with json/xml."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Bundle"/>
      <short value="Contains a collection of resources"/>
      <definition value="A container for a collection of resources."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
      <constraint>
        <key value="bdl-2"/>
        <name value="entry.search"/>
        <severity value="error"/>
        <human value="entry.search only when a search"/>
        <xpath value="not(f:entry/f:search) or (f:type/@value = 'searchset')"/>
      </constraint>
      <constraint>
        <key value="bdl-1"/>
        <name value="total"/>
        <severity value="error"/>
        <human value="total only when a search or history"/>
        <xpath value="not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"/>
      </constraint>
      <constraint>
        <key value="bdl-3"/>
        <name value="entry.transaction"/>
        <severity value="error"/>
        <human value="entry.transaction when (and only when) a transaction"/>
        <xpath value="not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history')"/>
      </constraint>
      <constraint>
        <key value="bdl-4"/>
        <name value="entry.transactionResponse"/>
        <severity value="error"/>
        <human value="entry.transactionResponse when (and only when) a transaction-response"/>
        <xpath value="not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response')"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Bundle.type"/>
      <short value="document | message | transaction | transaction-response | history | searchset | collection"/>
      <definition value="Indicates the purpose of this bundle- how it was intended to be used."/>
      <comments value="It's possible to use a bundle for other purposes (e.g. a document can be accepted as a
       transaction). This is primarily defined so that there can be specific rules for some of
       the bundle types."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="BundleType"/>
        <strength value="required"/>
        <description value="Indicates the purpose of a bundle- how it was intended to be used"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/bundle-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.base"/>
      <short value="Stated Base URL"/>
      <definition value="The base URL for the service that provided these resources. All relative URLs are relative
       to this one (equivalent to xml:base)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.total"/>
      <short value="If search, the total number of matches"/>
      <definition value="If a set of search matches, this is the total number of matches for the search (as opposed
       to the number of results in this bundle)."/>
      <comments value="Only used if the bundle is a search result set."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="unsignedInt"/>
      </type>
      <condition value="bdl-1"/>
    </element>
    <element>
      <path value="Bundle.link"/>
      <name value="link"/>
      <short value="Links related to this Bundle"/>
      <definition value="A series of links that provide context to this bundle."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="Bundle.link.relation"/>
      <short value="http://www.iana.org/assignments/link-relations/link-relations.xhtml"/>
      <definition value="A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-r
      elations/link-relations.xhtml]]."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.link.url"/>
      <short value="Reference details for the link"/>
      <definition value="The reference details for the link."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry"/>
      <short value="Entry in the bundle - will have a resource, or information"/>
      <definition value="An entry in a bundle resource - will either contain a resource, or information about a
       resource (transactions and history only)."/>
      <min value="0"/>
      <max value="*"/>
      <constraint>
        <key value="bdl-5"/>
        <name value="entry.resource"/>
        <severity value="error"/>
        <human value="must be a resource unless there's a transaction or transaction response"/>
        <xpath value="f:resource or f:transaction or f:transactionResponse"/>
      </constraint>
    </element>
    <element>
      <path value="Bundle.entry.base"/>
      <short value="Base URL, if different to bundle base"/>
      <definition value="The Base URL for the resource, if different to the base URL specified for the bundle as
       a whole."/>
      <comments value="This allows bundles to be composed of resources from multiple servers (collated search,
       documents etc)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.link"/>
      <short value="Links related to this entry"/>
      <definition value="A series of links that provide context to this entry."/>
      <min value="0"/>
      <max value="*"/>
      <nameReference value="link"/>
    </element>
    <element>
      <path value="Bundle.entry.resource"/>
      <short value="Resources in this bundle"/>
      <definition value="The Resources for the entry."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.search"/>
      <short value="Search related information"/>
      <definition value="Information about the search process that lead to the creation of this entry."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-2"/>
    </element>
    <element>
      <path value="Bundle.entry.search.mode"/>
      <short value="match | include - why this is in the result set"/>
      <definition value="Why this entry is in the result set - whether it's included as a match or because of an
       _include requirement."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="SearchEntryMode"/>
        <strength value="required"/>
        <description value="Why an entry is in the result set - whether it's included as a match or because of an
         _include requirement"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/search-entry-mode"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.entry.search.score"/>
      <short value="Search ranking (between 0 and 1)"/>
      <definition value="When searching, the server's search ranking score for the entry."/>
      <comments value="Servers are not required to return a ranking score. 1 is most relevant, and 0 is least
       relevant. Often, search results are sorted by score, but the client may specify a different
       sort order."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction"/>
      <short value="Transaction Related Information"/>
      <definition value="Additional information about how this entry should be processed as part of a transaction."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-3"/>
    </element>
    <element>
      <path value="Bundle.entry.transaction.method"/>
      <short value="GET | POST | PUT | DELETE"/>
      <definition value="The HTTP verb for this entry in either a update history, or a transaction/ transaction
       response."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="HTTPVerb"/>
        <strength value="required"/>
        <description value="HTTP verbs (in the HTTP command line)"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/http-verb"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="Bundle.entry.transaction.url"/>
      <short value="The URL for the transaction"/>
      <definition value="A search URL for this resource that specifies how the resource is matched to an existing
       resource when processing a transaction (see transaction documentation)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifNoneMatch"/>
      <short value="For managing cache currency"/>
      <definition value="If the ETag values match, return a 304 Not modified status. See the read/vread interaction
       documentation."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifMatch"/>
      <short value="For managing update contention"/>
      <definition value="Only perform the operation if the Etag value matches. For more information, see the API
       section &quot;Managing Resource Contention&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifModifiedSince"/>
      <short value="For managing update contention"/>
      <definition value="Only perform the operation if the last updated date matches. For more information, see
       the API section &quot;Managing Resource Contention&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transaction.ifNoneExist"/>
      <short value="For conditional creates"/>
      <definition value="Instruct the server not to perform the create if a specified resource already exists.
       For further information, see &quot;Conditional Create&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse"/>
      <short value="Transaction Related Information"/>
      <definition value="Additional information about how this entry should be processed as part of a transaction."/>
      <min value="0"/>
      <max value="1"/>
      <condition value="bdl-4"/>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.status"/>
      <short value="Status return code for entry"/>
      <definition value="The status code returned by processing this entry."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.location"/>
      <short value="The location, if the operation returns a location"/>
      <definition value="The location header created by processing this operation."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.etag"/>
      <short value="The etag for the resource (if relevant)"/>
      <definition value="The etag for the resource, it the operation for the entry produced a versioned resource."/>
      <comments value="This has to match the version id in the header if a resource is included."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="Bundle.entry.transactionResponse.lastModified"/>
      <short value="Server's date time modified"/>
      <definition value="The date/time that the resource was modified on the server."/>
      <comments value="This has to match the same time in the meta header if a resource is included."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="Bundle.signature"/>
      <short value="XML Digital Signature (base64 encoded)"/>
      <definition value="XML Digital Signature - base64 encoded."/>
      <comments value="This is base 64 encoded to address issues with json/xml."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </differential>
</StructureDefinition>