at-messaging-bundle
type: StructureDefinition
node role: treeRoot
id:
  v: at-messaging-bundle
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition at-messaging-bundle Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Bundle 0..* Bundle Contains a collection of resources #xD; id 1..1 id Logical id of this artifact #xD; type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Required Pattern: message #xD; timestamp 1..1 instant When the bundle was assembled #xD; entry #xD; fullUrl C 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) Constraints: uuid-only #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://fhir.hl7.at/fhir/ATMessaging/0.1.0/StructureDefinition/at-messaging-bundle
  l: at-messaging-bundle
version:
  v: 0.1.0
name:
  v: ATMessagingBundle
title:
  v: AT Messaging Message Bundle
status:
  v: draft
date:
  v: 2026-02-02T14:50:43+00:00
publisher:
  v: HL7® Austria, TC FHIR®
contact:
  name:
    v: HL7® Austria, TC FHIR®
  telecom:
    system:
      v: url
    value:
      v: https://hl7.at/technische-komitees/tc-fhir/
  telecom:
    system:
      v: email
contact:
  name:
    v: Technical Committee for FHIR® at HL7® Austria
  telecom:
    system:
      v: email
description:
  v: MessageBundle to be used for all messages transfered with the AT FHIR messaging.
use context:
  code:
    system:
      v: http://terminology.hl7.org/CodeSystem/usage-context-type
      l: usage-context-type
    version:
      v: 2.0.1
    code:
      v: jurisdiction
  value: CodeableConcept
    coding:
      system:
        v: urn:iso:std:iso:3166
        l: 3166
      code:
        v: AT
      display:
        v: Austria
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 V2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: cda
  uri:
    v: http://hl7.org/v3/cda
    l: cda
  name:
    v: CDA (R2)
kind:
  v: resource
abstract:
  v: false
type:
  v: Bundle
  l: Bundle
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 5.0.0
  element:
    id:
      v: Bundle
    path:
      v: Bundle
    short:
      v: Contains a collection of resources
    definition:
      v: A container for a collection of resources.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Bundle
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: bdl-1
      severity:
        v: error
      human:
        v: total only when a search or history
      expression:
        v: total.empty() or (type = 'searchset') or (type = 'history')
      source:
        v: http://hl7.org/fhir/StructureDefinition/Bundle
        l: Bundle
    constraint:
      key:
        v: bdl-2
      severity:
        v: error
      human:
        v: entry.search only when a search
      expression:
        v: (type = 'searchset') or entry.search.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/Bundle
        l: Bundle
    constraint:
      key:
        v: bdl-7
      severity:
        v: error
      human:
        v: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
      expression:
        v: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
      source:
        v: http://hl7.org/fhir/StructureDefinition/Bundle
        l: Bundle
    constraint:
      key:
        v: bdl-9
      severity:
        v: error
      human:
        v: A document must have an identifier with a system and a value
      expression:
        v: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
      source:
        v: http://hl7.org/fhir/StructureDefinition/Bundle
        l: Bundle
    constraint:
      key:
        v: bdl-10
      severity:
        v: error
      human:
        v: A document must have a date
      expression:
        v: type = 'document' implies (timestamp.hasValue())
      source:
        v: http://hl7.org/fhir/StructureDefinition/Bundle
        l: Bundle
    constraint:
      key:
        v: bdl-11
      severity:
        v: error
      human:
        v: A document must have a Composition as the first resource
      expression:
        v: type = 'document' implies entry.first().resource.is(Composition)

key:
  v: bdl-12
severity:
  v: error
human:
  v: A message must have a MessageHeader as the first resource
expression:
  v: type = 'message' implies entry.first().resource.is(MessageHeader)
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-13
severity:
  v: error
human:
  v: A subscription-notification must have a SubscriptionStatus as the first resource
expression:
  v: type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-14
severity:
  v: error
human:
  v: entry.request.method PATCH not allowed for history
expression:
  v: type = 'history' implies entry.request.method != 'PATCH'
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-15
severity:
  v: error
human:
  v: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
expression:
  v: type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-16
severity:
  v: error
human:
  v: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
expression:
  v: issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-17
severity:
  v: error
human:
  v: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
expression:
  v: type = 'document' implies issues.empty()
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-18
severity:
  v: error
human:
  v: Self link is required for searchsets.
expression:
  v: type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-3a
severity:
  v: error
human:
  v: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
expression:
  v: type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-3b
severity:
  v: error
human:
  v: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
expression:
  v: type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-3c
severity:
  v: error
human:
  v: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
expression:
  v: type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

key:
  v: bdl-3d
severity:
  v: error
human:
  v: For collections of type transaction-response or batch-response, all entries must contain response elements
expression:
  v: type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
source:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  l: Bundle

v: false

v: false

v: false

identity:
  v: rim
map:
  v: Entity. Role, or Act,N/A

identity:
  v: w5
map:
  v: infrastructure.structure

identity:
  v: v2
map:
  v: N/A

identity:
  v: cda
map:
  v: ClinicalDocument, if bundle.type = document

id:
  v: Bundle.id
path:
  v: Bundle.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.meta
path:
  v: Bundle.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.implicitRules
path:
  v: Bundle.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
is summary:
  v: true

id:
  v: Bundle.language
path:
  v: Bundle.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|5.0.0
    l: http://hl7.org/fhir/ValueSet/all-languages
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages|5.0.0
      l: http://hl7.org/fhir/ValueSet/languages

id:
  v: Bundle.identifier
path:
  v: Bundle.identifier
short:
  v: Persistent identifier for the bundle
definition:
  v: A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
condition:
  v: bdl-9
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: cda
  map:
    v: ClinicalDocument.id

id:
  v: Bundle.type
path:
  v: Bundle.type
short:
  v: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
definition:
  v: Indicates the purpose of this bundle - how it is intended to be used.
comment:
  v: It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
pattern: Code
  v: message
condition:
  v: bdl-1
condition:
  v: bdl-2
condition:
  v: bdl-3a
condition:
  v: bdl-3b
condition:
  v: bdl-3c
condition:
  v: bdl-3d
condition:
  v: bdl-7
condition:
  v: bdl-9
condition:
  v: bdl-10
condition:
  v: bdl-11
condition:
  v: bdl-12
condition:
  v: bdl-13
condition:
  v: bdl-14
condition:
  v: bdl-15
condition:
  v: bdl-17
condition:
  v: bdl-18
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: BundleType
  strength:
    v: required
  description:
    v: Indicates the purpose of a bundle - how it is intended to be used.
  value set:
    v: http://hl7.org/fhir/ValueSet/bundle-type|5.0.0
    l: http://hl7.org/fhir/ValueSet/bundle-type
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class

id:
  v: Bundle.timestamp
path:
  v: Bundle.timestamp
short:
  v: When the bundle was assembled
definition:
  v: The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
comment:
  v: For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage: * document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time * message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message * history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates * searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query * transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.timestamp
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
    l: instant
condition:
  v: bdl-10
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.init
mapping:
  identity:
    v: cda
  map:
    v: ClinicalDocument.effectiveTime

id:
  v: Bundle.total
path:
  v: Bundle.total
short:
  v: If search, the total number of matches
definition:
  v: If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.total
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: unsignedInt
    l: unsignedInt
condition:
  v: bdl-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.link
path:
  v: Bundle.link
short:
  v: Links related to this Bundle
definition:
  v: A series of links that provide context to this bundle.
comment:
  v: Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R5/http.html#read) directly. This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R5/search.html#conformance) and [paging](http://hl7.org/fhir/R5/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Bundle.link
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
condition:
  v: bdl-18
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.link.id
path:
  v: Bundle.link.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.link.extension
path:
  v: Bundle.link.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.link.modifierExtension
path:
  v: Bundle.link.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Bundle.link.relation
path:
  v: Bundle.link.relation
short:
  v: See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
definition:
  v: A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.link.relation
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
condition:
  v: bdl-18
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0
    l: http://hl7.org/fhir/ValueSet/iana-link-relations

id:
  v: Bundle.link.url
path:
  v: Bundle.link.url
short:
  v: Reference details for the link
definition:
  v: The reference details for the link.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.link.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: bdl-18
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry
path:
  v: Bundle.entry
short:
  v: Entry in the bundle - will have a resource or information
definition:
  v: An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Bundle.entry
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
order meaning:
  v: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
constraint:
  key:
    v: bdl-5
  severity:
    v: error
  human:
    v: must be a resource unless there's a request or response
  expression:
    v: resource.exists() or request.exists() or response.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Bundle
    l: Bundle
constraint:
  key:
    v: bdl-8
  severity:
    v: error
  human:
    v: fullUrl cannot be a version specific reference
  expression:
    v: fullUrl.exists() implies fullUrl.contains('/_history/').not()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Bundle
    l: Bundle
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.id
path:
  v: Bundle.entry.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.extension
path:
  v: Bundle.entry.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.modifierExtension
path:
  v: Bundle.entry.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Bundle.entry.link
path:
  v: Bundle.entry.link
short:
  v: Links related to this entry
definition:
  v: A series of links that provide context to this entry.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Bundle.entry.link
  min:
    v: 0
  max:
    v: *
content reference:
  v: http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
  l: Bundle.link
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.fullUrl
path:
  v: Bundle.entry.fullUrl
short:
  v: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
definition:
  v: The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation.
comment:
  v: fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R5/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R5/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R5/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.entry.fullUrl
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
condition:
  v: bdl-7
condition:
  v: bdl-15
condition:
  v: bdl-8
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: uuid-only
  severity:
    v: error
  human:
    v: fullUrl must be a valid UUID
  expression:
    v: value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
  source:
    v: http://fhir.hl7.at/fhir/ATMessaging/0.1.0/StructureDefinition/at-messaging-bundle
    l: at-messaging-bundle
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.resource
path:
  v: Bundle.entry.resource
short:
  v: A resource in the bundle
definition:
  v: The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.resource
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Resource
    l: Resource
condition:
  v: bdl-3a
condition:
  v: bdl-3b
condition:
  v: bdl-3c
condition:
  v: bdl-7
condition:
  v: bdl-11
condition:
  v: bdl-12
condition:
  v: bdl-13
condition:
  v: bdl-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.search
path:
  v: Bundle.entry.search
short:
  v: Search related information
definition:
  v: Information about the search process that lead to the creation of this entry.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.search
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
condition:
  v: bdl-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.search.id
path:
  v: Bundle.entry.search.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.search.extension
path:
  v: Bundle.entry.search.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.search.modifierExtension
path:
  v: Bundle.entry.search.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Bundle.entry.search.mode
path:
  v: Bundle.entry.search.mode
short:
  v: match | include - why this is in the result set
definition:
  v: Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.search.mode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SearchEntryMode
  strength:
    v: required
  description:
    v: Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
  value set:
    v: http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
    l: http://hl7.org/fhir/ValueSet/search-entry-mode

id:
  v: Bundle.entry.search.score
path:
  v: Bundle.entry.search.score
short:
  v: Search ranking (between 0 and 1)
definition:
  v: When searching, the server's search ranking score for the entry.
comment:
  v: 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. See [Patient Match](http://hl7.org/fhir/R5/patient-operation-match.html) for the EMPI search which relates to this element.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.search.score
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: decimal
    l: decimal
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request
path:
  v: Bundle.entry.request
short:
  v: Additional execution information (transaction/batch/history)
definition:
  v: Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.request
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
condition:
  v: bdl-3a
condition:
  v: bdl-3b
condition:
  v: bdl-5
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request.id
path:
  v: Bundle.entry.request.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.request.extension
path:
  v: Bundle.entry.request.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.request.modifierExtension
path:
  v: Bundle.entry.request.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Bundle.entry.request.method
path:
  v: Bundle.entry.request.method
short:
  v: GET | HEAD | POST | PUT | DELETE | PATCH
definition:
  v: In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.method
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
condition:
  v: bdl-3b
condition:
  v: bdl-3c
condition:
  v: bdl-14
condition:
  v: bdl-15
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: HTTPVerb
  strength:
    v: required
  description:
    v: HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.
  value set:
    v: http://hl7.org/fhir/ValueSet/http-verb|5.0.0
    l: http://hl7.org/fhir/ValueSet/http-verb

id:
  v: Bundle.entry.request.url
path:
  v: Bundle.entry.request.url
short:
  v: URL for HTTP equivalent of this entry
definition:
  v: The URL for this entry, relative to the root (the address to which the request is posted).
comment:
  v: 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]".
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.url
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request.ifNoneMatch
path:
  v: Bundle.entry.request.ifNoneMatch
short:
  v: For managing cache validation
definition:
  v: If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.ifNoneMatch
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request.ifModifiedSince
path:
  v: Bundle.entry.request.ifModifiedSince
short:
  v: For managing cache currency
definition:
  v: Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R5/http.html#cread).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.ifModifiedSince
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
    l: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request.ifMatch
path:
  v: Bundle.entry.request.ifMatch
short:
  v: For managing update contention
definition:
  v: Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http://hl7.org/fhir/R5/http.html#concurrency).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.ifMatch
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.request.ifNoneExist
path:
  v: Bundle.entry.request.ifNoneExist
short:
  v: For conditional creates
definition:
  v: Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http://hl7.org/fhir/R5/http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.request.ifNoneExist
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response
path:
  v: Bundle.entry.response
short:
  v: Results of execution (transaction/batch/history)
definition:
  v: Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.response
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
condition:
  v: bdl-3a
condition:
  v: bdl-3b
condition:
  v: bdl-3d
condition:
  v: bdl-5
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response.id
path:
  v: Bundle.entry.response.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.response.extension
path:
  v: Bundle.entry.response.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Bundle.entry.response.modifierExtension
path:
  v: Bundle.entry.response.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: 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.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Bundle.entry.response.status
path:
  v: Bundle.entry.response.status
short:
  v: Status response code (text optional)
definition:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Bundle.entry.response.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response.location
path:
  v: Bundle.entry.response.location
short:
  v: The location (if the operation returns a location)
definition:
  v: The location header created by processing this operation, populated if the operation returns a location.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.response.location
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response.etag
path:
  v: Bundle.entry.response.etag
short:
  v: The Etag for the resource (if relevant)
definition:
  v: The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R5/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R5/http.html#concurrency)).
comment:
  v: Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.response.etag
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response.lastModified
path:
  v: Bundle.entry.response.lastModified
short:
  v: Server's date time modified
definition:
  v: The date/time that the resource was modified on the server.
comment:
  v: This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.response.lastModified
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
    l: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.entry.response.outcome
path:
  v: Bundle.entry.response.outcome
short:
  v: OperationOutcome with hints and warnings (for batch/transaction)
definition:
  v: An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
comment:
  v: 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. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.entry.response.outcome
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Resource
    l: Resource
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.signature
path:
  v: Bundle.signature
short:
  v: Digital Signature
definition:
  v: Digital Signature - base64 encoded. XML-DSig or a JWS.
comment:
  v: 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.
requirements:
  v: A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.signature
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Signature
    l: Signature
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Bundle.issues
path:
  v: Bundle.issues
short:
  v: Issues with the Bundle
definition:
  v: Captures issues and warnings that relate to the construction of the Bundle and the content within it.
comment:
  v: Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Bundle.issues
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Resource
    l: Resource
  profile:
    v: http://hl7.org/fhir/StructureDefinition/OperationOutcome|5.0.0
    l: http://hl7.org/fhir/StructureDefinition/OperationOutcome
condition:
  v: bdl-16
condition:
  v: bdl-17
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

element:
  id:
    v: Bundle
  path:
    v: Bundle
element:
  id:
    v: Bundle.id
  path:
    v: Bundle.id
  min:
    v: 1
element:
  id:
    v: Bundle.type
  path:
    v: Bundle.type
  pattern: Code
    v: message
element:
  id:
    v: Bundle.timestamp
  path:
    v: Bundle.timestamp
  min:
    v: 1
element:
  id:
    v: Bundle.entry.fullUrl
  path:
    v: Bundle.entry.fullUrl
  min:
    v: 1
  constraint:
    key:
      v: uuid-only
    severity:
      v: error
    human:
      v: fullUrl must be a valid UUID
    expression:
      v: value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$')
    source:
      v: http://fhir.hl7.at/fhir/ATMessaging/0.1.0/StructureDefinition/at-messaging-bundle
      l: at-messaging-bundle