Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Nictiz.IHE.MHD.ProvideDocumentBundle.Minimal - Detailed Descriptions

Active as of 2019-07-29

Definitions for the IHE.MHD.ProvideDocumentBundle.Minimal resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Bundle
2. Bundle.type
Shorttransaction
Fixed Valuetransaction
4. Bundle.entry
SlicingThis element introduces a set of slices on Bundle.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ resource
  • 6. Bundle.entry:DocumentManifest
    Slice NameDocumentManifest
    ShortDocumentManifest
    Control1..1
    8. Bundle.entry:DocumentManifest.fullUrl
    Control1..?
    10. Bundle.entry:DocumentManifest.resource
    Comments

    Nictiz: replaced profile reference to corrected IHE MHD DocumentManifest profile.

    Control1..?
    TypeDocumentManifest(Nictiz IHE MHD Profile on DocumentManifest (SubmissionSet))
    12. Bundle.entry:DocumentManifest.request
    Control1..?
    14. Bundle.entry:DocumentManifest.request.method
    Fixed ValuePOST
    16. Bundle.entry:DocumentReference
    Slice NameDocumentReference
    ShortDocumentReference
    Control1..?
    18. Bundle.entry:DocumentReference.fullUrl
    Control1..?
    20. Bundle.entry:DocumentReference.resource
    Control1..?
    TypeDocumentReference(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3.)
    22. Bundle.entry:DocumentReference.request
    Control1..?
    24. Bundle.entry:DocumentReference.request.method
    Fixed ValuePOST
    26. Bundle.entry:List
    Slice NameList
    ShortList
    28. Bundle.entry:List.fullUrl
    Control1..?
    30. Bundle.entry:List.resource
    Control1..?
    TypeList(Nictiz IHE MHD Profile on List (Folder))
    32. Bundle.entry:List.request
    Control1..?
    34. Bundle.entry:List.request.method
    Fixed ValuePOST
    36. Bundle.entry:Binary
    Slice NameBinary
    Definition

    Entry for the actual document in a Binary resource.

    ShortBinary
    38. Bundle.entry:Binary.fullUrl
    Control1..?
    40. Bundle.entry:Binary.resource
    Control1..?
    TypeBinary(Binary)
    42. Bundle.entry:Binary.request
    Control1..?
    44. Bundle.entry:Binary.request.method
    Fixed ValuePOST

    Guidance on how to interpret the contents of this table can be found here

    0. Bundle
    Definition

    A container for a collection of resources.

    ShortContains a collection of resources
    Control0..*
    Invariantsbdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct())
    bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
    bdl-3: entry.request only for some types of bundles (entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history')
    bdl-4: entry.response only for some types of bundles (entry.response.empty() or type = 'batch-response' or type = 'transaction-response')
    bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
    bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
    bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct())
    bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
    bdl-3: entry.request only for some types of bundles (entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history')
    bdl-4: entry.response only for some types of bundles (entry.response.empty() or type = 'batch-response' or type = 'transaction-response')
    bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
    bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
    2. Bundle.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

    ShortA set of rules under which this content was created
    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.

    This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

    Control0..1
    Typeuri
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    4. Bundle.type
    Definition

    Indicates the purpose of this bundle - how it was intended to be used.

    Shorttransactiondocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Comments

    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.

    Control1..1
    BindingThe codes SHALL be taken from BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type
    (required to http://hl7.org/fhir/ValueSet/bundle-type)

    Indicates the purpose of a bundle - how it was intended to be used.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Fixed Valuetransaction
    6. Bundle.entry
    Definition

    An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

    ShortEntry in the bundle - will have a resource, or information
    Control0..*
    TypeBackboneElement
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
    bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
    bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    SlicingThis element introduces a set of slices on Bundle.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • type @ resource
    • 8. Bundle.entry.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      10. Bundle.entry:DocumentManifest
      Slice NameDocumentManifest
      Definition

      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

      ShortDocumentManifestEntry in the bundle - will have a resource, or information
      Control10..1*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      12. Bundle.entry:DocumentManifest.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      14. Bundle.entry:DocumentManifest.fullUrl
      Definition

      The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

      ShortAbsolute URL for resource (server address, or UUID/OID)
      Comments

      fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

      Control10..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      16. Bundle.entry:DocumentManifest.resource
      Definition

      A collection of documents compiled for a purpose together with metadata that applies to the collection.


      The Resources for the entry.

      ShortA list that defines a set of documentsA resource in the bundle
      Comments

      Nictiz: replaced profile reference to corrected IHE MHD DocumentManifest profile.

      Control10..1
      TypeDocumentManifestResource(Nictiz IHE MHD Profile on DocumentManifest (SubmissionSet))
      18. Bundle.entry:DocumentManifest.request
      Definition

      Additional information about how this entry should be processed as part of a transaction.

      ShortTransaction Related Information
      Control10..1
      This element is affected by the following invariants: bdl-3
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      20. Bundle.entry:DocumentManifest.request.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      22. Bundle.entry:DocumentManifest.request.method
      Definition

      The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

      ShortGET | POST | PUT | DELETE
      Control1..1
      BindingThe codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb
      (required to http://hl7.org/fhir/ValueSet/http-verb)

      HTTP verbs (in the HTTP command line).

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed ValuePOST
      24. Bundle.entry:DocumentManifest.request.url
      Definition

      The URL for this entry, relative to the root (the address to which the request is posted).

      ShortURL for HTTP equivalent of this entry
      Comments

      E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      26. Bundle.entry:DocumentReference
      Slice NameDocumentReference
      Definition

      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

      ShortDocumentReferenceEntry in the bundle - will have a resource, or information
      Control10..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      28. Bundle.entry:DocumentReference.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      30. Bundle.entry:DocumentReference.fullUrl
      Definition

      The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

      ShortAbsolute URL for resource (server address, or UUID/OID)
      Comments

      fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

      Control10..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      32. Bundle.entry:DocumentReference.resource
      Definition

      A reference to a document.


      The Resources for the entry.

      ShortA reference to a documentA resource in the bundle
      Comments

      Usually, this is used for documents other than those defined by FHIR.

      Control10..1
      TypeDocumentReferenceResource(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3.)
      34. Bundle.entry:DocumentReference.request
      Definition

      Additional information about how this entry should be processed as part of a transaction.

      ShortTransaction Related Information
      Control10..1
      This element is affected by the following invariants: bdl-3
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      36. Bundle.entry:DocumentReference.request.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      38. Bundle.entry:DocumentReference.request.method
      Definition

      The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

      ShortGET | POST | PUT | DELETE
      Control1..1
      BindingThe codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb
      (required to http://hl7.org/fhir/ValueSet/http-verb)

      HTTP verbs (in the HTTP command line).

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed ValuePOST
      40. Bundle.entry:DocumentReference.request.url
      Definition

      The URL for this entry, relative to the root (the address to which the request is posted).

      ShortURL for HTTP equivalent of this entry
      Comments

      E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      42. Bundle.entry:List
      Slice NameList
      Definition

      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

      ShortListEntry in the bundle - will have a resource, or information
      Control0..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      44. Bundle.entry:List.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      46. Bundle.entry:List.fullUrl
      Definition

      The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

      ShortAbsolute URL for resource (server address, or UUID/OID)
      Comments

      fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

      Control10..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      48. Bundle.entry:List.resource
      Definition

      A set of information summarized from a list of other resources.


      The Resources for the entry.

      ShortInformation summarized from a list of other resourcesA resource in the bundle
      Control10..1
      TypeListResource(Nictiz IHE MHD Profile on List (Folder))
      Alternate NamesCollection, WorkingList, Organizer
      50. Bundle.entry:List.request
      Definition

      Additional information about how this entry should be processed as part of a transaction.

      ShortTransaction Related Information
      Control10..1
      This element is affected by the following invariants: bdl-3
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      52. Bundle.entry:List.request.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      54. Bundle.entry:List.request.method
      Definition

      The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

      ShortGET | POST | PUT | DELETE
      Control1..1
      BindingThe codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb
      (required to http://hl7.org/fhir/ValueSet/http-verb)

      HTTP verbs (in the HTTP command line).

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed ValuePOST
      56. Bundle.entry:List.request.url
      Definition

      The URL for this entry, relative to the root (the address to which the request is posted).

      ShortURL for HTTP equivalent of this entry
      Comments

      E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      58. Bundle.entry:Binary
      Slice NameBinary
      Definition

      Entry for the actual document in a Binary resource.


      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

      ShortBinaryEntry in the bundle - will have a resource, or information
      Control0..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      60. Bundle.entry:Binary.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      62. Bundle.entry:Binary.fullUrl
      Definition

      The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

      ShortAbsolute URL for resource (server address, or UUID/OID)
      Comments

      fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

      Control10..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      64. Bundle.entry:Binary.resource
      Definition

      A binary resource can contain any content, whether text, image, pdf, zip archive, etc.


      The Resources for the entry.

      ShortPure binary content defined by a format other than FHIRA resource in the bundle
      Comments

      Typically, Binary resources are used for handling content such as: * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).

      Control10..1
      TypeBinaryResource(Binary)
      66. Bundle.entry:Binary.request
      Definition

      Additional information about how this entry should be processed as part of a transaction.

      ShortTransaction Related Information
      Control10..1
      This element is affected by the following invariants: bdl-3
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      68. Bundle.entry:Binary.request.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      70. Bundle.entry:Binary.request.method
      Definition

      The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

      ShortGET | POST | PUT | DELETE
      Control1..1
      BindingThe codes SHALL be taken from HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb
      (required to http://hl7.org/fhir/ValueSet/http-verb)

      HTTP verbs (in the HTTP command line).

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed ValuePOST
      72. Bundle.entry:Binary.request.url
      Definition

      The URL for this entry, relative to the root (the address to which the request is posted).

      ShortURL for HTTP equivalent of this entry
      Comments

      E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue

      Guidance on how to interpret the contents of this table can be found here

      0. Bundle
      Definition

      A container for a collection of resources.

      ShortContains a collection of resources
      Control0..*
      Invariantsbdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct())
      bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
      bdl-3: entry.request only for some types of bundles (entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history')
      bdl-4: entry.response only for some types of bundles (entry.response.empty() or type = 'batch-response' or type = 'transaction-response')
      bdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
      bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
      2. Bundle.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      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.

      Control0..1
      Typeid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      4. Bundle.meta
      Definition

      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.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Summarytrue
      6. Bundle.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

      ShortA set of rules under which this content was created
      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.

      This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

      Control0..1
      Typeuri
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      8. Bundle.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      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).

      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from Common Languages
      (extensible to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. Bundle.identifier
      Definition

      A persistent identifier for the batch that won't change as a batch is copied from server to server.

      ShortPersistent identifier for the bundle
      Comments

      Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results, and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier
      Summarytrue
      12. Bundle.type
      Definition

      Indicates the purpose of this bundle - how it was intended to be used.

      Shorttransaction
      Comments

      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.

      Control1..1
      BindingThe codes SHALL be taken from BundleType
      (required to http://hl7.org/fhir/ValueSet/bundle-type)

      Indicates the purpose of a bundle - how it was intended to be used.

      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Fixed Valuetransaction
      14. Bundle.total
      Definition

      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).

      ShortIf search, the total number of matches
      Comments

      Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

      Control0..1
      This element is affected by the following invariants: bdl-1
      TypeunsignedInt
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      16. Bundle.link
      Definition

      A series of links that provide context to this bundle.

      ShortLinks related to this Bundle
      Control0..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      18. Bundle.link.id
      Definition

      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      20. Bundle.link.extension
      Definition

      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.

      ShortAdditional Content defined by implementations
      Comments

      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.

      Control0..*
      TypeExtension
      Alternate Namesextensions, user content
      22. Bundle.link.modifierExtension
      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 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.

      ShortExtensions that cannot be ignored
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Summarytrue
      Alternate Namesextensions, user content, modifiers
      24. Bundle.link.relation
      Definition

      A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

      ShortSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      26. Bundle.link.url
      Definition

      The reference details for the link.

      ShortReference details for the link
      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      28. Bundle.entry
      Definition

      An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

      ShortEntry in the bundle - will have a resource, or information
      Control0..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
      bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
      SlicingThis element introduces a set of slices on Bundle.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • type @ resource
      • 30. Bundle.entry.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        32. Bundle.entry.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        34. Bundle.entry.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        36. Bundle.entry.link
        Definition

        A series of links that provide context to this entry.

        ShortLinks related to this entry
        Control0..*
        TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
        Summarytrue
        38. Bundle.entry.fullUrl
        Definition

        The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

        ShortAbsolute URL for resource (server address, or UUID/OID)
        Comments

        fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        40. Bundle.entry.resource
        Definition

        The Resources for the entry.

        ShortA resource in the bundle
        Control0..1
        TypeResource
        Summarytrue
        42. Bundle.entry.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..1
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        44. Bundle.entry.search.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        46. Bundle.entry.search.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        48. Bundle.entry.search.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        50. Bundle.entry.search.mode
        Definition

        Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

        Shortmatch | include | outcome - why this is in the result set
        Comments

        There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

        Control0..1
        BindingThe codes SHALL be taken from SearchEntryMode
        (required to http://hl7.org/fhir/ValueSet/search-entry-mode)

        Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        52. Bundle.entry.search.score
        Definition

        When searching, the server's search ranking score for the entry.

        ShortSearch ranking (between 0 and 1)
        Comments

        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.

        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        54. Bundle.entry.request
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        56. Bundle.entry.request.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        58. Bundle.entry.request.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        60. Bundle.entry.request.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        62. Bundle.entry.request.method
        Definition

        The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

        ShortGET | POST | PUT | DELETE
        Control1..1
        BindingThe codes SHALL be taken from HTTPVerb
        (required to http://hl7.org/fhir/ValueSet/http-verb)

        HTTP verbs (in the HTTP command line).

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        64. Bundle.entry.request.url
        Definition

        The URL for this entry, relative to the root (the address to which the request is posted).

        ShortURL for HTTP equivalent of this entry
        Comments

        E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        66. Bundle.entry.request.ifNoneMatch
        Definition

        If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

        ShortFor managing cache currency
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        68. Bundle.entry.request.ifModifiedSince
        Definition

        Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

        ShortFor managing update contention
        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        70. Bundle.entry.request.ifMatch
        Definition

        Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

        ShortFor managing update contention
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        72. Bundle.entry.request.ifNoneExist
        Definition

        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

        ShortFor conditional creates
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        74. Bundle.entry.response
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        76. Bundle.entry.response.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        78. Bundle.entry.response.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        80. Bundle.entry.response.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        82. Bundle.entry.response.status
        Definition

        The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

        ShortStatus response code (text optional)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        84. Bundle.entry.response.location
        Definition

        The location header created by processing this operation.

        ShortThe location, if the operation returns a location
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        86. Bundle.entry.response.etag
        Definition

        The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

        ShortThe etag for the resource (if relevant)
        Comments

        Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        88. Bundle.entry.response.lastModified
        Definition

        The date/time that the resource was modified on the server.

        ShortServer's date time modified
        Comments

        This has to match the same time in the meta header if a resource is included.

        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        90. Bundle.entry.response.outcome
        Definition

        An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

        ShortOperationOutcome with hints and warnings (for batch/transaction)
        Comments

        For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

        Control0..1
        TypeResource
        Summarytrue
        92. Bundle.entry:DocumentManifest
        Slice NameDocumentManifest
        Definition

        An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

        ShortDocumentManifest
        Control1..1
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
        bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        94. Bundle.entry:DocumentManifest.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        96. Bundle.entry:DocumentManifest.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        98. Bundle.entry:DocumentManifest.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        100. Bundle.entry:DocumentManifest.link
        Definition

        A series of links that provide context to this entry.

        ShortLinks related to this entry
        Control0..*
        TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
        Summarytrue
        102. Bundle.entry:DocumentManifest.fullUrl
        Definition

        The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

        ShortAbsolute URL for resource (server address, or UUID/OID)
        Comments

        fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        104. Bundle.entry:DocumentManifest.resource
        Definition

        A collection of documents compiled for a purpose together with metadata that applies to the collection.

        ShortA list that defines a set of documents
        Comments

        Nictiz: replaced profile reference to corrected IHE MHD DocumentManifest profile.

        Control1..1
        TypeDocumentManifest(Nictiz IHE MHD Profile on DocumentManifest (SubmissionSet))
        106. Bundle.entry:DocumentManifest.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..1
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        108. Bundle.entry:DocumentManifest.search.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        110. Bundle.entry:DocumentManifest.search.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        112. Bundle.entry:DocumentManifest.search.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        114. Bundle.entry:DocumentManifest.search.mode
        Definition

        Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

        Shortmatch | include | outcome - why this is in the result set
        Comments

        There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

        Control0..1
        BindingThe codes SHALL be taken from SearchEntryMode
        (required to http://hl7.org/fhir/ValueSet/search-entry-mode)

        Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        116. Bundle.entry:DocumentManifest.search.score
        Definition

        When searching, the server's search ranking score for the entry.

        ShortSearch ranking (between 0 and 1)
        Comments

        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.

        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        118. Bundle.entry:DocumentManifest.request
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control1..1
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        120. Bundle.entry:DocumentManifest.request.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        122. Bundle.entry:DocumentManifest.request.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        124. Bundle.entry:DocumentManifest.request.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        126. Bundle.entry:DocumentManifest.request.method
        Definition

        The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

        ShortGET | POST | PUT | DELETE
        Control1..1
        BindingThe codes SHALL be taken from HTTPVerb
        (required to http://hl7.org/fhir/ValueSet/http-verb)

        HTTP verbs (in the HTTP command line).

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValuePOST
        128. Bundle.entry:DocumentManifest.request.url
        Definition

        The URL for this entry, relative to the root (the address to which the request is posted).

        ShortURL for HTTP equivalent of this entry
        Comments

        E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        130. Bundle.entry:DocumentManifest.request.ifNoneMatch
        Definition

        If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

        ShortFor managing cache currency
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        132. Bundle.entry:DocumentManifest.request.ifModifiedSince
        Definition

        Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

        ShortFor managing update contention
        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        134. Bundle.entry:DocumentManifest.request.ifMatch
        Definition

        Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

        ShortFor managing update contention
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        136. Bundle.entry:DocumentManifest.request.ifNoneExist
        Definition

        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

        ShortFor conditional creates
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        138. Bundle.entry:DocumentManifest.response
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        140. Bundle.entry:DocumentManifest.response.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        142. Bundle.entry:DocumentManifest.response.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        144. Bundle.entry:DocumentManifest.response.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        146. Bundle.entry:DocumentManifest.response.status
        Definition

        The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

        ShortStatus response code (text optional)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        148. Bundle.entry:DocumentManifest.response.location
        Definition

        The location header created by processing this operation.

        ShortThe location, if the operation returns a location
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        150. Bundle.entry:DocumentManifest.response.etag
        Definition

        The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

        ShortThe etag for the resource (if relevant)
        Comments

        Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        152. Bundle.entry:DocumentManifest.response.lastModified
        Definition

        The date/time that the resource was modified on the server.

        ShortServer's date time modified
        Comments

        This has to match the same time in the meta header if a resource is included.

        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        154. Bundle.entry:DocumentManifest.response.outcome
        Definition

        An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

        ShortOperationOutcome with hints and warnings (for batch/transaction)
        Comments

        For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

        Control0..1
        TypeResource
        Summarytrue
        156. Bundle.entry:DocumentReference
        Slice NameDocumentReference
        Definition

        An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

        ShortDocumentReference
        Control1..*
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
        bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        158. Bundle.entry:DocumentReference.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        160. Bundle.entry:DocumentReference.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        162. Bundle.entry:DocumentReference.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        164. Bundle.entry:DocumentReference.link
        Definition

        A series of links that provide context to this entry.

        ShortLinks related to this entry
        Control0..*
        TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
        Summarytrue
        166. Bundle.entry:DocumentReference.fullUrl
        Definition

        The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

        ShortAbsolute URL for resource (server address, or UUID/OID)
        Comments

        fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        168. Bundle.entry:DocumentReference.resource
        Definition

        A reference to a document.

        ShortA reference to a document
        Comments

        Usually, this is used for documents other than those defined by FHIR.

        Control1..1
        TypeDocumentReference(Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3.)
        170. Bundle.entry:DocumentReference.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..1
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        172. Bundle.entry:DocumentReference.search.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        174. Bundle.entry:DocumentReference.search.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        176. Bundle.entry:DocumentReference.search.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        178. Bundle.entry:DocumentReference.search.mode
        Definition

        Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

        Shortmatch | include | outcome - why this is in the result set
        Comments

        There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

        Control0..1
        BindingThe codes SHALL be taken from SearchEntryMode
        (required to http://hl7.org/fhir/ValueSet/search-entry-mode)

        Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        180. Bundle.entry:DocumentReference.search.score
        Definition

        When searching, the server's search ranking score for the entry.

        ShortSearch ranking (between 0 and 1)
        Comments

        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.

        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        182. Bundle.entry:DocumentReference.request
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control1..1
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        184. Bundle.entry:DocumentReference.request.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        186. Bundle.entry:DocumentReference.request.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        188. Bundle.entry:DocumentReference.request.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        190. Bundle.entry:DocumentReference.request.method
        Definition

        The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

        ShortGET | POST | PUT | DELETE
        Control1..1
        BindingThe codes SHALL be taken from HTTPVerb
        (required to http://hl7.org/fhir/ValueSet/http-verb)

        HTTP verbs (in the HTTP command line).

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValuePOST
        192. Bundle.entry:DocumentReference.request.url
        Definition

        The URL for this entry, relative to the root (the address to which the request is posted).

        ShortURL for HTTP equivalent of this entry
        Comments

        E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        194. Bundle.entry:DocumentReference.request.ifNoneMatch
        Definition

        If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

        ShortFor managing cache currency
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        196. Bundle.entry:DocumentReference.request.ifModifiedSince
        Definition

        Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

        ShortFor managing update contention
        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        198. Bundle.entry:DocumentReference.request.ifMatch
        Definition

        Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

        ShortFor managing update contention
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        200. Bundle.entry:DocumentReference.request.ifNoneExist
        Definition

        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

        ShortFor conditional creates
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        202. Bundle.entry:DocumentReference.response
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        204. Bundle.entry:DocumentReference.response.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        206. Bundle.entry:DocumentReference.response.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        208. Bundle.entry:DocumentReference.response.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        210. Bundle.entry:DocumentReference.response.status
        Definition

        The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

        ShortStatus response code (text optional)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        212. Bundle.entry:DocumentReference.response.location
        Definition

        The location header created by processing this operation.

        ShortThe location, if the operation returns a location
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        214. Bundle.entry:DocumentReference.response.etag
        Definition

        The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

        ShortThe etag for the resource (if relevant)
        Comments

        Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        216. Bundle.entry:DocumentReference.response.lastModified
        Definition

        The date/time that the resource was modified on the server.

        ShortServer's date time modified
        Comments

        This has to match the same time in the meta header if a resource is included.

        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        218. Bundle.entry:DocumentReference.response.outcome
        Definition

        An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

        ShortOperationOutcome with hints and warnings (for batch/transaction)
        Comments

        For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

        Control0..1
        TypeResource
        Summarytrue
        220. Bundle.entry:List
        Slice NameList
        Definition

        An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).

        ShortList
        Control0..*
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
        bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        222. Bundle.entry:List.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        224. Bundle.entry:List.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        226. Bundle.entry:List.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        228. Bundle.entry:List.link
        Definition

        A series of links that provide context to this entry.

        ShortLinks related to this entry
        Control0..*
        TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
        Summarytrue
        230. Bundle.entry:List.fullUrl
        Definition

        The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

        ShortAbsolute URL for resource (server address, or UUID/OID)
        Comments

        fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        232. Bundle.entry:List.resource
        Definition

        A set of information summarized from a list of other resources.

        ShortInformation summarized from a list of other resources
        Control1..1
        TypeList(Nictiz IHE MHD Profile on List (Folder))
        Alternate NamesCollection, WorkingList, Organizer
        234. Bundle.entry:List.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..1
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        236. Bundle.entry:List.search.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        238. Bundle.entry:List.search.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        240. Bundle.entry:List.search.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        242. Bundle.entry:List.search.mode
        Definition

        Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

        Shortmatch | include | outcome - why this is in the result set
        Comments

        There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

        Control0..1
        BindingThe codes SHALL be taken from SearchEntryMode
        (required to http://hl7.org/fhir/ValueSet/search-entry-mode)

        Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        244. Bundle.entry:List.search.score
        Definition

        When searching, the server's search ranking score for the entry.

        ShortSearch ranking (between 0 and 1)
        Comments

        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.

        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        246. Bundle.entry:List.request
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control1..1
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        248. Bundle.entry:List.request.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        250. Bundle.entry:List.request.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        252. Bundle.entry:List.request.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        254. Bundle.entry:List.request.method
        Definition

        The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

        ShortGET | POST | PUT | DELETE
        Control1..1
        BindingThe codes SHALL be taken from HTTPVerb
        (required to http://hl7.org/fhir/ValueSet/http-verb)

        HTTP verbs (in the HTTP command line).

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValuePOST
        256. Bundle.entry:List.request.url
        Definition

        The URL for this entry, relative to the root (the address to which the request is posted).

        ShortURL for HTTP equivalent of this entry
        Comments

        E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        258. Bundle.entry:List.request.ifNoneMatch
        Definition

        If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

        ShortFor managing cache currency
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        260. Bundle.entry:List.request.ifModifiedSince
        Definition

        Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

        ShortFor managing update contention
        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        262. Bundle.entry:List.request.ifMatch
        Definition

        Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

        ShortFor managing update contention
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        264. Bundle.entry:List.request.ifNoneExist
        Definition

        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

        ShortFor conditional creates
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        266. Bundle.entry:List.response
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        268. Bundle.entry:List.response.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        270. Bundle.entry:List.response.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        272. Bundle.entry:List.response.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        274. Bundle.entry:List.response.status
        Definition

        The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

        ShortStatus response code (text optional)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        276. Bundle.entry:List.response.location
        Definition

        The location header created by processing this operation.

        ShortThe location, if the operation returns a location
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        278. Bundle.entry:List.response.etag
        Definition

        The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

        ShortThe etag for the resource (if relevant)
        Comments

        Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        280. Bundle.entry:List.response.lastModified
        Definition

        The date/time that the resource was modified on the server.

        ShortServer's date time modified
        Comments

        This has to match the same time in the meta header if a resource is included.

        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        282. Bundle.entry:List.response.outcome
        Definition

        An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

        ShortOperationOutcome with hints and warnings (for batch/transaction)
        Comments

        For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

        Control0..1
        TypeResource
        Summarytrue
        284. Bundle.entry:Binary
        Slice NameBinary
        Definition

        Entry for the actual document in a Binary resource.

        ShortBinary
        Control0..*
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.contains('/_history/').not())
        bdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        286. Bundle.entry:Binary.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        288. Bundle.entry:Binary.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        290. Bundle.entry:Binary.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        292. Bundle.entry:Binary.link
        Definition

        A series of links that provide context to this entry.

        ShortLinks related to this entry
        Control0..*
        TypeSee ttp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
        Summarytrue
        294. Bundle.entry:Binary.fullUrl
        Definition

        The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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.

        ShortAbsolute URL for resource (server address, or UUID/OID)
        Comments

        fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id.

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        296. Bundle.entry:Binary.resource
        Definition

        A binary resource can contain any content, whether text, image, pdf, zip archive, etc.

        ShortPure binary content defined by a format other than FHIR
        Comments

        Typically, Binary resources are used for handling content such as: * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).

        Control1..1
        TypeBinary(Binary)
        298. Bundle.entry:Binary.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..1
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        300. Bundle.entry:Binary.search.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        302. Bundle.entry:Binary.search.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        304. Bundle.entry:Binary.search.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        306. Bundle.entry:Binary.search.mode
        Definition

        Why this entry is in the result set - whether it's included as a match or because of an _include requirement.

        Shortmatch | include | outcome - why this is in the result set
        Comments

        There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.

        Control0..1
        BindingThe codes SHALL be taken from SearchEntryMode
        (required to http://hl7.org/fhir/ValueSet/search-entry-mode)

        Why an entry is in the result set - whether it's included as a match or because of an _include requirement.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        308. Bundle.entry:Binary.search.score
        Definition

        When searching, the server's search ranking score for the entry.

        ShortSearch ranking (between 0 and 1)
        Comments

        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.

        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        310. Bundle.entry:Binary.request
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control1..1
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        312. Bundle.entry:Binary.request.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        314. Bundle.entry:Binary.request.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        316. Bundle.entry:Binary.request.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        318. Bundle.entry:Binary.request.method
        Definition

        The HTTP verb for this entry in either a change history, or a transaction/ transaction response.

        ShortGET | POST | PUT | DELETE
        Control1..1
        BindingThe codes SHALL be taken from HTTPVerb
        (required to http://hl7.org/fhir/ValueSet/http-verb)

        HTTP verbs (in the HTTP command line).

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Fixed ValuePOST
        320. Bundle.entry:Binary.request.url
        Definition

        The URL for this entry, relative to the root (the address to which the request is posted).

        ShortURL for HTTP equivalent of this entry
        Comments

        E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]".

        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        322. Bundle.entry:Binary.request.ifNoneMatch
        Definition

        If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

        ShortFor managing cache currency
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        324. Bundle.entry:Binary.request.ifModifiedSince
        Definition

        Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

        ShortFor managing update contention
        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        326. Bundle.entry:Binary.request.ifMatch
        Definition

        Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

        ShortFor managing update contention
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        328. Bundle.entry:Binary.request.ifNoneExist
        Definition

        Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

        ShortFor conditional creates
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        330. Bundle.entry:Binary.response
        Definition

        Additional information about how this entry should be processed as part of a transaction.

        ShortTransaction Related Information
        Control0..1
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        332. Bundle.entry:Binary.response.id
        Definition

        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        334. Bundle.entry:Binary.response.extension
        Definition

        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.

        ShortAdditional Content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        336. Bundle.entry:Binary.response.modifierExtension
        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 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.

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Summarytrue
        Alternate Namesextensions, user content, modifiers
        338. Bundle.entry:Binary.response.status
        Definition

        The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

        ShortStatus response code (text optional)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        340. Bundle.entry:Binary.response.location
        Definition

        The location header created by processing this operation.

        ShortThe location, if the operation returns a location
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        342. Bundle.entry:Binary.response.etag
        Definition

        The etag for the resource, it the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

        ShortThe etag for the resource (if relevant)
        Comments

        Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        344. Bundle.entry:Binary.response.lastModified
        Definition

        The date/time that the resource was modified on the server.

        ShortServer's date time modified
        Comments

        This has to match the same time in the meta header if a resource is included.

        Control0..1
        Typeinstant
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        346. Bundle.entry:Binary.response.outcome
        Definition

        An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

        ShortOperationOutcome with hints and warnings (for batch/transaction)
        Comments

        For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

        Control0..1
        TypeResource
        Summarytrue
        348. Bundle.signature
        Definition

        Digital Signature - base64 encoded. XML-DSIg or a JWT.

        ShortDigital Signature
        Comments

        The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

        Control0..1
        TypeSignature
        Summarytrue
        Requirements

        This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.